Go to file
SZEDER Gábor fa83cc834d parse-options: add support for parsing subcommands
Several Git commands have subcommands to implement mutually exclusive
"operation modes", and they usually parse their subcommand argument
with a bunch of if-else if statements.

Teach parse-options to handle subcommands as well, which will result
in shorter and simpler code with consistent error handling and error
messages on unknown or missing subcommand, and it will also make
possible for our Bash completion script to handle subcommands
programmatically.

The approach is guided by the following observations:

  - Most subcommands [1] are implemented in dedicated functions, and
    most of those functions [2] either have a signature matching the
    'int cmd_foo(int argc, const char **argc, const char *prefix)'
    signature of builtin commands or can be trivially converted to
    that signature, because they miss only that last prefix parameter
    or have no parameters at all.

  - Subcommand arguments only have long form, and they have no double
    dash prefix, no negated form, and no description, and they don't
    take any arguments, and can't be abbreviated.

  - There must be exactly one subcommand among the arguments, or zero
    if the command has a default operation mode.

  - All arguments following the subcommand are considered to be
    arguments of the subcommand, and, conversely, arguments meant for
    the subcommand may not preceed the subcommand.

So in the end subcommand declaration and parsing would look something
like this:

    parse_opt_subcommand_fn *fn = NULL;
    struct option builtin_commit_graph_options[] = {
        OPT_STRING(0, "object-dir", &opts.obj_dir, N_("dir"),
                   N_("the object directory to store the graph")),
        OPT_SUBCOMMAND("verify", &fn, graph_verify),
        OPT_SUBCOMMAND("write", &fn, graph_write),
        OPT_END(),
    };
    argc = parse_options(argc, argv, prefix, options,
                         builtin_commit_graph_usage, 0);
    return fn(argc, argv, prefix);

Here each OPT_SUBCOMMAND specifies the name of the subcommand and the
function implementing it, and the address of the same 'fn' subcommand
function pointer.  parse_options() then processes the arguments until
it finds the first argument matching one of the subcommands, sets 'fn'
to the function associated with that subcommand, and returns, leaving
the rest of the arguments unprocessed.  If none of the listed
subcommands is found among the arguments, parse_options() will show
usage and abort.

If a command has a default operation mode, 'fn' should be initialized
to the function implementing that mode, and parse_options() should be
invoked with the PARSE_OPT_SUBCOMMAND_OPTIONAL flag.  In this case
parse_options() won't error out when not finding any subcommands, but
will return leaving 'fn' unchanged.  Note that if that default
operation mode has any --options, then the PARSE_OPT_KEEP_UNKNOWN_OPT
flag is necessary as well (otherwise parse_options() would error out
upon seeing the unknown option meant to the default operation mode).

