Go to file
Jeff King 9385174627 parse-options: decouple "--end-of-options" and "--"
When we added generic end-of-options support in 51b4594b40
(parse-options: allow --end-of-options as a synonym for "--",
2019-08-06), we made them true synonyms. They both stop option parsing,
and they are both returned in the resulting argv if the KEEP_DASHDASH
flag is used.

The hope was that this would work for all callers:

  - most generic callers would not pass KEEP_DASHDASH, and so would just
    do the right thing (stop parsing there) without needing to know
    anything more.

  - callers with KEEP_DASHDASH were generally going to rely on
    setup_revisions(), which knew to handle --end-of-options specially

But that turned out miss quite a few cases that pass KEEP_DASHDASH but
do their own manual parsing. For example, "git reset", "git checkout",
and so on want pass KEEP_DASHDASH so they can support:

  git reset $revs -- $paths

but of course aren't going to actually do a traversal, so they don't
call setup_revisions(). And those cases currently get confused by
--end-of-options being left in place, like:

   $ git reset --end-of-options HEAD
   fatal: option '--end-of-options' must come before non-option arguments

We could teach each of these callers to handle the leftover option
explicitly. But let's try to be a bit more clever and see if we can
solve it centrally in parse-options.c.

The bogus assumption here is that KEEP_DASHDASH tells us the caller
wants to see --end-of-options in the result. But really, the callers
which need to know that --end-of-options was reached are those that may
potentially parse more options from argv. In other words, those that
pass the KEEP_UNKNOWN_OPT flag.

If such a caller is aware of --end-of-options (e.g., because they call
setup_revisions() with the result), then this will continue to do the
right thing, treating anything after --end-of-options as a non-option.

And if the caller is not aware of --end-of-options, they are better off
keeping it intact, because either:

  1. They are just passing the options along to somebody else anyway, in
     which case that somebody would need to know about the
     --end-of-options marker.

  2. They are going to parse the remainder themselves, at which point
     choking on --end-of-options is much better than having it silently
     removed. The point is to avoid option injection from untrusted
     command line arguments, and bailing is better than quietly treating
     the untrusted argument as an option.

This fixes bugs with --end-of-options across several commands, but I've
focused on two in particular here:

  - t7102 confirms that "git reset --end-of-options --foo" now works.
    This checks two things. One, that we no longer barf on
    "--end-of-options" itself (which previously we did, even if the rev
    was something vanilla like "HEAD" instead of "--foo"). And two, that
    we correctly treat "--foo" as a revision rather than an option.

    This fix applies to any other cases which pass KEEP_DASHDASH but not
    KEEP_UNKNOWN_OPT, like "git checkout", "git check-attr", "git grep",
    etc, which would previously choke on "--end-of-options".

  - t9350 shows the opposite case: fast-export passed KEEP_UNKNOWN_OPT
    but not KEEP_DASHDASH, but then passed the result on to
    setup_revisions(). So it never saw --end-of-options, and would
    erroneously parse "fast-export --end-of-options --foo" as having a
    "--foo" option. This is now fixed.

Note that this does shut the door for callers which want to know if we
hit end-of-options, but don't otherwise need to keep unknown opts. The
obvious thing here is feeding it to the DWIM verify_filename()
machinery. And indeed, this is a problem even for commands which do
understand --end-of-options already. For example, without this patch,
you get:

  $ git log --end-of-options --foo
  fatal: option '--foo' must come before non-option arguments

because we refuse to accept "--foo" as a filename (because it starts
with a dash) even though we could know that we saw end-of-options. The
verify_filename() function simply doesn't accept this extra information.

So that is the status quo, and this patch doubles down further on that.
Commands like "git reset" have the same problem, but they won't even
know that parse-options saw --end-of-options! So even if we fixed
verify_filename(), they wouldn't have anything to pass to it.

But in practice I don't think this is a big deal. If you are being
careful enough to use --end-of-options, then you should also be using
"--" to disambiguate and avoid the DWIM behavior in the first place. In
other words, doing:

  git log --end-of-options --this-is-a-rev -- --this-is-a-path

works correctly, and will continue to do so. And likewise, with this
patch now:

  git reset --end-of-options --this-is-a-rev -- --this-is-a-path

