summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorMartin Ågren <martin.agren@gmail.com>2017-08-07 18:20:49 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-08-07 20:29:22 (GMT)
commit8957661378b073b49875059d6426614facb0d7f0 (patch)
treed0ab9bbeb05fc9687b9823876bc1322fd2b35453 /Documentation
parent4666741823239ed45ce9a63914dfd3c1601cf868 (diff)
downloadgit-8957661378b073b49875059d6426614facb0d7f0.zip
git-8957661378b073b49875059d6426614facb0d7f0.tar.gz
git-8957661378b073b49875059d6426614facb0d7f0.tar.bz2
treewide: deprecate git_config_maybe_bool, use git_parse_maybe_bool
The only difference between these is that the former takes an argument `name` which it ignores completely. Still, the callers are quite careful to provide reasonable values for it. Once in-flight topics have landed, we should be able to remove git_config_maybe_bool. In the meantime, document it as deprecated in the technical documentation. While at it, document git_parse_maybe_bool. Signed-off-by: Martin Ågren <martin.agren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/technical/api-config.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/technical/api-config.txt b/Documentation/technical/api-config.txt
index 20741f3..7a83a3a 100644
--- a/Documentation/technical/api-config.txt
+++ b/Documentation/technical/api-config.txt
@@ -187,6 +187,10 @@ Same as `git_config_bool`, except that integers are returned as-is, and
an `is_bool` flag is unset.
`git_config_maybe_bool`::
+Deprecated. Use `git_parse_maybe_bool` instead. They are exactly the
+same, except this function takes an unused argument `name`.
+
+`git_parse_maybe_bool`::
Same as `git_config_bool`, except that it returns -1 on error rather
than dying.