From: Martin Ågren <martin.agren@gmail.com> To: git@vger.kernel.org Cc: Jeff King <peff@peff.net> Subject: [PATCH 2/4] doc: convert [\--] to [--] Date: Tue, 17 Apr 2018 21:15:27 +0200 Message-ID: <7a9c99617b0cc03897bf1f02a21a14ee6509cf81.1523991648.git.martin.agren@gmail.com> (raw) In-Reply-To: <cover.1523991648.git.martin.agren@gmail.com> Commit 1c262bb7b (doc: convert \--option to --option, 2015-05-13) explains that we used to need to write \--option to play well with older versions of AsciiDoc, but that we do not support such versions anymore anyway, and that Asciidoctor literally renders \--. With [\--], which is used to denote the optional separator between revisions and paths, Asciidoctor renders the backslash literally. Change all [\--] to [--]. This changes nothing for AsciiDoc version 8.6.9, but is an improvement for Asciidoctor version 1.5.4. We use double-dashes in several list entries (\--::). In my testing, it appears that we do need to use the backslash there, so leave those. Signed-off-by: Martin Ågren <martin.agren@gmail.com> --- Documentation/git-log.txt | 4 ++-- Documentation/git-shortlog.txt | 4 ++-- Documentation/gitk.txt | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index 5437f8b0f0..be2f10b70b 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -9,7 +9,7 @@ git-log - Show commit logs SYNOPSIS -------- [verse] -'git log' [<options>] [<revision range>] [[\--] <path>...] +'git log' [<options>] [<revision range>] [[--] <path>...] DESCRIPTION ----------- @@ -90,7 +90,7 @@ include::line-range-format.txt[] ways to spell <revision range>, see the 'Specifying Ranges' section of linkgit:gitrevisions[7]. -[\--] <path>...:: +[--] <path>...:: Show only commits that are enough to explain how the files that match the specified paths came to be. See 'History Simplification' below for details and other simplification diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt index 5e35ea18ac..00a22152a2 100644 --- a/Documentation/git-shortlog.txt +++ b/Documentation/git-shortlog.txt @@ -8,7 +8,7 @@ git-shortlog - Summarize 'git log' output SYNOPSIS -------- [verse] -'git shortlog' [<options>] [<revision range>] [[\--] <path>...] +'git shortlog' [<options>] [<revision range>] [[--] <path>...] git log --pretty=short | 'git shortlog' [<options>] DESCRIPTION @@ -69,7 +69,7 @@ them. ways to spell <revision range>, see the "Specifying Ranges" section of linkgit:gitrevisions[7]. -[\--] <path>...:: +[--] <path>...:: Consider only commits that are enough to explain how the files that match the specified paths came to be. + diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index ca96c281d1..244cd01493 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -8,7 +8,7 @@ gitk - The Git repository browser SYNOPSIS -------- [verse] -'gitk' [<options>] [<revision range>] [\--] [<path>...] +'gitk' [<options>] [<revision range>] [--] [<path>...] DESCRIPTION ----------- -- 2.17.0.252.gfe0a9eaf31
next prev parent reply index Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top 2018-03-10 11:52 [PATCH 0/3] shortlog: do not accept revisions when run outside repo Martin Ågren 2018-03-10 11:52 ` [PATCH 1/3] git-shortlog.txt: reorder usages Martin Ågren 2018-03-13 19:19 ` Junio C Hamano 2018-03-10 11:52 ` [PATCH 2/3] shortlog: add usage-string for stdin-reading Martin Ågren 2018-03-10 11:52 ` [PATCH 3/3] shortlog: do not accept revisions when run outside repo Martin Ågren 2018-03-13 19:56 ` Jonathan Nieder 2018-03-13 20:47 ` Martin Ågren 2018-03-13 21:36 ` Jonathan Nieder 2018-03-13 21:46 ` Junio C Hamano 2018-03-14 5:06 ` Martin Ågren 2018-03-14 21:34 ` [PATCH v2 0/3] shortlog: disallow left-over arguments " Martin Ågren 2018-03-14 21:34 ` [PATCH v2 1/3] git-shortlog.txt: reorder usages Martin Ågren 2018-03-14 21:34 ` [PATCH v2 2/3] shortlog: add usage-string for stdin-reading Martin Ågren 2018-03-14 21:34 ` [PATCH v2 3/3] shortlog: disallow left-over arguments outside repo Martin Ågren 2018-03-28 8:48 ` [PATCH 0/3] shortlog: do not accept revisions when run " Jeff King 2018-03-28 12:24 ` Martin Ågren 2018-04-17 19:15 ` [PATCH 0/4] doc: cleaning up instances of \-- Martin Ågren 2018-04-17 19:15 ` [PATCH 1/4] doc: convert \--option to --option Martin Ågren 2018-04-17 19:15 ` Martin Ågren [this message] 2018-04-17 19:15 ` [PATCH 3/4] git-[short]log.txt: unify quoted standalone -- Martin Ågren 2018-04-17 19:15 ` [PATCH 4/4] git-submodule.txt: quote usage in monospace, drop backslash Martin Ågren 2018-04-18 4:24 ` [PATCH 0/4] doc: cleaning up instances of \-- Junio C Hamano 2018-05-10 7:11 ` Jeff King 2018-04-19 1:25 ` brian m. carlson
Reply instructions: You may reply publically 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=7a9c99617b0cc03897bf1f02a21a14ee6509cf81.1523991648.git.martin.agren@gmail.com \ --to=martin.agren@gmail.com \ --cc=git@vger.kernel.org \ --cc=peff@peff.net \ /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
git@vger.kernel.org list mirror (unofficial, one of many) Archives are clonable: git clone --mirror https://public-inbox.org/git git clone --mirror http://ou63pmih66umazou.onion/git git clone --mirror http://czquwvybam4bgbro.onion/git git clone --mirror http://hjrcffqmbrq6wope.onion/git Example config snippet for mirrors Newsgroups are available over NNTP: nntp://news.public-inbox.org/inbox.comp.version-control.git nntp://ou63pmih66umazou.onion/inbox.comp.version-control.git nntp://czquwvybam4bgbro.onion/inbox.comp.version-control.git nntp://hjrcffqmbrq6wope.onion/inbox.comp.version-control.git nntp://news.gmane.org/gmane.comp.version-control.git note: .onion URLs require Tor: https://www.torproject.org/ AGPL code for this site: git clone https://public-inbox.org/public-inbox.git