will work, as well.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-12-09 08:21:02 +09:00
.github Sync with 2.36.6 2023-04-17 21:16:04 +02:00
Documentation Git 2.40.1 2023-04-17 21:16:10 +02:00
block-sha1
builtin Sync with 2.32.7 2023-04-17 21:15:52 +02:00
ci Sync with 2.36.6 2023-04-17 21:16:04 +02:00
compat Sync with 2.34.8 2023-04-17 21:15:59 +02:00
contrib cocci & cache.h: remove "USE_THE_INDEX_COMPATIBILITY_MACROS" 2023-02-10 11:38:40 -08:00
ewah
git-gui
gitk-git
gitweb
mergetools
negotiator
oss-fuzz
perl
po Merge branch 'fz/po-zh_CN' of github.com:fangyi-zhou/git-po 2023-03-10 22:50:14 +08:00
refs Merge branch 'ps/fsync-refs-fix' into maint-2.39 2023-02-14 14:15:50 -08:00
reftable
sha1collisiondetection@855827c583
sha1dc
sha256
t parse-options: decouple "--end-of-options" and "--" 2023-12-09 08:21:02 +09:00
templates
trace2
xdiff
.cirrus.yml
.clang-format
.editorconfig
.gitattributes .gitattributes: include `text` attribute for eol attributes 2023-02-06 13:57:08 -08:00
.gitignore add: remove "add.interactive.useBuiltin" & Perl "git add--interactive" 2023-02-06 15:03:34 -08:00
.gitmodules
.mailmap
.tsan-suppressions
CODE_OF_CONDUCT.md
COPYING
GIT-VERSION-GEN Git 2.40.1 2023-04-17 21:16:10 +02:00
INSTALL Sync with 2.31.8 2023-04-17 21:15:49 +02:00
LGPL-2.1
Makefile Sync with 2.36.6 2023-04-17 21:16:04 +02:00
README.md
RelNotes Git 2.40.1 2023-04-17 21:16:10 +02:00
SECURITY.md
abspath.c
aclocal.m4
add-interactive.c
add-interactive.h
add-patch.c
advice.c
advice.h
alias.c
alias.h
alloc.c
alloc.h
apply.c Sync with 2.39.3 2023-04-17 21:16:10 +02:00
apply.h
archive-tar.c
archive-zip.c
archive.c Merge branch 'rs/archive-mtime' 2023-02-27 10:08:57 -08:00
archive.h archive: add --mtime 2023-02-18 09:29:13 -08:00
attr.c
attr.h
banned.h
base85.c
bisect.c
bisect.h
blame.c
blame.h
blob.c
blob.h
bloom.c
bloom.h
branch.c
branch.h
builtin.h
bulk-checkin.c
bulk-checkin.h
bundle-uri.c Merge branch 'ds/bundle-uri-5' 2023-02-15 17:11:52 -08:00
bundle-uri.h clone: set fetch.bundleURI if appropriate 2023-01-31 08:57:48 -08:00
bundle.c Merge branch 'ab/various-leak-fixes' 2023-02-22 14:55:45 -08:00
bundle.h
cache-tree.c Merge branch 'rs/cache-tree-strbuf-growth-fix' 2023-02-22 14:55:44 -08:00
cache-tree.h cache-tree API: remove redundant update_main_cache_tree() 2023-02-10 11:38:14 -08:00
cache.h Merge branch 'ab/the-index-compatibility' 2023-02-22 14:55:44 -08:00
cbtree.c
cbtree.h
chdir-notify.c
chdir-notify.h
check-builtins.sh
checkout.c
checkout.h
chunk-format.c
chunk-format.h
color.c
color.h
column.c
column.h
combine-diff.c
command-list.txt
commit-graph.c
commit-graph.h
commit-reach.c
commit-reach.h
commit-slab-decl.h
commit-slab-impl.h
commit-slab.h
commit.c Merge branch 'rs/clear-commit-marks-cleanup' into maint-2.39 2023-02-14 14:15:56 -08:00
commit.h add API: remove run_add_interactive() wrapper function 2023-02-06 15:03:34 -08:00
common-main.c
config.c Sync with 2.39.3 2023-04-17 21:16:10 +02:00
config.h config.h: remove unused git_configset_add_parameters() 2023-02-07 10:50:27 -08:00
config.mak.dev
config.mak.in
config.mak.uname Merge branch 'hj/remove-msys-support' 2023-02-09 14:40:47 -08:00
configure.ac
connect.c
connect.h
connected.c
connected.h
convert.c
convert.h
copy.c
credential.c credential: new attribute password_expiry_utc 2023-02-22 15:18:58 -08:00
credential.h credential: new attribute password_expiry_utc 2023-02-22 15:18:58 -08:00
csum-file.c
csum-file.h
ctype.c
daemon.c
date.c
date.h
decorate.c
decorate.h
delta-islands.c delta-islands: fix segfault when freeing island marks 2023-02-21 09:15:04 -08:00
delta-islands.h delta-islands: free island_marks and bitmaps 2023-02-03 18:01:46 -08:00
delta.h
detect-compiler
diagnose.c
diagnose.h
diff-delta.c
diff-lib.c
diff-merges.c
diff-merges.h
diff-no-index.c
diff.c Merge branch 'jc/diff-algo-attribute' 2023-02-27 10:08:56 -08:00
diff.h Merge branch 'jc/diff-algo-attribute' 2023-02-27 10:08:56 -08:00
diffcore-break.c
diffcore-delta.c
diffcore-order.c
diffcore-pickaxe.c
diffcore-rename.c
diffcore-rotate.c
diffcore.h
dir-iterator.c dir-iterator: drop unused `DIR_ITERATOR_FOLLOW_SYMLINKS` 2023-02-16 16:21:56 -08:00
dir-iterator.h dir-iterator: drop unused `DIR_ITERATOR_FOLLOW_SYMLINKS` 2023-02-16 16:21:56 -08:00
dir.c Sync with 2.34.8 2023-04-17 21:15:59 +02:00
dir.h
editor.c
entry.c
entry.h
environment.c
environment.h
exec-cmd.c
exec-cmd.h
fetch-negotiator.c
fetch-negotiator.h
fetch-pack.c
fetch-pack.h
fmt-merge-msg.c
fmt-merge-msg.h
fsck.c
fsck.h
fsmonitor--daemon.h
fsmonitor-ipc.c
fsmonitor-ipc.h
fsmonitor-path-utils.h
fsmonitor-settings.c
fsmonitor-settings.h
fsmonitor.c
fsmonitor.h
generate-cmdlist.sh
generate-configlist.sh
generate-hooklist.sh
gettext.c Sync with 2.38.5 2023-04-17 21:16:08 +02:00
gettext.h Sync with 2.33.8 2023-04-17 21:15:56 +02:00
git-archimport.perl
git-compat-util.h Merge branch 'rs/use-enhanced-bre-on-macos' into maint-2.39 2023-02-14 14:15:49 -08:00
git-curl-compat.h http: support CURLOPT_PROTOCOLS_STR 2023-02-06 09:27:09 +01:00
git-cvsexportcommit.perl
git-cvsimport.perl
git-cvsserver.perl
git-difftool--helper.sh
git-filter-branch.sh
git-instaweb.sh
git-merge-octopus.sh
git-merge-one-file.sh
git-merge-resolve.sh
git-mergetool--lib.sh
git-mergetool.sh
git-p4.py
git-quiltimport.sh
git-request-pull.sh
git-send-email.perl
git-sh-i18n.sh
git-sh-setup.sh
git-submodule.sh
git-svn.perl
git-web--browse.sh
git.c trace.c, git.c: remove unnecessary parameter to trace_repo_setup() 2023-02-21 12:06:32 -08:00
git.rc
gpg-interface.c Merge branch 'js/gpg-errors' 2023-02-24 11:32:29 -08:00
gpg-interface.h
graph.c
graph.h
grep.c Merge branch 'ab/various-leak-fixes' 2023-02-22 14:55:45 -08:00
grep.h
hash-lookup.c
hash-lookup.h
hash.h
hashmap.c
hashmap.h
help.c
help.h
hex.c
hook.c hook API: support passing stdin to hooks, convert am's 'post-rewrite' 2023-02-08 12:50:03 -08:00
hook.h hook API: support passing stdin to hooks, convert am's 'post-rewrite' 2023-02-08 12:50:03 -08:00
http-backend.c http-backend.c: fix cmd_main() memory leak, refactor reg{exec,free}() 2023-02-06 15:34:38 -08:00
http-fetch.c
http-push.c Sync with 2.31.8 2023-04-17 21:15:49 +02:00
http-walker.c
http.c Sync with 2.34.8 2023-04-17 21:15:59 +02:00
http.h Sync with 2.30.9 2023-04-17 21:15:44 +02:00
ident.c
imap-send.c
iterator.h
json-writer.c
json-writer.h
khash.h
kwset.c
kwset.h
levenshtein.c
levenshtein.h
line-log.c
line-log.h
line-range.c
line-range.h
linear-assignment.c
linear-assignment.h
list-objects-filter-options.c
list-objects-filter-options.h
list-objects-filter.c Merge branch 'jk/unused-post-2.39' into maint-2.39 2023-02-14 14:15:55 -08:00
list-objects-filter.h
list-objects.c
list-objects.h
list.h
ll-merge.c
ll-merge.h
lockfile.c
lockfile.h
log-tree.c
log-tree.h
ls-refs.c
ls-refs.h
mailinfo.c
mailinfo.h
mailmap.c
mailmap.h
match-trees.c
mem-pool.c
mem-pool.h
merge-blobs.c
merge-blobs.h
merge-ort-wrappers.c
merge-ort-wrappers.h
merge-ort.c
merge-ort.h
merge-recursive.c
merge-recursive.h
merge.c
mergesort.h
midx.c
midx.h
name-hash.c
notes-cache.c
notes-cache.h
notes-merge.c
notes-merge.h
notes-utils.c
notes-utils.h
notes.c
notes.h
object-file.c Merge branch 'jk/hash-object-fsck' 2023-01-30 14:24:22 -08:00
object-name.c
object-store.h
object.c
object.h
oid-array.c
oid-array.h
oidmap.c
oidmap.h
oidset.c
oidset.h
oidtree.c
oidtree.h
pack-bitmap-write.c
pack-bitmap.c
pack-bitmap.h
pack-check.c
pack-mtimes.c
pack-mtimes.h
pack-objects.c
pack-objects.h
pack-revindex.c
pack-revindex.h
pack-write.c
pack.h
packfile.c
packfile.h
pager.c
parallel-checkout.c
parallel-checkout.h
parse-options-cb.c
parse-options.c parse-options: decouple "--end-of-options" and "--" 2023-12-09 08:21:02 +09:00
parse-options.h
patch-delta.c
patch-ids.c
patch-ids.h
path.c
path.h
pathspec.c docs & comments: replace mentions of "git-add--interactive.perl" 2023-02-06 15:03:34 -08:00
pathspec.h
pkt-line.c
pkt-line.h
preload-index.c
pretty.c
pretty.h
prio-queue.c
prio-queue.h
progress.c
progress.h
promisor-remote.c
promisor-remote.h
prompt.c
prompt.h
protocol-caps.c
protocol-caps.h
protocol.c
protocol.h
prune-packed.c
prune-packed.h
quote.c
quote.h
range-diff.c Sync with 2.31.8 2023-04-17 21:15:49 +02:00
range-diff.h
reachable.c
reachable.h
read-cache.c Merge branch 'rs/size-t-fixes' 2023-02-15 17:11:53 -08:00
rebase-interactive.c
rebase-interactive.h
rebase.c
rebase.h
ref-filter.c
ref-filter.h
reflog-walk.c
reflog-walk.h
reflog.c Merge branch 'rs/reflog-expiry-cleanup' into maint-2.39 2023-02-14 14:15:56 -08:00
reflog.h
refs.c Merge branch 'jk/shorten-unambiguous-ref-wo-sscanf' 2023-02-27 10:08:57 -08:00
refs.h
refspec.c
refspec.h
remote-curl.c Sync with 2.32.7 2023-04-17 21:15:52 +02:00
remote.c
remote.h
replace-object.c
replace-object.h
repo-settings.c
repository.c
repository.h
rerere.c
rerere.h
reset.c
reset.h
resolve-undo.c
resolve-undo.h
revision.c
revision.h
run-command.c run-command: allow stdin for run_processes_parallel 2023-02-08 12:50:03 -08:00
run-command.h
scalar.c scalar: only warn when background maintenance fails 2023-01-27 12:38:26 -08:00
send-pack.c
send-pack.h
sequencer.c Merge branch 'pw/rebase-i-parse-fix' 2023-02-28 16:38:47 -08:00
sequencer.h sequencer API users: fix get_replay_opts() leaks 2023-02-06 16:03:52 -08:00
serve.c
serve.h
server-info.c
setup.c
sh-i18n--envsubst.c
sha1dc_git.c
sha1dc_git.h
shallow.c
shallow.h
shared.mak
shell.c
shortlog.h
sideband.c
sideband.h
sigchain.c
sigchain.h
simple-ipc.h
sparse-index.c
sparse-index.h
split-index.c
split-index.h
stable-qsort.c
strbuf.c
strbuf.h
streaming.c
streaming.h
string-list.c
string-list.h
strmap.c
strmap.h
strvec.c
strvec.h
sub-process.c
sub-process.h
submodule-config.c
submodule-config.h
submodule.c
submodule.h
symlinks.c
tag.c
tag.h
tar.h
tempfile.c
tempfile.h
thread-utils.c
thread-utils.h
tmp-objdir.c
tmp-objdir.h
trace.c trace.c, git.c: remove unnecessary parameter to trace_repo_setup() 2023-02-21 12:06:32 -08:00
trace.h trace.c, git.c: remove unnecessary parameter to trace_repo_setup() 2023-02-21 12:06:32 -08:00
trace2.c
trace2.h
trailer.c
trailer.h
transport-helper.c
transport-internal.h
transport.c
transport.h
tree-diff.c
tree-walk.c
tree-walk.h
tree.c
tree.h
unicode-width.h
unimplemented.sh
unix-socket.c
unix-socket.h
unix-stream-server.c
unix-stream-server.h
unpack-trees.c
unpack-trees.h
upload-pack.c
upload-pack.h
url.c
url.h
urlmatch.c
urlmatch.h
usage.c
userdiff.c Merge branch 'jc/diff-algo-attribute' 2023-02-27 10:08:56 -08:00
userdiff.h diff: teach diff to read algorithm from diff driver 2023-02-21 09:29:10 -08:00
utf8.c
utf8.h
varint.c
varint.h
version.c
version.h
versioncmp.c
walker.c
walker.h
wildmatch.c
wildmatch.h
worktree.c
worktree.h
wrap-for-bin.sh
wrapper.c
write-or-die.c
ws.c
wt-status.c
wt-status.h
xdiff-interface.c
xdiff-interface.h
zlib.c

