Go to file
Ævar Arnfjörð Bjarmason b83efcecaf config API: add and use a "git_config_get()" family of functions
We already have the basic "git_config_get_value()" function and its
"repo_*" and "configset" siblings to get a given "key" and assign the
last key found to a provided "value".

But some callers don't care about that value, but just want to use the
return value of the "get_value()" function to check whether the key
exist (or another non-zero return value).

The immediate motivation for this is that a subsequent commit will
need to change all callers of the "*_get_value_multi()" family of
functions. In two cases here we (ab)used it to check whether we had
any values for the given key, but didn't care about the return value.

The rest of the callers here used various other config API functions
to do the same, all of which resolved to the same underlying functions
to provide the answer.

Some of these were using either git_config_get_string() or
git_config_get_string_tmp(), see fe4c750fb1 (submodule--helper: fix a
configure_added_submodule() leak, 2022-09-01) for a recent example. We
can now use a helper function that doesn't require a throwaway
variable.

We could have changed git_configset_get_value_multi() (and then
git_config_get_value() etc.) to accept a "NULL" as a "dest" for all
callers, but let's avoid changing the behavior of existing API
users. Having an "unused" value that we throw away internal to
config.c is cheap.

A "NULL as optional dest" pattern is also more fragile, as the intent
of the caller might be misinterpreted if he were to accidentally pass
"NULL", e.g. when "dest" is passed in from another function.

Another name for this function could have been
"*_config_key_exists()", as suggested in [1]. That would work for all
of these callers, and would currently be equivalent to this function,
as the git_configset_get_value() API normalizes all non-zero return
values to a "1".

But adding that API would set us up to lose information, as e.g. if
git_config_parse_key() in the underlying configset_find_element()
fails we'd like to return -1, not 1.

Let's change the underlying configset_find_element() function to
support this use-case, we'll make further use of it in a subsequent
commit where the git_configset_get_value_multi() function itself will
expose this new return value.

This still leaves various inconsistencies and clobbering or ignoring
of the return value in place. E.g here we're modifying
configset_add_value(), but ever since it was added in [2] we've been
ignoring its "int" return value, but as we're changing the
configset_find_element() it uses, let's have it faithfully ferry that
"ret" along.

Let's also use the "RESULT_MUST_BE_USED" macro introduced in [3] to
assert that we're checking the return value of
configset_find_element().

We're leaving the same change to configset_add_value() for some future
series. Once we start paying attention to its return value we'd need
to ferry it up as deep as do_config_from(), and would need to make
least read_{,very_}early_config() and git_protected_config() return an
"int" instead of "void". Let's leave that for now, and focus on
the *_get_*() functions.

