git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 08/17] Documentation: remove backslashes in manpage synopses

From
Jonathan Nieder <jrnieder@gmail.com>
Date
Aug 20, 2010, 10:31 UTC
Message-ID
<20100820103158.GH10407@burratino>
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
Previous: Jonathan NiederNext: Jonathan Nieder
Message 9 of 22 in “unexpected backslashes in man pages”
  1. 00/17 unexpected backslashes in man pagesJonathan Nieder, Aug 20, 2010
  2. 01/17 Documentation: tweak description of log.dateJonathan Nieder, Aug 20, 2010
  3. 02/17 Documentation: quoting trouble in "git rm" discussionJonathan Nieder, Aug 20, 2010
  4. 03/17 Documentation: unbreak regex in show-ref manualJonathan Nieder, Aug 20, 2010
  5. 04/17 Documentation: clarify quoting in "git add" exampleJonathan Nieder, Aug 20, 2010
  6. 05/17 Documentation: add missing quotes to "git grep" examplesJonathan Nieder, Aug 20, 2010
  7. 06/17 Documentation: clarify quoting in "git rm" exampleJonathan Nieder, Aug 20, 2010
  8. 07/17 Documentation: clarify quoting in gitignore docsJonathan Nieder, Aug 20, 2010
  9. 08/17 Documentation: remove backslashes in manpage synopsesJonathan Nieder, Aug 20, 2010
  10. 09/17 Documentation/technical: avoid stray backslash in parse-options API docsJonathan Nieder, Aug 20, 2010
  11. 10/17 Documentation: remove stray backslash from "git bundle" manualJonathan Nieder, Aug 20, 2010
  12. 11/17 Documentation: remove backslash before ~ in fast-import manualJonathan Nieder, Aug 20, 2010
  13. 12/17 Documentation: remove stray backslashes in rev-parse manualJonathan Nieder, Aug 20, 2010
  14. 13/17 Documentation: remove stray backslash in show-branch discussionJonathan Nieder, Aug 20, 2010
  15. Thomas RastAug 23, 2010
  16. Ramkumar RamachandraAug 23, 2010
  17. Jonathan NiederAug 23, 2010
  18. 14/17 Documentation: avoid stray backslashes in core tutorialJonathan Nieder, Aug 20, 2010
  19. 15/17 Documentation: avoid stray backslash in user manualJonathan Nieder, Aug 20, 2010
  20. 16/17 Documentation: do not convert ... operator to ellipsesJonathan Nieder, Aug 20, 2010
  21. 17/17 Documentation: remove stray backslashes from "Fighting regressions" articleJonathan Nieder, Aug 20, 2010
  22. Thomas RastAug 23, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.