README.md

Build status

Git - fast, scalable, distributed revision control system

Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides both high-level operations and full access to internals.

Git is an Open Source project covered by the GNU General Public License version 2 (some parts of it are under different licenses, compatible with the GPLv2). It was originally written by Linus Torvalds with help of a group of hackers around the net.

Please read the file INSTALL for installation instructions.

Many Git online resources are accessible from https://git-scm.com/ including full documentation and Git related tools.

See Documentation/gittutorial.txt to get started, then see Documentation/giteveryday.txt for a useful minimum set of commands, and Documentation/git-<commandname>.txt for documentation of each command. If git has been correctly installed, then the tutorial can also be read with man gittutorial or git help tutorial, and the documentation of each command with man git-<commandname> or git help <commandname>.

CVS users may also want to read Documentation/gitcvs-migration.txt (man gitcvs-migration or git help cvs-migration if git is installed).

The user discussion and development of Git take place on the Git mailing list -- everyone is welcome to post bug reports, feature requests, comments and patches to git@vger.kernel.org (read Documentation/SubmittingPatches for instructions on patch submission and Documentation/CodingGuidelines).

Those wishing to help with error message, usage and informational message string translations (localization l10) should see po/README.md (a po file is a Portable Object file that holds the translations).

To subscribe to the list, send an email with just "subscribe git" in the body to majordomo@vger.kernel.org (not the Git list). The mailing list archives are available at https://lore.kernel.org/git/, http://marc.info/?l=git and other archival sites.

Issues which are security relevant should be disclosed privately to the Git Security mailing list git-security@googlegroups.com.

The maintainer frequently sends the "What's cooking" reports that list the current status of various development topics to the mailing list. The discussion following them give a good reference for project status, development direction and remaining tasks.

The name "git" was given by Linus Torvalds when he wrote the very first version. He described the tool as "the stupid content tracker" and the name as (depending on your mood):

  • random three-letter combination that is pronounceable, and not actually used by any common UNIX command. The fact that it is a mispronunciation of "get" may or may not be relevant.
  • stupid. contemptible and despicable. simple. Take your pick from the dictionary of slang.
  • "global information tracker": you're in a good mood, and it actually works for you. Angels sing, and a light suddenly fills the room.
  • "goddamn idiotic truckload of sh*t": when it breaks