1. 3c8687a73e (add `config_set` API for caching config-like files, 2014-07-28)
2. https://lore.kernel.org/git/xmqqczadkq9f.fsf@gitster.g/
3. 1e8697b5c4 (submodule--helper: check repo{_submodule,}_init()
   return values, 2022-09-01),

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-03-28 07:37:52 -07:00
.github ci: use a newer `github-script` version 2022-11-08 15:35:13 -05:00
Documentation Git 2.39-rc0 2022-11-23 11:22:25 +09:00
block-sha1
builtin config API: add and use a "git_config_get()" family of functions 2023-03-28 07:37:52 -07:00
ci Makefile & test-tool: replace "DC_SHA1" variable with a "define" 2022-11-07 22:11:51 -05:00
compat Merge branch 'sz/macos-fsmonitor-symlinks' 2022-11-23 11:22:25 +09:00
contrib Merge branch 'ab/coccicheck-incremental' 2022-11-23 11:22:23 +09:00
ewah
git-gui
gitk-git
gitweb
mergetools
negotiator negotiator/skipping: avoid stack overflow 2022-10-25 17:14:40 -07:00
oss-fuzz Merge branch 'ac/fuzzers' 2022-10-07 17:19:59 -07:00
perl Git.pm: trust rev-parse to find bare repositories 2022-10-22 16:39:48 -07:00
po l10n: zh_TW.po: Git 2.38.0, round 3 2022-10-01 19:10:41 +08:00
refs
reftable
sha1collisiondetection@855827c583
sha1dc
sha256
t config API: add and use a "git_config_get()" family of functions 2023-03-28 07:37:52 -07:00
templates
trace2 trace2: add global counter mechanism 2022-10-24 12:45:26 -07:00
xdiff
.cirrus.yml
.clang-format
.editorconfig
.gitattributes
.gitignore Merge branch 'ab/coccicheck-incremental' 2022-11-23 11:22:23 +09:00
.gitmodules
.mailmap
.tsan-suppressions
CODE_OF_CONDUCT.md
COPYING
GIT-VERSION-GEN Git 2.39-rc0 2022-11-23 11:22:25 +09:00
INSTALL INSTALL: remove discussion of SHA-1 backends 2022-11-07 22:11:51 -05:00
LGPL-2.1
Makefile Merge branch 'ab/coccicheck-incremental' 2022-11-23 11:22:23 +09:00
README.md
RelNotes Downmerge a handful of topics for 2.38.2 2022-10-25 17:11:39 -07:00
SECURITY.md
abspath.c
aclocal.m4
add-interactive.c use child_process members "args" and "env" directly 2022-10-30 14:04:40 -04:00
add-interactive.h
add-patch.c add -p: avoid ambiguous signed/unsigned comparison 2022-10-19 11:55:28 -07:00
advice.c
advice.h
alias.c alias.c: reject too-long cmdline strings in split_cmdline() 2022-10-01 00:23:38 -04:00
alias.h
alloc.c
alloc.h
apply.c Merge branch 'tb/cap-patch-at-1gb' 2022-10-30 21:04:43 -04:00
apply.h
archive-tar.c archive-tar: report filter start error only once 2022-10-30 19:50:43 -04:00
archive-zip.c
archive.c Merge branch 'rs/archive-dedup-printf' into maint-2.38 2022-10-27 15:24:14 -07:00
archive.h
attr.c attr: drop DEBUG_ATTR code 2022-10-06 09:59:17 -07:00
attr.h
banned.h
base85.c
bisect.c replace and remove run_command_v_opt() 2022-10-30 14:04:51 -04:00
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 bundle-uri: suppress stderr from remote-https 2022-10-12 09:13:25 -07:00
bundle-uri.h bundle-uri: fetch a list of bundles 2022-10-12 09:13:25 -07:00
bundle.c bundle-uri: quiet failed unbundlings 2022-10-12 09:13:25 -07:00
bundle.h Merge branch 'ds/bundle-uri-3' 2022-10-30 21:04:44 -04:00
cache-tree.c
cache-tree.h
cache.h
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 'pw/rebase-keep-base-fixes' 2022-10-30 21:04:42 -04:00
commit.h rebase: be stricter when reading state files containing oids 2022-10-17 11:53:00 -07:00
common-main.c
config.c config API: add and use a "git_config_get()" family of functions 2023-03-28 07:37:52 -07:00
config.h config API: add and use a "git_config_get()" family of functions 2023-03-28 07:37:52 -07:00
config.mak.dev config.mak.dev: disable suggest braces error on old clang versions 2022-10-10 11:15:31 -07:00
config.mak.in
config.mak.uname
configure.ac
connect.c
connect.h
connected.c receive-pack: only use visible refs for connectivity check 2022-11-17 16:22:52 -05:00
connected.h receive-pack: only use visible refs for connectivity check 2022-11-17 16:22:52 -05:00
convert.c convert: mark unused parameter in null stream filter 2022-10-17 21:24:04 -07:00
convert.h
copy.c
credential.c
credential.h
csum-file.c
csum-file.h
ctype.c
daemon.c
date.c date: mark unused parameters in handler functions 2022-10-17 21:24:04 -07:00
date.h
decorate.c
decorate.h
delta-islands.c delta-islands: free island-related data after use 2022-11-18 18:30:49 -05:00
delta-islands.h
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 'rs/no-more-run-command-v' 2022-11-08 17:15:12 -05:00
diff.h patch-id: use stable patch-id for rebases 2022-10-24 15:44:19 -07:00
diffcore-break.c
diffcore-delta.c
diffcore-order.c
diffcore-pickaxe.c diffcore-pickaxe: mark unused parameters in pickaxe functions 2022-10-17 21:24:04 -07:00
diffcore-rename.c
diffcore-rotate.c
diffcore.h
dir-iterator.c
dir-iterator.h
dir.c Merge branch 'rs/use-fspathncmp' into maint-2.38 2022-10-27 15:24:13 -07:00
dir.h
editor.c
entry.c
entry.h
environment.c
environment.h
exec-cmd.c mark unused parameters in trivial compat functions 2022-10-17 21:24:03 -07:00
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 fsck: document msg-id 2022-10-25 15:44:18 -07:00
fsmonitor--daemon.h fsmonitor: deal with synthetic firmlinks on macOS 2022-10-05 11:05:23 -07:00
fsmonitor-ipc.c replace and remove run_command_v_opt_tr2() 2022-10-30 14:04:48 -04:00
fsmonitor-ipc.h fsmonitor: relocate socket file if .git directory is remote 2022-10-05 11:05:22 -07:00
fsmonitor-path-utils.h fsmonitor: deal with synthetic firmlinks on macOS 2022-10-05 11:05:23 -07:00
fsmonitor-settings.c fsmonitor: check for compatability before communicating with fsmonitor 2022-10-05 11:05:23 -07:00
fsmonitor-settings.h fsmonitor: check for compatability before communicating with fsmonitor 2022-10-05 11:05:23 -07:00
fsmonitor.c fsmonitor: fix leak of warning message 2022-10-10 22:16:56 -07:00
fsmonitor.h
generate-cmdlist.sh
generate-configlist.sh
generate-hooklist.sh
gettext.c
gettext.h
git-add--interactive.perl
git-archimport.perl
git-bisect.sh bisect--helper: parse subcommand with OPT_SUBCOMMAND 2022-11-11 17:04:57 -05:00
git-compat-util.h Merge branch 'ab/unused-annotation' into maint-2.38 2022-10-27 15:24:12 -07: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-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 submodule--helper: drop "update --prefix <pfx>" for "-C <pfx> update" 2022-11-08 14:55:30 -05:00
git-svn.perl
git-web--browse.sh
git.c Merge branch 'ab/submodule-helper-prep-only' 2022-11-23 11:22:22 +09:00
git.rc
gpg-interface.c Merge branch 'pw/ssh-sign-report-errors' into maint-2.38 2022-10-25 17:11:35 -07:00
gpg-interface.h
graph.c
graph.h
grep.c Merge branch 'ab/grep-simplify-extended-expression' 2022-10-21 11:37:28 -07:00
grep.h Merge branch 'ab/grep-simplify-extended-expression' 2022-10-21 11:37:28 -07:00
hash-lookup.c
hash-lookup.h
hash.h
hashmap.c
hashmap.h
help.c Merge branch 'ab/doc-synopsis-and-cmd-usage' 2022-10-28 11:26:54 -07:00
help.h
hex.c
hook.c run-command API: have run_process_parallel() take an "opts" struct 2022-10-12 14:12:41 -07:00
hook.h
http-backend.c
http-fetch.c
http-push.c
http-walker.c
http.c http: redact curl h2h3 headers in info 2022-11-14 17:42:46 -05:00
http.h
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: initialize sub-filter structs 2022-09-22 12:43:04 -07:00
list-objects-filter-options.h
list-objects-filter.c
list-objects-filter.h
list-objects.c
list-objects.h
list.h
ll-merge.c Merge branch 'rs/no-more-run-command-v' 2022-11-08 17:15:12 -05:00
ll-merge.h
lockfile.c
lockfile.h
log-tree.c
log-tree.h
ls-refs.c refs: get rid of global list of hidden refs 2022-11-17 16:22:51 -05:00
ls-refs.h
mailinfo.c mailinfo -b: fix an out of bounds access 2022-10-03 09:05:07 -07:00
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 branch 'en/ort-dir-rename-and-symlink-fix' 2022-10-30 21:04:43 -04:00
merge-ort.h
merge-recursive.c
merge-recursive.h
merge.c use child_process members "args" and "env" directly 2022-10-30 14:04:40 -04:00
mergesort.h
midx.c Merge branch 'tb/midx-bitmap-selection-fix' 2022-10-27 14:51:52 -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 'jk/unused-anno-more' 2022-10-27 14:51:52 -07:00
object-name.c
object-store.h
object.c Merge branch 'jk/fsck-on-diet' into maint-2.38 2022-10-25 17:11:33 -07:00
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-write.c: instrument number of reused bitmaps 2022-10-13 13:35:08 -07:00
pack-bitmap.c Merge branch 'ds/bitmap-lookup-remove-tracing' 2022-09-26 21:46:51 -07:00
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.h
patch-delta.c
patch-ids.c Merge branch 'jz/patch-id' 2022-10-30 21:04:41 -04:00
patch-ids.h patch-id: use stable patch-id for rebases 2022-10-24 15:44:19 -07:00
path.c adjust_shared_perm(): leave g+s alone when the group does not matter 2022-10-28 14:55:27 -07:00
path.h
pathspec.c
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: die upon failing fetch 2022-10-05 11:06:53 -07:00
promisor-remote.h promisor-remote: remove a return value 2022-10-05 11:06:52 -07:00
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
range-diff.h
reachable.c
reachable.h
read-cache.c read-cache: avoid misaligned reads in index v4 2022-09-28 10:32:18 -07:00
rebase-interactive.c
rebase-interactive.h
rebase.c
rebase.h
ref-filter.c ref-filter: fix parsing of signatures with CRLF and no body 2022-11-02 21:36:04 -04:00
ref-filter.h
reflog-walk.c string-list: mark unused callback parameters 2022-10-17 21:24:04 -07:00
reflog-walk.h
reflog.c
reflog.h
refs.c refs: get rid of global list of hidden refs 2022-11-17 16:22:51 -05:00
refs.h refs: get rid of global list of hidden refs 2022-11-17 16:22:51 -05:00
refspec.c
refspec.h
remote-curl.c
remote.c
remote.h
replace-object.c
replace-object.h
repo-settings.c Merge branch 'es/mark-gc-cruft-as-experimental' 2022-11-08 17:14:48 -05:00
repository.c
repository.h Merge branch 'es/mark-gc-cruft-as-experimental' 2022-11-08 17:14:48 -05:00
rerere.c
rerere.h
reset.c rebase: use 'skip_cache_tree_update' option 2022-11-10 21:49:34 -05:00
reset.h
resolve-undo.c
resolve-undo.h
revision.c Merge branch 'ps/receive-use-only-advertised' 2022-11-23 11:22:25 +09:00
revision.h Merge branch 'ps/receive-use-only-advertised' 2022-11-23 11:22:25 +09:00
run-command.c Merge branch 'rs/no-more-run-command-v' 2022-11-08 17:15:12 -05:00
run-command.h Merge branch 'rs/no-more-run-command-v' 2022-11-08 17:15:12 -05:00
scalar.c Merge branch 'js/remove-stale-scalar-repos' 2022-11-23 11:22:23 +09:00
send-pack.c
send-pack.h
sequencer.c Merge branch 'pw/rebase-no-reflog-action' 2022-11-23 11:22:24 +09:00
sequencer.h sequencer: stop exporting GIT_REFLOG_ACTION 2022-11-09 18:15:43 -05:00
serve.c
serve.h
server-info.c
setup.c
sh-i18n--envsubst.c
sha1dc_git.c
sha1dc_git.h Makefile & test-tool: replace "DC_SHA1" variable with a "define" 2022-11-07 22:11:51 -05:00
shallow.c
shallow.h
shared.mak Makefile: don't create a ".build/.build/" for cocci, fix output 2022-11-11 17:21:45 -05:00
shell.c replace and remove run_command_v_opt() 2022-10-30 14:04:51 -04:00
shortlog.h shortlog: extract `shortlog_finish_setup()` 2022-10-24 14:48:05 -07:00
sideband.c
sideband.h
sigchain.c
sigchain.h
simple-ipc.h
sparse-index.c index: raise a bug if the index is materialised more than once 2022-11-04 20:28:28 -04:00
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: mark unused callback parameters 2022-10-17 21:24:04 -07:00
string-list.h string-list: document iterator behavior on NULL input 2022-09-27 09:32:26 -07:00
strmap.c
strmap.h
strvec.c
strvec.h
sub-process.c
sub-process.h
submodule-config.c run-command API: don't fall back on online_cpus() 2022-10-12 14:12:41 -07:00
submodule-config.h
submodule.c Merge branch 'jt/submodule-on-demand' 2022-11-23 11:22:25 +09:00
submodule.h submodule API & "absorbgitdirs": remove "----recursive" option 2022-11-08 14:55:30 -05:00
symlinks.c
tag.c
tag.h
tar.h
tempfile.c
tempfile.h
thread-utils.c
thread-utils.h
tmp-objdir.c tmp-objdir: skip clean up when handling a signal 2022-09-30 21:26:58 -07:00
tmp-objdir.h replace and remove run_command_v_opt_cd_env() 2022-10-30 14:04:47 -04:00
trace.c
trace.h
trace2.c trace2: add global counter mechanism 2022-10-24 12:45:26 -07:00
trace2.h trace2: add global counter mechanism 2022-10-24 12:45:26 -07:00
trailer.c
trailer.h
transport-helper.c
transport-internal.h
transport.c Merge branch 'ds/bundle-uri-3' 2022-10-30 21:04:44 -04:00
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: add 'skip_cache_tree_update' option 2022-11-10 21:49:34 -05:00
unpack-trees.h unpack-trees: add 'skip_cache_tree_update' option 2022-11-10 21:49:34 -05:00
upload-pack.c refs: get rid of global list of hidden refs 2022-11-17 16:22:51 -05:00
upload-pack.h
url.c
url.h
urlmatch.c
urlmatch.h
usage.c
userdiff.c
userdiff.h
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