From: Jonathan Nieder <jrnieder@gmail.com>
To: git@vger.kernel.org
Cc: "Ramkumar Ramachandra" <artagnon@gmail.com>,
"Frédéric Brière" <fbriere@fbriere.net>,
"Christian Couder" <chriscool@tuxfamily.org>,
"Thomas Rast" <trast@student.ethz.ch>
Subject: [PATCH 08/17] Documentation: remove backslashes in manpage synopses
Date: Fri, 20 Aug 2010 05:31:58 -0500 [thread overview]
Message-ID: <20100820103158.GH10407@burratino> (raw)
In-Reply-To: <20100820101902.GA10356@burratino>
For some reason, various manual pages have an asterisk escaped
with \ in the synopsis. Since there is no other asterisk to pair it
with, Asciidoc does not consider this asterisk escapable, so it passes
the backslash through.
Each page either uses [verse] or has only one asterisk, so it
is safe to drop the backslashes (checked with asciidoc 8.5.2).
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Documentation/git-checkout-index.txt | 2 +-
Documentation/git-commit-tree.txt | 2 +-
Documentation/git-for-each-ref.txt | 2 +-
Documentation/git-ls-files.txt | 6 +++---
Documentation/git-merge-index.txt | 2 +-
Documentation/git-relink.txt | 2 +-
Documentation/git-update-index.txt | 4 ++--
7 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt
index d6aa6e1..62f9ab2 100644
--- a/Documentation/git-checkout-index.txt
+++ b/Documentation/git-checkout-index.txt
@@ -13,7 +13,7 @@ SYNOPSIS
[--stage=<number>|all]
[--temp]
[-z] [--stdin]
- [--] [<file>]\*
+ [--] [<file>]*
DESCRIPTION
-----------
diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt
index 6188854..349366e 100644
--- a/Documentation/git-commit-tree.txt
+++ b/Documentation/git-commit-tree.txt
@@ -8,7 +8,7 @@ git-commit-tree - Create a new commit object
SYNOPSIS
--------
-'git commit-tree' <tree> [-p <parent commit>]\* < changelog
+'git commit-tree' <tree> [-p <parent commit>]* < changelog
DESCRIPTION
-----------
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 390d85c..d66fd9d 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -9,7 +9,7 @@ SYNOPSIS
--------
[verse]
'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
- [--sort=<key>]\* [--format=<format>] [<pattern>...]
+ [--sort=<key>]* [--format=<format>] [<pattern>...]
DESCRIPTION
-----------
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index bd919f2..45a7f56 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -10,14 +10,14 @@ SYNOPSIS
--------
[verse]
'git ls-files' [-z] [-t] [-v]
- (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])\*
- (-[c|d|o|i|s|u|k|m])\*
+ (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])*
+ (-[c|d|o|i|s|u|k|m])*
[-x <pattern>|--exclude=<pattern>]
[-X <file>|--exclude-from=<file>]
[--exclude-per-directory=<file>]
[--exclude-standard]
[--error-unmatch] [--with-tree=<tree-ish>]
- [--full-name] [--abbrev] [--] [<file>]\*
+ [--full-name] [--abbrev] [--] [<file>]*
DESCRIPTION
-----------
diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt
index 4d266de..921b38f 100644
--- a/Documentation/git-merge-index.txt
+++ b/Documentation/git-merge-index.txt
@@ -8,7 +8,7 @@ git-merge-index - Run a merge for files needing merging
SYNOPSIS
--------
-'git merge-index' [-o] [-q] <merge-program> (-a | [--] <file>\*)
+'git merge-index' [-o] [-q] <merge-program> (-a | [--] <file>*)
DESCRIPTION
-----------
diff --git a/Documentation/git-relink.txt b/Documentation/git-relink.txt
index 25ff8f9..8a5842b 100644
--- a/Documentation/git-relink.txt
+++ b/Documentation/git-relink.txt
@@ -7,7 +7,7 @@ git-relink - Hardlink common objects in local repositories
SYNOPSIS
--------
-'git relink' [--safe] <dir> [<dir>]\* <master_dir>
+'git relink' [--safe] <dir> [<dir>]* <master_dir>
DESCRIPTION
-----------
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index 765d4b3..74d1d49 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -12,7 +12,7 @@ SYNOPSIS
'git update-index'
[--add] [--remove | --force-remove] [--replace]
[--refresh] [-q] [--unmerged] [--ignore-missing]
- [--cacheinfo <mode> <object> <file>]\*
+ [--cacheinfo <mode> <object> <file>]*
[--chmod=(+|-)x]
[--assume-unchanged | --no-assume-unchanged]
[--skip-worktree | --no-skip-worktree]
@@ -21,7 +21,7 @@ SYNOPSIS
[--info-only] [--index-info]
[-z] [--stdin]
[--verbose]
- [--] [<file>]\*
+ [--] [<file>]*
DESCRIPTION
-----------
--
1.7.2.2.536.g42dab.dirty
next prev parent reply other threads:[~2010-08-20 10:33 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-08-20 10:19 [RFC/PATCH 00/17] unexpected backslashes in man pages Jonathan Nieder
2010-08-20 10:20 ` [PATCH 01/17] Documentation: tweak description of log.date Jonathan Nieder
2010-08-20 10:21 ` [PATCH 02/17] Documentation: quoting trouble in "git rm" discussion Jonathan Nieder
2010-08-20 10:23 ` [PATCH 03/17] Documentation: unbreak regex in show-ref manual Jonathan Nieder
2010-08-20 10:26 ` [PATCH 04/17] Documentation: clarify quoting in "git add" example Jonathan Nieder
2010-08-20 10:28 ` [PATCH 05/17] Documentation: add missing quotes to "git grep" examples Jonathan Nieder
2010-08-20 10:30 ` [PATCH 06/17] Documentation: clarify quoting in "git rm" example Jonathan Nieder
2010-08-20 10:30 ` [PATCH 07/17] Documentation: clarify quoting in gitignore docs Jonathan Nieder
2010-08-20 10:31 ` Jonathan Nieder [this message]
2010-08-20 10:32 ` [PATCH 09/17] Documentation/technical: avoid stray backslash in parse-options API docs Jonathan Nieder
2010-08-20 10:33 ` [PATCH 10/17] Documentation: remove stray backslash from "git bundle" manual Jonathan Nieder
2010-08-20 10:34 ` [PATCH 11/17] Documentation: remove backslash before ~ in fast-import manual Jonathan Nieder
2010-08-20 10:35 ` [PATCH 12/17] Documentation: remove stray backslashes in rev-parse manual Jonathan Nieder
2010-08-20 10:37 ` [PATCH 13/17] Documentation: remove stray backslash in show-branch discussion Jonathan Nieder
2010-08-23 11:18 ` Thomas Rast
2010-08-23 11:36 ` Ramkumar Ramachandra
2010-08-23 22:49 ` Jonathan Nieder
2010-08-20 10:37 ` [PATCH 14/17] Documentation: avoid stray backslashes in core tutorial Jonathan Nieder
2010-08-20 10:38 ` [PATCH 15/17] Documentation: avoid stray backslash in user manual Jonathan Nieder
2010-08-20 10:39 ` [PATCH 16/17] Documentation: do not convert ... operator to ellipses Jonathan Nieder
2010-08-20 10:40 ` [PATCH 17/17] Documentation: remove stray backslashes from "Fighting regressions" article Jonathan Nieder
2010-08-23 11:51 ` [RFC/PATCH 00/17] unexpected backslashes in man pages Thomas Rast
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20100820103158.GH10407@burratino \
--to=jrnieder@gmail.com \
--cc=artagnon@gmail.com \
--cc=chriscool@tuxfamily.org \
--cc=fbriere@fbriere.net \
--cc=git@vger.kernel.org \
--cc=trast@student.ethz.ch \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).