Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite manpages in asciidoc #253

Open
ysbaddaden opened this issue Jan 11, 2019 · 5 comments
Open

Rewrite manpages in asciidoc #253

ysbaddaden opened this issue Jan 11, 2019 · 5 comments

Comments

@ysbaddaden
Copy link
Contributor

It would be nice to rewrite the manpages in asciidoc and to build them using the asciidoctor gem. It's nicer to write in, and that would allow to have different output formats (man, html, md, ...). Git does that and I really like it.

@straight-shoota
Copy link
Member

I've just manually transformed the man page to Markdown 😄 (crystal-lang/crystal-book#316).
Having a single source format would definitely help to keep these instances in sync.

@ZaWertun
Copy link

ZaWertun commented Feb 24, 2021

Calling asciidoctor with empty SOURCE_DATE_EPOCH env variable gives this error:

SOURCE_DATE_EPOCH= asciidoctor -a shards_version=0.14.0 docs/shards.adoc -b manpage -o man/shards.1
asciidoctor: FAILED: /home/zawertun/tmp/shards/docs/shards.adoc: Failed to load AsciiDoc document - invalid value for Integer(): ""
Use --trace for backtrace

(I'm building shards from the tar.gz archive, not from the git repo)

@straight-shoota
Copy link
Member

That makefile call is completely broken. Sorry, this was a really crappy copy and paste 😢

Fix is in #479.

@szabgab
Copy link
Contributor

szabgab commented Jun 4, 2021

There are two man pages committed in the man/ that are removed when you run make clean. Should those be removed from the repository or are they still needed? If they are still needed then probably make clean should not remove them.

@straight-shoota
Copy link
Member

For the time being, they're checked in as a convenience so you don't have to install asciidoctor to read the manpages.

So yeah, probably they shouldn't be cleaned. Feel free to make a PR. It's low priority, though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants