Skip to content

Commit 8e9fe16

Browse files
nasamuffingitster
authored andcommitted
gitsubmodules: align html and nroff lists
There appears to be a bug in the toolchain generating manpages from lettered lists. When a list is enumerated with letters, the resulting nroff shows numbers instead. Mostly this is harmless, but in the case of gitsubmodules, the paragraph following the list refers back to each bullet by letter. As a result, reading this documentation via `man gitsubmodules` is hard to parse - readers must infer that a bug exists and a refers to 1, b refers to 2, and c refers to 3 in the list above. The problem specifically was introduced in ad47194; previously rather than generating numerated lists the bulleted area was entirely monospaced in HTML and shown in plaintext in nroff. The bug seems to exist in docbook-xml - I've reported it on May 1 via the docbook-apps mail list - but for now it may make more sense to just work around the issue. Signed-off-by: Emily Shaffer <[email protected]> Reviewed-by: Jonathan Nieder <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent aeb582a commit 8e9fe16

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Documentation/gitsubmodules.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -169,15 +169,15 @@ ACTIVE SUBMODULES
169169

170170
A submodule is considered active,
171171

172-
a. if `submodule.<name>.active` is set to `true`
172+
1. if `submodule.<name>.active` is set to `true`
173173
+
174174
or
175175

176-
b. if the submodule's path matches the pathspec in `submodule.active`
176+
2. if the submodule's path matches the pathspec in `submodule.active`
177177
+
178178
or
179179

180-
c. if `submodule.<name>.url` is set.
180+
3. if `submodule.<name>.url` is set.
181181

182182
and these are evaluated in this order.
183183

@@ -193,11 +193,11 @@ For example:
193193
url = https://example.org/baz
194194

195195
In the above config only the submodule 'bar' and 'baz' are active,
196-
'bar' due to (a) and 'baz' due to (c). 'foo' is inactive because
197-
(a) takes precedence over (c)
196+
'bar' due to (1) and 'baz' due to (3). 'foo' is inactive because
197+
(1) takes precedence over (3)
198198

199-
Note that (c) is a historical artefact and will be ignored if the
200-
(a) and (b) specify that the submodule is not active. In other words,
199+
Note that (3) is a historical artefact and will be ignored if the
200+
(1) and (2) specify that the submodule is not active. In other words,
201201
if we have a `submodule.<name>.active` set to `false` or if the
202202
submodule's path is excluded in the pathspec in `submodule.active`, the
203203
url doesn't matter whether it is present or not. This is illustrated in

0 commit comments

Comments
 (0)