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

[RFC/PATCH 00/17] unexpected backslashes in man pages

From
Jonathan Nieder <jrnieder@gmail.com>
Date
Aug 20, 2010, 10:19 UTC
Message-ID
<20100820101902.GA10356@burratino>
(cc: interested parties and documentation experts)
Hi,

This series is longer than I would like, and I am not happy to impose the review burden. So if something does not look obviously correct at a glance, please let me know and I'll try to simplify it.

The topic: as Frédéric Brière noticed in <http://bugs.debian.org/540001>, various man pages have collected backslashes where they don't belong.

Maybe we should forbid backslashes outside of

-------- literal --------

sections.  Well, I did not go that far.
Still, maybe the patches can be useful.
Jonathan Nieder (17):
  Documentation: tweak description of log.date
  Documentation: quoting trouble in "git rm" discussion
  Documentation: unbreak regex in show-ref --exclude-existing
    description
  Documentation: clarify quoting in "git add" example
  Documentation: add missing quotes to "git grep" examples
  Documentation: clarify quoting in "git rm" example
  Documentation: clarify quoting in gitignore docs
  Documentation: remove backslashes in manpage synopses
  Documentation/technical: avoid stray backslash in parse-options API
    docs
  Documentation: remove stray backslash from "git bundle" manual
  Documentation: remove backslash before ~ in fast-import manual
  Documentation: remove stray backslashes in rev-parse manual
  Documentation: remove stray backslash in show-branch discussion
  Documentation: avoid stray backslashes in core tutorial
  Documentation: avoid stray backslash in user manual
  Documentation: do not convert ... operator to ellipses
  Documentation: remove stray backslashes from "Fighting regressions"
    article
 Documentation/asciidoc.conf                   |    2 ++
 Documentation/config.txt                      |    9 +++++----
 Documentation/git-add.txt                     |    4 ++--
 Documentation/git-bisect-lk2009.txt           |    2 +-
 Documentation/git-bundle.txt                  |    8 ++++----
 Documentation/git-checkout-index.txt          |    2 +-
 Documentation/git-checkout.txt                |    2 +-
 Documentation/git-commit-tree.txt             |    2 +-
 Documentation/git-fast-export.txt             |    2 +-
 Documentation/git-for-each-ref.txt            |    2 +-
 Documentation/git-grep.txt                    |    4 ++--
 Documentation/git-ls-files.txt                |    6 +++---
 Documentation/git-merge-index.txt             |    2 +-
 Documentation/git-push.txt                    |    2 +-
 Documentation/git-rebase.txt                  |    2 +-
 Documentation/git-relink.txt                  |    2 +-
 Documentation/git-rev-parse.txt               |    9 +++++----
 Documentation/git-rm.txt                      |    9 +++++----
 Documentation/git-show-branch.txt             |    2 +-
 Documentation/git-show-ref.txt                |    4 ++--
 Documentation/git-update-index.txt            |    4 ++--
 Documentation/gitcore-tutorial.txt            |   18 +++++++++---------
 Documentation/gitignore.txt                   |    4 ++--
 Documentation/rev-list-options.txt            |    2 +-
 Documentation/technical/api-parse-options.txt |    8 ++++----
 Documentation/user-manual.txt                 |    4 ++--
 26 files changed, 61 insertions(+), 56 deletions(-)
-- 
1.7.2.2.536.g42dab.dirty
Next: Jonathan Nieder
Message 1 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.