From: Jeff King <peff@peff.net> To: git@vger.kernel.org Subject: [PATCH 3/3] gitcli: document --end-of-options Date: Tue, 6 Aug 2019 10:40:30 -0400 Message-ID: <20190806144030.GC2161@sigill.intra.peff.net> (raw) In-Reply-To: <20190806143829.GA515@sigill.intra.peff.net> Now that --end-of-options is available for any users of setup_revisions() or parse_options(), which should be effectively everywhere, we can guide people to use it for all their disambiguating needs. Signed-off-by: Jeff King <peff@peff.net> --- Documentation/gitcli.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index 1ed3ca33b7..4b32876b6e 100644 --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt @@ -37,6 +37,12 @@ arguments. Here are the rules: file called HEAD in your work tree, `git diff HEAD` is ambiguous, and you have to say either `git diff HEAD --` or `git diff -- HEAD` to disambiguate. + + * Because `--` disambiguates revisions and paths in some commands, it + cannot be used for those commands to separate options and revisions. + You can use `--end-of-options` for this (it also works for commands + that do not distinguish between revisions in paths, in which case it + is simply an alias for `--`). + When writing a script that is expected to handle random user-input, it is a good practice to make it explicit which arguments are which by placing -- 2.23.0.rc1.436.g24d2e81391
next prev parent reply other threads:[~2019-08-06 14:40 UTC|newest] Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-08-06 14:38 [PATCH 0/3] --end-of-options marker Jeff King 2019-08-06 14:39 ` [PATCH 1/3] revision: allow --end-of-options to end option parsing Jeff King 2019-08-06 14:40 ` [PATCH 2/3] parse-options: allow --end-of-options as a synonym for "--" Jeff King 2019-08-06 14:40 ` Jeff King [this message] 2019-08-06 16:24 ` [PATCH 0/3] --end-of-options marker Junio C Hamano 2019-08-06 16:36 ` Randall S. Becker 2019-08-06 17:38 ` Jeff King 2019-08-06 17:58 ` Randall S. Becker 2019-08-06 18:14 ` SZEDER Gábor 2019-08-08 10:03 ` Jeff King 2019-08-06 17:33 ` Jeff King 2019-08-06 22:58 ` brian m. carlson 2019-08-06 23:43 ` Jeff King 2019-08-07 4:17 ` brian m. carlson 2019-08-07 16:54 ` Taylor Blau 2019-08-08 10:28 ` Jeff King
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 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=20190806144030.GC2161@sigill.intra.peff.net \ --to=peff@peff.net \ --cc=git@vger.kernel.org \ /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) This inbox may be cloned and mirrored by anyone: 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 # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V1 git git/ https://public-inbox.org/git \ git@vger.kernel.org public-inbox-index 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.io/gmane.comp.version-control.git note: .onion URLs require Tor: https://www.torproject.org/ code repositories for the project(s) associated with this inbox: https://80x24.org/mirrors/git.git AGPL code for this site: git clone https://public-inbox.org/public-inbox.git