Skip to content

Commit 7923846

Browse files
committed
doc: git-notes.txt: migrate to new documentation format
The git-notes manpage files were converted to the new documentation format: - switching 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. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
1 parent 1b4e9a5 commit 7923846

File tree

2 files changed

+113
-112
lines changed

2 files changed

+113
-112
lines changed

Documentation/config/notes.txt

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
notes.mergeStrategy::
1+
`notes.mergeStrategy`::
22
Which merge strategy to choose by default when resolving notes
33
conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
44
`cat_sort_uniq`. Defaults to `manual`. See the "NOTES MERGE STRATEGIES"
@@ -7,17 +7,17 @@ notes.mergeStrategy::
77
This setting can be overridden by passing the `--strategy` option to
88
linkgit:git-notes[1].
99

10-
notes.<name>.mergeStrategy::
10+
`notes.<name>.mergeStrategy`::
1111
Which merge strategy to choose when doing a notes merge into
12-
refs/notes/<name>. This overrides the more general
13-
"notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
12+
`refs/notes/<name>`. This overrides the more general
13+
`notes.mergeStrategy`. See the "NOTES MERGE STRATEGIES" section in
1414
linkgit:git-notes[1] for more information on the available strategies.
1515

16-
notes.displayRef::
16+
`notes.displayRef`::
1717
Which ref (or refs, if a glob or specified more than once), in
1818
addition to the default set by `core.notesRef` or
1919
`GIT_NOTES_REF`, to read notes from when showing commit
20-
messages with the 'git log' family of commands.
20+
messages with the `git log` family of commands.
2121
+
2222
This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2323
environment variable, which must be a colon separated list of refs or
@@ -26,35 +26,35 @@ globs.
2626
A warning will be issued for refs that do not exist,
2727
but a glob that does not match any refs is silently ignored.
2828
+
29-
This setting can be disabled by the `--no-notes` option to the 'git
30-
log' family of commands, or by the `--notes=<ref>` option accepted by
29+
This setting can be disabled by the `--no-notes` option to the `git
30+
log` family of commands, or by the `--notes=<ref>` option accepted by
3131
those commands.
3232
+
33-
The effective value of "core.notesRef" (possibly overridden by
34-
GIT_NOTES_REF) is also implicitly added to the list of refs to be
33+
The effective value of `core.notesRef` (possibly overridden by
34+
`GIT_NOTES_REF`) is also implicitly added to the list of refs to be
3535
displayed.
3636

37-
notes.rewrite.<command>::
38-
When rewriting commits with <command> (currently `amend` or
37+
`notes.rewrite.<command>`::
38+
When rewriting commits with _<command>_ (currently `amend` or
3939
`rebase`), if this variable is `false`, git will not copy
4040
notes from the original to the rewritten commit. Defaults to
41-
`true`. See also "`notes.rewriteRef`" below.
41+
`true`. See also `notes.rewriteRef` below.
4242
+
4343
This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
4444
environment variable, which must be a colon separated list of refs or
4545
globs.
4646

47-
notes.rewriteMode::
47+
`notes.rewriteMode`::
4848
When copying notes during a rewrite (see the
49-
"notes.rewrite.<command>" option), determines what to do if
49+
`notes.rewrite.<command>` option), determines what to do if
5050
the target commit already has a note. Must be one of
5151
`overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
5252
Defaults to `concatenate`.
5353
+
5454
This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
5555
environment variable.
5656

57-
notes.rewriteRef::
57+
`notes.rewriteRef`::
5858
When copying notes during a rewrite, specifies the (fully
5959
qualified) ref whose notes should be copied. May be a glob,
6060
in which case notes in all matching refs will be copied. You

0 commit comments

Comments
 (0)