Thread (35 messages) 35 messages, 6 authors, 2021-11-07

Re: [PATCH v2 3/9] doc: express grammar placeholders between angle brackets

flat view

From: Eric Sunshine <hidden>
Date: 2021-10-28 17:46:31

On Thu, Oct 28, 2021 at 12:22 PM Jean-Noël Avila via GitGitGadget
[off-list ref] wrote:
doc: express grammar placeholders between angle brackets

This rules discerns user inputs from verbatim options in the
synopsis.
Maybe: s/rules//
quoted hunk ↗ jump to hunk
Signed-off-by: Jean-Noël Avila <redacted>
---
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
@@ -145,7 +145,7 @@ See also <<FILES>>.
--f config-file::
+-f <config-file>::
 --file config-file::
You need to fix the `--file` item as well (mentioned in my v1 review):

    --file <config-file>::
quoted hunk ↗ jump to hunk
@@ -281,7 +281,7 @@ Valid `<type>`'s include:
 --default <value>::
   When using `--get`, and the requested variable is not found, behave as if
-  <value> were the value assigned to the that variable.
+  `<value>` were the value assigned to the that variable.
This change seems out of place in this patch which claims only to be
adding angle brackets.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help