doc: convert git-status, git remote and git stage to synopsis style #2020
+238
−230
Conversation
This file contains hidden or 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
In case there are multiple synopsis blocks (declared with [synopsis] or [verse] style) in the same file, the previous implementation was incorrectly picking up text from all the blocks until the first empty line. This commit modifies the sed command to stop processing upon encountering the first empty line after the first block declaration, thereby ensuring that only the intended block is captured. Signed-off-by: Jean-Noël Avila <[email protected]>
jnavila
force-pushed
the
doc_git_status
branch
from
c0b8e63 to
c574868
Compare
Also convert unformatted lists to proper AsciiDoc lists. Signed-off-by: Jean-Noël Avila <[email protected]>
Instead of plain text tables with hand formatting, take advantage of asciidoc's table syntax to let the renderer do the heavy lifting and make the tables more maintainable and translatable. Signed-off-by: Jean-Noël Avila <[email protected]>
Signed-off-by: Jean-Noël Avila <[email protected]>
- Switch the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace - Use _<placeholder>_ instead of <placeholder> in the description - Use `backticks` for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans. - also convert first sentences to imperative mood where applicable Signed-off-by: Jean-Noël Avila <[email protected]>
jnavila
force-pushed
the
doc_git_status
branch
from
c574868 to
e6012eb
Compare
Author
|
/submit |
|
Submitted as [email protected] To fetch this version into To fetch this version to local tag |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The changes are basically the expected stuff for synopsis conversion, and a few cases of "imperative mood" style.
Additionally, this series has two special commits
The second patch is a RFC as to whether we should convert our tables or not. For the translations of the manual pages, this setup simplifies the maintenance, because we are able to export each table cell as a separate segment.