All of lore.kernel.org
 help / color / mirror / Atom feed
From: Andreas Heiduk <asheiduk@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Cc: "Andreas Heiduk" <asheiduk@gmail.com>,
	"Junio C Hamano" <gitster@pobox.com>, "Eric Wong" <e@80x24.org>,
	"Martin Ågren" <martin.agren@gmail.com>
Subject: [PATCH v3 6/7] doc: add note about shell quoting to revision.txt
Date: Thu,  3 May 2018 20:48:29 +0200	[thread overview]
Message-ID: <20180503184830.11889-7-asheiduk@gmail.com> (raw)
In-Reply-To: <20180503184830.11889-1-asheiduk@gmail.com>

Signed-off-by: Andreas Heiduk <asheiduk@gmail.com>
Reviewed-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/revisions.txt | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index dfcc49c72c..e760416d07 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -7,6 +7,10 @@ syntax.  Here are various ways to spell object names.  The
 ones listed near the end of this list name trees and
 blobs contained in a commit.
 
+NOTE: This document shows the "raw" syntax as seen by git. The shell
+and other UIs might require additional quoting to protect special
+characters and to avoid word splitting.
+
 '<sha1>', e.g. 'dae86e1950b1277e545cee180551750029cfe735', 'dae86e'::
   The full SHA-1 object name (40-byte hexadecimal string), or
   a leading substring that is unique within the repository.
@@ -186,6 +190,8 @@ existing tag object.
   is matched. ':/!-foo' performs a negative match, while ':/!!foo' matches a
   literal '!' character, followed by 'foo'. Any other sequence beginning with
   ':/!' is reserved for now.
+  Depending on the given text, the shell's word splitting rules might
+  require additional quoting.
 
 '<rev>:<path>', e.g. 'HEAD:README', ':README', 'master:./README'::
   A suffix ':' followed by a path names the blob or tree
-- 
2.16.2


  parent reply	other threads:[~2018-05-03 18:49 UTC|newest]

Thread overview: 54+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-10 18:32 [PATCH 0/6] Some doc-fixes Andreas Heiduk
2018-04-10 18:32 ` [PATCH 1/6] doc: fix formatting inconsistency in githooks.txt Andreas Heiduk
2018-04-10 19:13   ` Martin Ågren
2018-04-10 20:04     ` Andreas Heiduk
2018-04-10 20:44       ` Martin Ågren
2018-04-10 21:23         ` Junio C Hamano
2018-04-11 21:05           ` Andreas Heiduk
2018-04-11 21:08             ` fixup! " Andreas Heiduk
2018-04-11 21:08             ` Andreas Heiduk
2018-04-12 19:36               ` Martin Ågren
2018-04-27 16:21                 ` Andreas Heiduk
2018-04-10 18:32 ` [PATCH 2/6] doc: align 'diff --no-index' in text with synopsis Andreas Heiduk
2018-04-10 19:14   ` Martin Ågren
2018-04-10 19:32     ` Andreas Heiduk
2018-04-10 21:22   ` Junio C Hamano
2018-04-11 21:21     ` fixup! " Andreas Heiduk
2018-04-10 18:32 ` [PATCH 3/6] doc: clarify ignore rules for git ls-files Andreas Heiduk
2018-04-10 18:32 ` [PATCH 4/6] doc: added '-d' and '-q' for 'git push' Andreas Heiduk
2018-04-10 19:17   ` Martin Ågren
2018-04-10 19:38     ` Andreas Heiduk
2018-04-10 20:05       ` Martin Ågren
2018-04-10 18:39 ` [PATCH 5/6] git-svn: commit-diff does not support --add-author-from Andreas Heiduk
2018-04-17  6:18   ` Eric Wong
2018-04-27 16:31     ` Andreas Heiduk
2018-04-10 18:39 ` [PATCH 6/6] doc: add note about shell quoting to revision.txt Andreas Heiduk
2018-04-10 21:25   ` Junio C Hamano
2018-04-27 17:04 ` [PATCH v2 0/6] Some doc-fixes Andreas Heiduk
2018-05-03 18:48   ` [PATCH v3 0/7] " Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 1/7] doc: improve formatting in githooks.txt Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 2/7] doc: align 'diff --no-index' in text and synopsis Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 3/7] doc: clarify ignore rules for git ls-files Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 4/7] doc: add '-d' and '-o' for 'git push' Andreas Heiduk
2018-05-03 18:48     ` [PATCH v3 5/7] git-svn: remove ''--add-author-from' for 'commit-diff' Andreas Heiduk
2018-05-03 18:48     ` Andreas Heiduk [this message]
2018-05-03 18:48     ` [PATCH v3 7/7] doc: normalize [--options] to [options] in git-diff Andreas Heiduk
2018-05-04 18:47     ` [PATCH v3 0/7] Some doc-fixes Martin Ågren
2018-04-27 17:04 ` [PATCH v2 1/6] doc: improve formatting in githooks.txt Andreas Heiduk
2018-04-27 18:46   ` Martin Ågren
2018-04-27 17:04 ` [PATCH v2 2/6] doc: align 'diff --no-index' in text with synopsis Andreas Heiduk
2018-04-27 17:18   ` Martin Ågren
2018-04-27 18:28     ` Andreas Heiduk
2018-04-27 18:45       ` Martin Ågren
2018-04-27 19:08         ` Andreas Heiduk
2018-04-27 17:33   ` Eric Sunshine
2018-04-27 18:40     ` Andreas Heiduk
2018-04-27 18:43       ` Martin Ågren
2018-04-27 19:12       ` Eric Sunshine
2018-04-27 17:04 ` [PATCH v2 3/6] doc: clarify ignore rules for git ls-files Andreas Heiduk
2018-04-27 17:04 ` [PATCH v2 4/6] doc: add '-d' and '-o' for 'git push' Andreas Heiduk
2018-04-27 17:04 ` [PATCH v2 5/6] git-svn: remove ''--add-author-from' for 'commit-diff' Andreas Heiduk
2018-04-27 17:04 ` [PATCH v2 6/6] doc: add note about shell quoting to revision.txt Andreas Heiduk
2018-04-27 17:36   ` Eric Sunshine
2018-04-27 18:42     ` Andreas Heiduk
2018-04-27 19:23 ` [PATCH v2 7/6] doc: normalize [--options] to [options] in git-diff Andreas Heiduk

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=20180503184830.11889-7-asheiduk@gmail.com \
    --to=asheiduk@gmail.com \
    --cc=e@80x24.org \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=martin.agren@gmail.com \
    /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.