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: [RFC/PATCH 00/17] unexpected backslashes in man pages
Date: Fri, 20 Aug 2010 05:19:02 -0500 [thread overview]
Message-ID: <20100820101902.GA10356@burratino> (raw)
(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 reply other threads:[~2010-08-20 10:20 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-08-20 10:19 Jonathan Nieder [this message]
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 ` [PATCH 08/17] Documentation: remove backslashes in manpage synopses Jonathan Nieder
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20100820101902.GA10356@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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.