Some thoughts about the implementation:

  - The same pointer to 'fn' must be specified as 'value' for each
    OPT_SUBCOMMAND, because there can be only one set of mutually
    exclusive subcommands; parse_options() will BUG() otherwise.

    There are other ways to tell parse_options() where to put the
    function associated with the subcommand given on the command line,
    but I didn't like them:

      - Change parse_options()'s signature by adding a pointer to
        subcommand function to be set to the function associated with
        the given subcommand, affecting all callsites, even those that
        don't have subcommands.

      - Introduce a specific parse_options_and_subcommand() variant
        with that extra funcion parameter.

  - I decided against automatically calling the subcommand function
    from within parse_options(), because:

      - There are commands that have to perform additional actions
        after option parsing but before calling the function
        implementing the specified subcommand.

      - The return code of the subcommand is usually the return code
        of the git command, but preserving the return code of the
        automatically called subcommand function would have made the
        API awkward.

  - Also add a OPT_SUBCOMMAND_F() variant to allow specifying an
    option flag: we have two subcommands that are purposefully
    excluded from completion ('git remote rm' and 'git stash save'),
    so they'll have to be specified with the PARSE_OPT_NOCOMPLETE
    flag.

  - Some of the 'parse_opt_flags' don't make sense with subcommands,
    and using them is probably just an oversight or misunderstanding.
    Therefore parse_options() will BUG() when invoked with any of the
    following flags while the options array contains at least one
    OPT_SUBCOMMAND:

      - PARSE_OPT_KEEP_DASHDASH: parse_options() stops parsing
        arguments when encountering a "--" argument, so it doesn't
        make sense to expect and keep one before a subcommand, because
        it would prevent the parsing of the subcommand.

        However, this flag is allowed in combination with the
        PARSE_OPT_SUBCOMMAND_OPTIONAL flag, because the double dash
        might be meaningful for the command's default operation mode,
        e.g. to disambiguate refs and pathspecs.

      - PARSE_OPT_STOP_AT_NON_OPTION: As its name suggests, this flag
        tells parse_options() to stop as soon as it encouners a
        non-option argument, but subcommands are by definition not
        options...  so how could they be parsed, then?!

      - PARSE_OPT_KEEP_UNKNOWN: This flag can be used to collect any
        unknown --options and then pass them to a different command or
        subsystem.  Surely if a command has subcommands, then this
        functionality should rather be delegated to one of those
        subcommands, and not performed by the command itself.

        However, this flag is allowed in combination with the
        PARSE_OPT_SUBCOMMAND_OPTIONAL flag, making possible to pass
        --options to the default operation mode.

  - If the command with subcommands has a default operation mode, then
    all arguments to the command must preceed the arguments of the
    subcommand.

    AFAICT we don't have any commands where this makes a difference,
    because in those commands either only the command accepts any
    arguments ('notes' and 'remote'), or only the default subcommand
    ('reflog' and 'stash'), but never both.

  - The 'argv' array passed to subcommand functions currently starts
    with the name of the subcommand.  Keep this behavior.  AFAICT no
    subcommand functions depend on the actual content of 'argv[0]',
    but the parse_options() call handling their options expects that
    the options start at argv[1].

  - To support handling subcommands programmatically in our Bash
    completion script, 'git cmd --git-completion-helper' will now list
    both subcommands and regular --options, if any.  This means that
    the completion script will have to separate subcommands (i.e.
    words without a double dash prefix) from --options on its own, but
    that's rather easy to do, and it's not much work either, because
    the number of subcommands a command might have is rather low, and
    those commands accept only a single --option or none at all.  An
    alternative would be to introduce a separate option that lists
    only subcommands, but then the completion script would need not
    one but two git invocations and command substitutions for commands
    with subcommands.

    Note that this change doesn't affect the behavior of our Bash
    completion script, because when completing the --option of a
    command with subcommands, e.g. for 'git notes --<TAB>', then all
    subcommands will be filtered out anyway, as none of them will
    match the word to be completed starting with that double dash
    prefix.

[1] Except 'git rerere', because many of its subcommands are
    implemented in the bodies of the if-else if statements parsing the
    command's subcommand argument.

