Add the ability to generate manpage and documentation for BSD systems #326
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
skvadrik
requested changes
Oct 19, 2020
There was a problem hiding this comment.
Great patch, made me learn about col and grep -A! They both seem to be non-POSIX (grep has no -A: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/grep.html, and col seems to have been excluded: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xcu_chap04.html). But I tested this both on Linux and FreeBSD and it works, so let's use them.
skvadrik
reviewed
Oct 19, 2020
sergeyklay
force-pushed
the
fix/genhelp
branch
from
296e246
to
e55268f
Compare
sergeyklay
changed the title
sergeyklay
changed the title
- Stripping headers may not work as expected, as man output differs on different systems. This should work now. - Simplified output parsing procedure by replacing the regular expression by TERM=dumb. - Stripping escape sequences. - Added documentation about the intentions of this script. For more see: skvadrik#325
Windows does not have a native 'man' and 'sed' commands. Therefore, we are looking for the Cygwin versions of 'man' and 'sed'. For more see: skvadrik#325
This aims to provide a bit more clear error messages on regenerate manpage stage as well as documentation.
There is no need for redirect output with > (which doesn't work on Windows) as this is how rst2man works: rst2man [options] [<source> [<destination>]] For more see: skvadrik#325
sergeyklay
force-pushed
the
fix/genhelp
branch
from
e55268f
to
78239f2
Compare
skvadrik
approved these changes
Oct 20, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add the ability to generate manpage and documentation for BSD systems
TERM=dumb.Check for
manandsedon Windows whenRE2C_REBUILD_DOCSisONWindows does not have a native
manandsedcommands. Therefore, we are looking for the Cygwin versions ofmanandsed. This doesn't add full Windows support. However, in case of the absence of the required programs, this shows error messages before the build stage.Rephrase error messages for
RE2C_REBUILD_DOCS=ONThis aims to provide a bit more clear error messages on regenerate manpage stage as well as documentation.
Remove rst2man output redirection as it doesn't work on Windows
There is no need for redirect output with
>(which doesn't work on Windows) as this is how rst2man works:For the discussion see: #325