@matheusbsbs / matheus-bagliano / commits / 8e9fe16c87

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 <emilyshaffer@google.com> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Emily Shaffer committed May 1, 2019 at 13:32 UTC 8e9fe16c878d15f7a007dbe943e4480787381913

1 file changed +7 -7

Documentation/gitsubmodules.txt

+7 -7

@@ -169,15 +169,15 @@ ACTIVE SUBMODULES

169

170 A submodule is considered active,

171

172 - a. if `submodule.<name>.active` is set to `true`

172 + 1. if `submodule.<name>.active` is set to `true`

173 +

174 or

175

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`

177 +

178 or

179

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

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

181

182 and these are evaluated in this order.

183

@@ -193,11 +193,11 @@ For example:

193 url = https://example.org/baz

194

195 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)

198

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,

201 if we have a `submodule.<name>.active` set to `false` or if the

202 submodule's path is excluded in the pathspec in `submodule.active`, the

203 url doesn't matter whether it is present or not. This is illustrated in