Asciidoc man page rework #699
Merged
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
And allow ss-tunnel to use the newly introduced parser. Signed-off-by: Adam Anonymous <anonymous_temp_user@yahoo.co.jp>
Now jconf supports "mode" setting, allowed values are "tcp_only", "tcp_and_udp" and "udp_only". Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
As the coding style differs from kernel and other projects, so such project vimrc should be helpful. Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
Use asciidoc for new documentation framework, which could not only output man pages, but also htmls. And asciidoc documentation is much more human-readable than roff man pages. Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
The port to asciidoc has some format change compared to old one. The most obvious one is the options listed in SYNOPSIS. Now the options list is not split into 2/3 columns, or we must use asciidoc tables and introduce table frames. Other small change includes the removal of AUTHOR sector, as it's not an expendable method to update AUTHOR sector every time it gets updated. Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
Also modify gitignore, since it use too generic rules to ignore such documentation. Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
Welcome to the new age of asciidoc. Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
Now user can get a more clear view of config file and command line options. Signed-off-by: Adam Anonymous <anonymous_temp_mail@yahoo.co.jp>
|
Great! Thanks! |
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.
Just like git/btrfs-progs and a lot of other projects which uses asciidoc as documentation language, change the current hand written roff man page to asciidoc documenation.
Asciidoc has several advantages:
Not only man pages, but also html/pdf
vs
There are also some minor changes introduced by this patchset:
It's never a good idea to update that section just because one updated the man page and want to leave his/her name to the project.
Also, it's not a good idea to expose developers' mail address, for such anti-censorship project.
The original 2/3 columns layout is very nice, although it's nice only in default terminal size(80x24). If we are going to support other output like html or pdf, we shouldn't rely on such manual layout.