]> arthur.barton.de Git - bup.git/commit
Documentation: Protect file extensions from start of line.
authorGabriel Filion <lelutin@gmail.com>
Mon, 1 Oct 2012 07:13:53 +0000 (03:13 -0400)
committerRob Browning <rlb@defaultvalue.org>
Sat, 6 Oct 2012 21:41:52 +0000 (16:41 -0500)
commit73aedc7877b9e312184b250d5ce56012a90aa1d4
treebdacea665b6d009c9e35d914bc2553892d5f7013
parent2c7442fe0e652568504554750fa8d3f4983273a7
Documentation: Protect file extensions from start of line.

In the documentation files, we use file extensions as words to simplify
the text. When compiling man pages from the Markdown files, it is
possible that an extension lands at the beginning of a line.

In such a case, the extension is mistakenly identified as a Groff macro.
It seems as though Groff simply ignores it since it is not a known
macro, but emits a warning about the syntax.

This was caught thanks to the debian package's lintian output at:

http://lintian.debian.org/maintainer/jmtd@debian.org.html#bup

Since we're putting highlighting on file extensions, we should add it to
all cases, even though there's not risk of it landing at the beginning
of a line. This way, the documentation looks better standardized.

Signed-off-by: Gabriel Filion <lelutin@gmail.com>
Reviewed-by: Rob Browning <rlb@defaultvalue.org>
Documentation/bup-bloom.md
Documentation/bup-margin.md
Documentation/bup-midx.md
Documentation/bup-server.md