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>

diff --git a/Documentation/bup-bloom.md b/Documentation/bup-bloom.md
index f50e07df6851c18b9fc84f2e843ec59cba7b473b..9efea60b87b1485ed26553b35c54d29b252f7950 100644 (file)
--- a/Documentation/bup-bloom.md
+++ b/Documentation/bup-bloom.md
@@ -29,7 +29,7 @@ updates or regenerates it as needed.
     one from scratch.
 
 -d, \--dir=*directory*
-:   the directory, containing .idx files, to process.
+:   the directory, containing `.idx` files, to process.
     Defaults to $BUP_DIR/objects/pack
 
 -o, \--outfile=*outfile*
@@ -43,10 +43,10 @@ updates or regenerates it as needed.
 
 -c, \--check=*idxfile*
 :   checks the bloom file (counterintuitively outfile)
-    against the specified .idx file, first checks that the
-    bloom filter is claiming to contain the .idx, then
+    against the specified `.idx` file, first checks that the
+    bloom filter is claiming to contain the `.idx`, then
     checks that it does actually contain all of the objects
-    in the .idx.  Does not write anything and ignores the
+    in the `.idx`.  Does not write anything and ignores the
     `-k` option.
 
 # BUP

diff --git a/Documentation/bup-margin.md b/Documentation/bup-margin.md
index 23f0ef1231fb3c3887b8e9603f04a08e71a1f2ae..0e5376c75d2dba4af038639728cc998dc8397395 100644 (file)
--- a/Documentation/bup-margin.md
+++ b/Documentation/bup-margin.md
@@ -47,7 +47,7 @@ close to 160 bits.
     search algorithm.
     
 \--ignore-midx
-:   don't use .midx files, use only .idx files.  This is
+:   don't use `.midx` files, use only `.idx` files.  This is
     only really useful when used with `--predict`.
 
     

diff --git a/Documentation/bup-midx.md b/Documentation/bup-midx.md
index 7c67a2dd0e20ac8503b0b9eff13d54392f7a2745..a256c6cb5e6e2a9e0ad670e243366a3f11d80cf0 100644 (file)
--- a/Documentation/bup-midx.md
+++ b/Documentation/bup-midx.md
@@ -4,7 +4,7 @@
 
 # NAME
 
-bup-midx - create a multi-index (.midx) file from several .idx files
+bup-midx - create a multi-index (`.midx`) file from several `.idx` files
 
 # SYNOPSIS
 
@@ -12,45 +12,45 @@ bup midx [-o *outfile*] \<-a|-f|*idxnames*...\>
 
 # DESCRIPTION
 
-`bup midx` creates a multi-index (.midx) file from one or more
-git pack index (.idx) files.
+`bup midx` creates a multi-index (`.midx`) file from one or more
+git pack index (`.idx`) files.
 
-Note: you should no longer need to run this command by hand. 
+Note: you should no longer need to run this command by hand.
 It gets run automatically by `bup-save`(1) and similar
 commands.
 
 # OPTIONS
 
 -o, \--output=*filename.midx*
-:   use the given output filename for the .midx file. 
+:   use the given output filename for the `.midx` file.
     Default is auto-generated.
-    
+
 -a, \--auto
-:   automatically generate new .midx files for any .idx
+:   automatically generate new `.midx` files for any `.idx`
     files where it would be appropriate.
-    
+
 -f, \--force
-:   force generation of a single new .midx file containing
-    *all* your .idx files, even if other .midx files
+:   force generation of a single new `.midx` file containing
+    *all* your `.idx` files, even if other `.midx` files
     already exist.  This will result in the fastest backup
     performance, but may take a long time to run.
 
 \--dir=*packdir*
-:   specify the directory containing the .idx/.midx files
+:   specify the directory containing the `.idx`/`.midx` files
     to work with.  The default is $BUP_DIR/objects/pack and
     $BUP_DIR/indexcache/*.
 
 \--max-files
-:   maximum number of .idx files to open at a time.  You
+:   maximum number of `.idx` files to open at a time.  You
     can use this if you have an especially small number of file
     descriptors available, so that midx can complete
     (though possibly non-optimally) even if it can't open
-    all your .idx files at once.  The default value of this
+    all your `.idx` files at once.  The default value of this
     option should be fine for most people.
     
 \--check
-:   validate a .midx file by ensuring that all objects in
-    its contained .idx files exist inside the .midx.  May
+:   validate a `.midx` file by ensuring that all objects in
+    its contained `.idx` files exist inside the `.midx`.  May
     be useful for debugging.
 
 
@@ -74,7 +74,7 @@ Normal idx files are convenient because it means you can use
 files can get slow when you have a lot of very large packs
 (which git typically doesn't have, but bup often does).
 
-bup .midx files consist of a single sorted list of all the objects
+bup `.midx` files consist of a single sorted list of all the objects
 contained in all the .pack files it references.  This list
 can be binary searched in about log2(m) steps, where m is
 the total number of objects.

diff --git a/Documentation/bup-server.md b/Documentation/bup-server.md
index 00c5df0a9db68e8b81194208215947e6cfe5745a..6f25f4c29bf163e8c3281a0979f1f31402c7b4d4 100644 (file)
--- a/Documentation/bup-server.md
+++ b/Documentation/bup-server.md
@@ -33,7 +33,7 @@ dumb
 :   In this mode, the server will not check its local index
     before writing an object.  To avoid writing duplicate
     objects, the server will tell the client to download all
-    of its .idx files at the start of the session.  This
+    of its `.idx` files at the start of the session.  This
     mode is useful on low powered server hardware (ie
     router/slow NAS).