-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
New manpage format #1921
base: gh-pages
Are you sure you want to change the base?
New manpage format #1921
Conversation
I just triggered a pair of workflow runs to update the manual pages and to update the translated manual pages, fetched the result and rendered it locally. Here are two examples:
Personally, I cannot spot any difference, apart from the version number (because this here PR branch is based on v2.46.2 while the updated manual pages include v2.47.0) and the incorrect Even looking at the HTML of the synopses (taking the French version, so that there is a known difference), I only see this: diff --git a/before b/after
index 1a87d1348..6185fb72b 100644
--- a/before
+++ b/after
@@ -1,5 +1,5 @@
<pre class="content"><em>git config list</em> [<option-de-fichier>] [<option-d-affichage>] [--includes]
-<em>git config get</em> [<option-de-fichier>] [<option-d-affichage>] [--includes] [--all] [--regexp=<regexp>] [--value=<valeur>] [--fixed-value] [--default=<default>] <nom>
+<em>git config get</em> [<option-de-fichier>] [<option-d-affichage>] [--includes] [--all] [--regexp] [--value=<valeur>] [--fixed-value] [--default=<default>] <nom>
<em>git config set</em> [<option-de-fichier>] [--type=<type>] [--all] [--value=<valeur>] [--fixed-value] <nom> <valeur>
<em>git config unset</em> [<option-de-fichier>] [--all] [--value=<valeur>] [--fixed-value] <nom> <valeur>
<em>git config rename-section</em> [<option-de-fichier>] <ancien-name> <nouveau-name> @jnavila what am I missing? |
The manpage of git-config has not been converted yet. After importing, here is the result: I'm not satisfied with the styles, particularly when dealing with inline formats: you can test by yourself locally, and tell me your judgment. |
The new style makes the code spans lighter and more integrated into the text. The new style also makes the code spans more readable and less intrusive. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
This commit adds a upcoming manpage format to the AsciiDoc backend. The new format changes are: * The synopsis is now a section with a dedicated style. This "synopsis" style allows to automatically format the keywords as monospaced and <placeholders> as italic. * the backticks are now used to format synopsis-like syntax in inline elements. All the manpages are processed with this format. It may upset the formatting for older manpages, making it not consistent across a page, but this will be a mild side effect, as this was not really consistent before. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
3cb6e5e
to
9bd765a
Compare
@dscho I updated the CSS, so it is ready for review. |
Changes
This PR changes the way the asciidoc source of manpage is processed, by adding the "synopsis" paragraph style and reworking the backtick format.
Context
The style change has been pushed to master and will be applied to git-clone and git-init in the next version.