]> git.ipfire.org Git - thirdparty/git.git/commit - Documentation/gitsubmodules.txt
gitsubmodules: align html and nroff lists
authorEmily Shaffer <emilyshaffer@google.com>
Wed, 1 May 2019 20:32:17 +0000 (13:32 -0700)
committerJunio C Hamano <gitster@pobox.com>
Tue, 28 May 2019 16:42:06 +0000 (09:42 -0700)
commit8e9fe16c878d15f7a007dbe943e4480787381913
treed14a8fe4b04687cc633ed229a923e5fef54ddaa4
parentaeb582a98374c094361cba1bd756dc6307432c42
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>
Documentation/gitsubmodules.txt