Documentation: some placeholders are lost

Some pieces of text in the documentation files use the <...> syntax to
mark named placeholders. However, the conversion done by pandoc from
Markdown to makefile makes some of these placeholders disappear.

The affected elements are those that contain only characters that could
be valid for an e-mail address or a URL, but are not supposed to be one
of both. Also, elements inside `...`-style code blocks are unaffected.

Fix this situation by escaping the < and > characters where the tags
disappear.

Signed-off-by: Gabriel Filion <lelutin@gmail.com>

diff --git a/Documentation/bup-drecurse.1.md b/Documentation/bup-drecurse.1.md
index a09b9f32b630e2cb3f456931edec06a08d569aec..118d5fa8893534c44d59e5ebe554463e9dbee87b 100644 (file)
--- a/Documentation/bup-drecurse.1.md
+++ b/Documentation/bup-drecurse.1.md
@@ -8,7 +8,7 @@ bup drecurse - recursively list files in your filesystem
 
 # SYNOPSIS
 
-bup drecurse [-x] [-q] [--profile] <path>
+bup drecurse [-x] [-q] [--profile] \<path\>
 
 # DESCRIPTION
 

diff --git a/Documentation/bup-fuse.1.md b/Documentation/bup-fuse.1.md
index 1aa16b262b416f12dea2475c5911d768e660848b..a32dd8d10f0ddaa6bdb20430a292440f358174a4 100644 (file)
--- a/Documentation/bup-fuse.1.md
+++ b/Documentation/bup-fuse.1.md
@@ -8,7 +8,7 @@ bup fuse - mount a bup repository as a filesystem
 
 # SYNOPSIS
 
-bup fuse [-d] [-f] [-o] <mountpoint>
+bup fuse [-d] [-f] [-o] \<mountpoint\>
 
 # DESCRIPTION
 

diff --git a/Documentation/bup-help.1.md b/Documentation/bup-help.1.md
index 04f2081653ef254c8b0cfcfc68022da18592ebc3..f9f29f0e974edad0e7ffad54cb2c8f1257593c38 100644 (file)
--- a/Documentation/bup-help.1.md
+++ b/Documentation/bup-help.1.md
@@ -8,11 +8,11 @@ bup help - open the documentation for a given bup command
 
 # SYNOPSIS
 
-bup help <command>
+bup help \<command\>
 
 # DESCRIPTION
 
-`bup help <command>` opens the documentation for the given command. 
+`bup help <command>` opens the documentation for the given command.
 This is currently equivalent to typing `man bup-<command>`.