[2] Except 'credential', 'credential-store' and 'fsmonitor--daemon',
    because some of the functions implementing their subcommands take
    special parameters.

Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-08-19 11:13:14 -07:00
.github ci(github): bring back the 'print test failures' step 2022-06-08 16:12:37 -07:00
Documentation parse-options: add support for parsing subcommands 2022-08-19 11:13:14 -07:00
block-sha1
builtin parse-options: add support for parsing subcommands 2022-08-19 11:13:14 -07:00
ci Merge branch 'js/ci-github-workflow-markup' 2022-06-17 10:33:32 -07:00
compat Merge branch 'rs/mingw-tighten-mkstemp' 2022-07-22 15:04:03 -07:00
contrib Merge branch 'rs/cocci-array-copy' 2022-07-19 16:40:18 -07:00
ewah Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
git-gui
gitk-git Merge branch 'master' of git://git.ozlabs.org/~paulus/gitk 2022-05-11 08:25:02 -07:00
gitweb Merge branch 'ab/build-gitweb' 2022-07-18 13:31:55 -07:00
mergetools Merge branch 'js/vimdiff-quotepath-fix' 2022-07-22 15:04:02 -07:00
negotiator
perl
po l10n: sv.po: Update Swedish translation (5367t0f0u) 2022-06-26 20:38:46 +08:00
ppc
refs Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
reftable Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
sha1collisiondetection@855827c583
sha1dc
sha256 sha256: add support for Nettle 2022-07-10 14:43:34 -07:00
t parse-options: add support for parsing subcommands 2022-08-19 11:13:14 -07:00
templates fsmonitor: query watchman with right valid json 2022-06-07 10:00:49 -07:00
trace2
xdiff Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
.cirrus.yml ci: update Cirrus-CI image to FreeBSD 12.3 2022-05-25 08:47:11 -07:00
.clang-format
.editorconfig
.gitattributes
.gitignore Makefile & .gitignore: ignore & clean "git.res", not "*.res" 2022-07-06 12:24:43 -07:00
.gitmodules
.mailmap
.tsan-suppressions
CODE_OF_CONDUCT.md
COPYING
GIT-VERSION-GEN Git 2.37.1 2022-07-04 13:45:08 -07:00
INSTALL
LGPL-2.1
Makefile Merge branch 'bc/nettle-sha256' 2022-07-18 13:31:58 -07:00
README.md
RelNotes Git 2.37.1 2022-07-04 13:45:08 -07:00
SECURITY.md
abspath.c
aclocal.m4
add-interactive.c Merge 'js/add-i-delete' into maint-2.37 2022-07-04 13:40:59 -07:00
add-interactive.h
add-patch.c run-command API: rename "env_array" to "env" 2022-06-02 14:31:16 -07:00
advice.c Merge branch 'tk/ambiguous-fetch-refspec' 2022-04-04 10:56:24 -07:00
advice.h Merge branch 'tk/ambiguous-fetch-refspec' 2022-04-04 10:56:24 -07:00
alias.c
alias.h
alloc.c alloc.[ch]: remove alloc_report() function 2022-04-01 10:16:11 -07:00
alloc.h alloc.[ch]: remove alloc_report() function 2022-04-01 10:16:11 -07:00
apply.c Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
apply.h
archive-tar.c archive-tar: use internal gzip by default 2022-06-15 13:19:47 -07:00
archive-zip.c
archive.c archive --add-virtual-file: allow paths containing colons 2022-05-30 23:07:31 -07:00
archive.h archive: rename archiver data field to filter_command 2022-06-15 13:19:46 -07:00
attr.c Merge branch 'ab/refs-various-fixes' 2022-03-29 12:22:02 -07:00
attr.h
banned.h
base85.c
bisect.c revisions API users: use release_revisions() needing REV_INFO_INIT 2022-04-13 23:56:08 -07:00
bisect.h bisect: output state before we are ready to compute bisection 2022-05-11 12:35:11 -07:00
blame.c Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
blame.h
blob.c
blob.h
bloom.c
bloom.h
branch.c Merge branch 'ds/branch-checked-out' 2022-07-11 15:38:51 -07:00
branch.h Merge branch 'ds/branch-checked-out' 2022-07-11 15:38:51 -07:00
builtin.h fsmonitor--daemon: add a built-in fsmonitor daemon 2022-03-25 16:04:15 -07:00
bulk-checkin.c Merge branch 'tb/cruft-packs' 2022-06-03 14:30:37 -07:00
bulk-checkin.h core.fsyncmethod: batched disk flushes for loose-objects 2022-04-06 13:13:01 -07:00
bundle.c Merge branch 'ab/plug-leak-in-revisions' 2022-06-07 14:10:56 -07:00
bundle.h bundle.h: make "fd" version of read_bundle_header() public 2022-05-16 15:02:10 -07:00
cache-tree.c cache-tree: remove cache_tree_find_path() 2022-06-16 11:59:56 -07:00
cache-tree.h cache-tree: remove cache_tree_find_path() 2022-06-16 11:59:56 -07:00
cache.h Merge branch 'ds/midx-normalize-pathname-before-comparison' into maint 2022-06-08 14:27:53 -07:00
cbtree.c
cbtree.h
chdir-notify.c
chdir-notify.h
check-builtins.sh
checkout.c
checkout.h
chunk-format.c chunk-format.h: extract oid_version() 2022-05-26 15:48:26 -07:00
chunk-format.h chunk-format.h: extract oid_version() 2022-05-26 15:48:26 -07:00
color.c
color.h
column.c
column.h
combine-diff.c Merge branch 'rs/combine-diff-with-incompatible-options' 2022-07-11 15:38:48 -07:00
command-list.txt
commit-graph.c Merge branch 'hx/lookup-commit-in-graph-fix' 2022-07-19 16:40:16 -07:00
commit-graph.h
commit-reach.c
commit-reach.h
commit-slab-decl.h
commit-slab-impl.h
commit-slab.h
commit.c i18n: fix mismatched camelCase config variables 2022-06-17 10:38:26 -07:00
commit.h
common-main.c usage.c: add a non-fatal bug() function to go with BUG() 2022-06-02 12:51:35 -07:00
config.c config: learn `git_protected_config()` 2022-07-14 15:08:29 -07:00
config.h config: learn `git_protected_config()` 2022-07-14 15:08:29 -07:00
config.mak.dev Revert -Wno-error=dangling-pointer 2022-06-01 08:49:13 -07:00
config.mak.in
config.mak.uname Merge branch 'jh/builtin-fsmonitor-part3' 2022-06-10 15:04:15 -07:00
configure.ac Merge branch 'ab/misc-cleanup' 2022-05-10 17:41:10 -07:00
connect.c Merge branch 'ab/env-array' 2022-06-10 15:04:13 -07:00
connect.h
connected.c run-command API: rename "env_array" to "env" 2022-06-02 14:31:16 -07:00
connected.h
convert.c convert: clarify line ending conversion warning 2022-04-08 12:53:34 -07:00
convert.h
copy.c
credential.c
credential.h
csum-file.c
csum-file.h
ctype.c
daemon.c Merge branch 'ab/env-array' 2022-06-10 15:04:13 -07:00
date.c
date.h
decorate.c
decorate.h
delta-islands.c
delta-islands.h
delta.h
detect-compiler detect-compiler: make detection independent of locale 2022-05-09 08:52:26 -07:00
diff-delta.c
diff-lib.c revisions API: add a TODO for diff_free(&revs->diffopt) 2022-04-13 23:56:10 -07:00
diff-merges.c
diff-merges.h
diff-no-index.c
diff.c parse-options: PARSE_OPT_KEEP_UNKNOWN only applies to --options 2022-08-19 11:13:14 -07:00
diff.h
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.h
dir.c Merge branch 'gg/worktree-from-the-above' 2022-07-14 15:03:58 -07:00
dir.h dir API: add a generalized path_match_flags() function 2022-05-16 15:02:09 -07:00
editor.c run-command API: rename "env_array" to "env" 2022-06-02 14:31:16 -07:00
entry.c
entry.h
environment.c Merge branch 'ds/midx-normalize-pathname-before-comparison' into maint 2022-06-08 14:27:53 -07:00
environment.h
exec-cmd.c
exec-cmd.h
fetch-negotiator.c fetch-negotiator: add specific noop initializer 2022-03-28 10:25:52 -07:00
fetch-negotiator.h fetch-negotiator: add specific noop initializer 2022-03-28 10:25:52 -07:00
fetch-pack.c Merge branch 'ds/bundle-uri' 2022-06-03 14:30:34 -07:00
fetch-pack.h fetch-pack: add refetch 2022-03-28 10:25:52 -07:00
fmt-merge-msg.c revisions API users: add straightforward release_revisions() 2022-04-13 23:56:08 -07:00
fmt-merge-msg.h
fsck.c dir API: add a generalized path_match_flags() function 2022-05-16 15:02:09 -07:00
fsck.h
fsmonitor--daemon.h fsmonitor--daemon: stub in health thread 2022-05-26 15:59:27 -07:00
fsmonitor-ipc.c fsmonitor-ipc: create client routines for git-fsmonitor--daemon 2022-03-25 16:04:15 -07:00
fsmonitor-ipc.h fsmonitor-ipc: create client routines for git-fsmonitor--daemon 2022-03-25 16:04:15 -07:00
fsmonitor-settings.c fsmonitor: avoid memory leak in `fsm_settings__get_incompatible_msg()` 2022-06-16 13:22:03 -07:00
fsmonitor-settings.h fsmonitor-settings: NTFS and FAT32 on MacOS are incompatible 2022-05-26 15:59:26 -07:00
fsmonitor.c fsmonitor: never set CE_FSMONITOR_VALID on submodules 2022-05-26 15:59:27 -07:00
fsmonitor.h fsmonitor: never set CE_FSMONITOR_VALID on submodules 2022-05-26 15:59:27 -07:00
fuzz-commit-graph.c
fuzz-pack-headers.c
fuzz-pack-idx.c
generate-cmdlist.sh
generate-configlist.sh
generate-hooklist.sh
gettext.c
gettext.h
git-add--interactive.perl
git-archimport.perl
git-bisect.sh
git-compat-util.h Sync with 2.35.4 2022-06-23 12:36:12 +02:00
git-curl-compat.h
git-cvsexportcommit.perl
git-cvsimport.perl
git-cvsserver.perl
git-difftool--helper.sh
git-filter-branch.sh
git-instaweb.sh git-sh-setup.sh: remove "say" function, change last users 2022-06-28 13:13:18 -07:00
git-merge-octopus.sh
git-merge-one-file.sh
git-merge-resolve.sh
git-mergetool--lib.sh vimdiff: add tool documentation 2022-04-03 15:09:52 -07:00
git-mergetool.sh
git-p4.py Merge branch 'tk/p4-metadata-coding-strategies' 2022-05-20 15:27:00 -07:00
git-quiltimport.sh
git-request-pull.sh
git-send-email.perl i18n: fix some badly formatted i18n strings 2022-04-11 14:13:46 -07:00
git-sh-i18n.sh
git-sh-setup.sh git-sh-setup.sh: remove "say" function, change last users 2022-06-28 13:13:18 -07:00
git-submodule.sh git-submodule.sh: use "$quiet", not "$GIT_QUIET" 2022-06-28 13:13:18 -07:00
git-svn.perl
git-web--browse.sh
git.c git.c: update NO_PARSEOPT markings 2022-08-19 11:13:13 -07:00
git.rc
gpg-interface.c gpg-interface: add function for converting trust level to string 2022-07-10 22:10:23 -07:00
gpg-interface.h gpg-interface: add function for converting trust level to string 2022-07-10 22:10:23 -07:00
graph.c
graph.h
grep.c grep: add --max-count command line option 2022-06-22 13:23:29 -07:00
grep.h grep: add --max-count command line option 2022-06-22 13:23:29 -07:00
hash-lookup.c
hash-lookup.h
hash.h sha256: add support for Nettle 2022-07-10 14:43:34 -07:00
hashmap.c
hashmap.h
help.c Merge branch 'jh/builtin-fsmonitor-part2' 2022-04-04 10:56:24 -07:00
help.h
hex.c
hook.c Merge branch 'ab/hooks-regression-fix' 2022-06-13 15:53:41 -07:00
hook.h
http-backend.c run-command API: rename "env_array" to "env" 2022-06-02 14:31:16 -07:00
http-fetch.c Merge branch 'ep/maint-equals-null-cocci' for maint-2.35 2022-05-02 10:06:04 -07:00
http-push.c Merge branch 'ab/plug-leak-in-revisions' 2022-06-07 14:10:56 -07:00
http-walker.c tree-wide: apply equals-null.cocci 2022-05-02 09:50:37 -07:00
http.c Merge branch 'll/curl-accept-language' 2022-07-19 16:40:19 -07:00
http.h remote-curl: send Accept-Language header to server 2022-07-11 12:24:28 -07:00
ident.c
imap-send.c Merge branch 'bc/csprng-mktemps' 2022-04-06 15:21:59 -07:00
iterator.h
json-writer.c
json-writer.h
khash.h
kwset.c tree-wide: apply equals-null.cocci 2022-05-02 09:50:37 -07:00
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 pack-objects: lazily set up "struct rev_info", don't leak 2022-03-28 09:57:21 -07:00
list-objects-filter-options.h pack-objects: lazily set up "struct rev_info", don't leak 2022-03-28 09:57:21 -07:00
list-objects-filter.c
list-objects-filter.h
list-objects.c
list-objects.h
list.h
ll-merge.c Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
ll-merge.h
lockfile.c
lockfile.h
log-tree.c Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
log-tree.h
ls-refs.c
ls-refs.h
mailinfo.c tree-wide: apply equals-null.cocci 2022-05-02 09:50:37 -07:00
mailinfo.h
mailmap.c Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
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 branch 'en/merge-dual-dir-renames-fix' 2022-07-18 13:31:56 -07:00
merge-ort.h merge-ort: optionally produce machine-readable output 2022-06-22 16:10:06 -07:00
merge-recursive.c Merge branch 'ab/plug-leak-in-revisions' 2022-06-07 14:10:56 -07:00
merge-recursive.h
merge.c
mergesort.c
mergesort.h
midx.c Merge branch 'ds/midx-normalize-pathname-before-comparison' into maint 2022-06-08 14:27:53 -07:00
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 'hx/unpack-streaming' 2022-07-14 15:03:59 -07:00
object-name.c object-name: diagnose trees in index properly 2022-04-26 13:56:39 -07:00
object-store.h object-file.c: add "stream_loose_object()" to handle large object 2022-06-13 10:22:35 -07:00
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 Merge branch 'ab/plug-leak-in-revisions' 2022-06-07 14:10:56 -07:00
pack-bitmap.c Merge branch 'tb/midx-race-in-pack-objects' 2022-06-03 14:30:35 -07:00
pack-bitmap.h
pack-check.c
pack-mtimes.c pack-mtimes: avoid closing a bogus file descriptor 2022-06-16 13:22:03 -07:00
pack-mtimes.h pack-mtimes: support reading .mtimes files 2022-05-26 15:48:26 -07:00
pack-objects.c pack-mtimes: support writing pack .mtimes files 2022-05-26 15:48:26 -07:00
pack-objects.h pack-objects.h: remove outdated pahole results 2022-06-28 15:39:03 -07:00
pack-revindex.c
pack-revindex.h
pack-write.c pack-write: drop always-NULL parameter 2022-06-16 11:59:55 -07:00
pack.h pack-mtimes: support writing pack .mtimes files 2022-05-26 15:48:26 -07:00
packfile.c Merge branch 'jk/optim-promisor-object-enumeration' 2022-07-11 15:38:50 -07:00
packfile.h
pager.c run-command API: rename "env_array" to "env" 2022-06-02 14:31:16 -07:00
parallel-checkout.c
parallel-checkout.h
parse-options-cb.c
parse-options.c parse-options: add support for parsing subcommands 2022-08-19 11:13:14 -07:00
parse-options.h parse-options: add support for parsing subcommands 2022-08-19 11:13:14 -07:00
patch-delta.c
patch-ids.c
patch-ids.h
path.c Merge branch 'ds/bundle-uri' 2022-06-03 14:30:34 -07:00
path.h
pathspec.c Merge branch 'jc/all-negative-pathspec' 2022-06-07 14:10:59 -07:00
pathspec.h
pkt-line.c
pkt-line.h
preload-index.c
pretty.c gpg-interface: add function for converting trust level to string 2022-07-10 22:10:23 -07:00
pretty.h
prio-queue.c tree-wide: apply equals-null.cocci 2022-05-02 09:50:37 -07:00
prio-queue.h
progress.c
progress.h
promisor-remote.c Merge branch 'ab/env-array' 2022-06-10 15:04:13 -07:00
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 Merge branch 'pb/range-diff-with-submodule' 2022-06-13 15:53:41 -07:00
range-diff.h
reachable.c reachable: report precise timestamps from objects in cruft packs 2022-05-26 15:48:26 -07:00
reachable.h builtin/pack-objects.c: --cruft with expiration 2022-05-26 15:48:26 -07:00
read-cache.c read_index_from(): avoid memory leak 2022-06-16 13:22:03 -07:00
rebase-interactive.c
rebase-interactive.h
rebase.c
rebase.h
ref-filter.c ref-filter: disable save_commit_buffer while traversing 2022-07-11 14:27:31 -07:00
ref-filter.h
reflog-walk.c revisions API: release "reflog_info" in release revisions() 2022-04-13 23:56:10 -07:00
reflog-walk.h revisions API: release "reflog_info" in release revisions() 2022-04-13 23:56:10 -07:00
reflog.c Merge branch 'ab/reflog-parse-options' 2022-04-04 10:56:21 -07:00
reflog.h
refs.c clone: die() instead of BUG() on bad refs 2022-04-25 11:05:28 -07:00
refs.h Revert "Merge branch 'ps/avoid-unnecessary-hook-invocation-with-packed-refs'" 2022-04-13 15:51:33 -07:00
refspec.c
refspec.h
remote-curl.c remote-curl: send Accept-Language header to server 2022-07-11 12:24:28 -07:00
remote.c Merge branch 'jk/remote-show-with-negative-refspecs' 2022-07-13 14:54:54 -07:00
remote.h remote: handle negative refspecs in git remote show 2022-06-17 10:03:59 -07:00
replace-object.c
replace-object.h
repo-settings.c compat/fsmonitor/fsm-listen-win32: stub in backend for Windows 2022-03-25 16:04:15 -07:00
repository.c
repository.h Merge branch 'jh/builtin-fsmonitor-part2' 2022-04-04 10:56:24 -07:00
rerere.c Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
rerere.h
reset.c
reset.h
resolve-undo.c
resolve-undo.h
revision.c Merge branch 'jc/resolve-undo' 2022-07-19 16:40:16 -07:00
revision.h Merge branch 'ab/plug-leak-in-revisions' 2022-06-07 14:10:56 -07:00
run-command.c Merge branch 'js/wait-or-whine-can-fail' 2022-06-13 15:53:44 -07:00
run-command.h Merge branch 'ab/hooks-regression-fix' 2022-06-13 15:53:41 -07:00
send-pack.c send-pack.c: add config push.useBitmaps 2022-06-17 14:31:01 -07:00
send-pack.h send-pack.c: add config push.useBitmaps 2022-06-17 14:31:01 -07:00
sequencer.c Merge branch 'jc/revert-show-parent-info' 2022-06-15 15:09:27 -07:00
sequencer.h revert: optionally refer to commit in the "reference" format 2022-05-26 23:05:03 -07:00
serve.c serve.c: remove unnecessary include 2022-04-06 09:42:12 -07:00
serve.h
server-info.c
setup.c setup.c: create `safe.bareRepository` 2022-07-14 15:08:29 -07:00
sh-i18n--envsubst.c tree-wide: apply equals-null.cocci 2022-05-02 09:50:37 -07:00
sha1dc_git.c
sha1dc_git.h
shallow.c Merge branch 'jt/unparse-commit-upon-graft-change' 2022-06-13 15:53:42 -07:00
shallow.h
shared.mak cocci: add a "coccicheck-test" target and test *.cocci rules 2022-07-06 12:24:43 -07:00
shell.c
shortlog.h
sideband.c
sideband.h
sigchain.c
sigchain.h
simple-ipc.h
sparse-index.c Merge branch 'ds/sparse-sparse-checkout' 2022-06-03 14:30:35 -07:00
sparse-index.h Merge branch 'ds/sparse-sparse-checkout' 2022-06-03 14:30:35 -07:00
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 i18n: fix mismatched camelCase config variables 2022-06-17 10:38:26 -07:00
submodule-config.h Merge branch 'pb/submodule-recurse-mode-enum' 2022-05-20 15:26:53 -07:00
submodule.c Merge branch 'ab/leakfix' 2022-07-18 13:31:54 -07:00
submodule.h Merge branch 'ab/env-array' 2022-06-10 15:04:13 -07:00
symlinks.c
tag.c
tag.h
tar.h
tempfile.c tempfile: add mks_tempfile_dt() 2022-04-20 16:17:33 -07:00
tempfile.h tempfile: add mks_tempfile_dt() 2022-04-20 16:17:33 -07:00
thread-utils.c
thread-utils.h
tmp-objdir.c
tmp-objdir.h
trace.c
trace.h
trace2.c common-main.c: move non-trace2 exit() behavior out of trace2.c 2022-06-02 12:51:30 -07:00
trace2.h common-main.c: move non-trace2 exit() behavior out of trace2.c 2022-06-02 12:51:30 -07:00
trailer.c Merge branch 'ab/env-array' 2022-06-10 15:04:13 -07:00
trailer.h
transport-helper.c run-command API: rename "env_array" to "env" 2022-06-02 14:31:16 -07:00
transport-internal.h
transport.c Merge branch 'fh/transport-push-leakfix' 2022-06-07 14:10:57 -07:00
transport.h push: new config option "push.autoSetupRemote" supports "simple" push 2022-04-29 11:20:55 -07:00
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 Merge branch 'jh/builtin-fsmonitor-part3' 2022-06-10 15:04:15 -07:00
unpack-trees.h
upload-pack.c config: learn `git_protected_config()` 2022-07-14 15:08:29 -07:00
upload-pack.h
url.c
url.h
urlmatch.c
urlmatch.h
usage.c i18n: mark message helpers prefix for translation 2022-06-21 10:06:54 -07:00
userdiff.c Merge branch 'jd/userdiff-kotlin' 2022-03-23 14:09:29 -07:00
userdiff.h
utf8.c
utf8.h
varint.c
varint.h
version.c
version.h
versioncmp.c
walker.c
walker.h
wildmatch.c tree-wide: apply equals-null.cocci 2022-05-02 09:50:37 -07:00
wildmatch.h
worktree.c Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
worktree.h
wrap-for-bin.sh
wrapper.c Merge branch 'ep/maint-equals-null-cocci' 2022-05-20 15:26:59 -07:00
write-or-die.c
ws.c
wt-status.c Merge branch 'ab/env-array' 2022-06-10 15:04:13 -07:00
wt-status.h
xdiff-interface.c Merge branch 'ep/maint-equals-null-cocci' for maint-2.35 2022-05-02 10:06:04 -07:00
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