PR to improve man page

[Tomas Hnyk]

Hello,

I opened a simple PR: https://github.com/bup/bup/pull/75
it instructed me to forward it to the mailing list, so I am doing that. The rationale and screenshot are included in the PR. I am happy to discuss it here, just please include me specifically in your replies as I have not subscribed to the mailing list.

Kind regards,

Tomas

[Rob Browning]

Remove the single quotes from the example patterns (change them to
code) to reduce any confusion about whether they might be part of the
pattern.

Thanks to Tomáš Hnyk for reporting the concern and proposing related
adjustments.

Signed-off-by: Rob Browning <r...@defaultvalue.org>
---

Thanks for the suggestion --- I hadn't noticed, and agree that the
quotes are potentially confusing, so I've changed them to quotation
as code instead (likely just invisible when rendered in a terminal,
at least via pandoc).

And I think I might like to leave the hyphens as hyphens for now so
we don't have to think about any potential issues across
platforms/tools/terminals, etc., though I have a suspcion it'd be
"fine".

Documentation/bup-get.1.md | 8 ++++----
Documentation/bup-index.1.md | 8 ++++----
Documentation/bup-restore.1.md | 8 ++++----
3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/Documentation/bup-get.1.md b/Documentation/bup-get.1.md
index c14c25b7..f2835541 100644
--- a/Documentation/bup-get.1.md
+++ b/Documentation/bup-get.1.md
@@ -190,10 +190,10 @@ used to help test before/after results.)

Examples:

- * '/foo$' - exclude any file named foo
- * '/foo/$' - exclude any directory named foo
- * '/foo/.' - exclude the content of any directory named foo
- * '^/tmp/.' - exclude root-level /tmp's content, but not /tmp itself
+ * `/foo$` - exclude any file named foo
+ * `/foo/$` - exclude any directory named foo
+ * `/foo/.` - exclude the content of any directory named foo
+ * `^/tmp/.` - exclude root-level tmp's content

Only supported when rewriting or repairing. This option is
contextual (see CONTEXTUAL OPTIONS).
diff --git a/Documentation/bup-index.1.md b/Documentation/bup-index.1.md
index 73400955..c7350b1d 100644
--- a/Documentation/bup-index.1.md
+++ b/Documentation/bup-index.1.md
@@ -174,10 +174,10 @@ does, due to the accommodations described above.

Examples:

- * '/foo$' - exclude any file named foo
- * '/foo/$' - exclude any directory named foo
- * '/foo/.' - exclude the content of any directory named foo
- * '^/tmp/.' - exclude root-level /tmp's content, but not /tmp itself
+ * `/foo$` - exclude any file named foo
+ * `/foo/$` - exclude any directory named foo
+ * `/foo/.` - exclude the content of any directory named foo
+ * `^/tmp/.` - exclude root-level tmp's content

\--exclude-rx-from=*filename*
: read --exclude-rx patterns from *filename*, one pattern per-line
diff --git a/Documentation/bup-restore.1.md b/Documentation/bup-restore.1.md
index e6363636..8e211034 100644
--- a/Documentation/bup-restore.1.md
+++ b/Documentation/bup-restore.1.md
@@ -130,10 +130,10 @@ See the EXAMPLES section for a demonstration.

Examples:

- * '/foo$' - exclude any file named foo
- * '/foo/$' - exclude any directory named foo
- * '/foo/.' - exclude the content of any directory named foo
- * '^/tmp/.' - exclude root-level /tmp's content, but not /tmp itself
+ * `/foo$` - exclude any file named foo
+ * `/foo/$` - exclude any directory named foo
+ * `/foo/.` - exclude the content of any directory named foo
+ * `^/tmp/.` - exclude root-level tmp's content

\--exclude-rx-from=*filename*
: read --exclude-rx patterns from *filename*, one pattern per-line
--
2.47.3

[Greg Troxel]

Rob Browning <r...@defaultvalue.org> writes:

> And I think I might like to leave the hyphens as hyphens for now so
> we don't have to think about any potential issues across
> platforms/tools/terminals, etc., though I have a suspcion it'd be
> "fine".

It might be, if when convereted to plain ASCII they end up hyphens
again. man pages are supposed to be ok on a VT100 :-) is my view, vs
requiring these newfangled ISO-8859-1 dashes and quotes.