Go to file
Jacob Keller 7efba5fa39 format-patch: teach format.useAutoBase "whenAble" option
The format.useAutoBase configuration option exists to allow users to
enable '--base=auto' for format-patch by default.

This can sometimes lead to poor workflow, due to unexpected failures
when attempting to format an ancient patch:

    $ git format-patch -1 <an old commit>
    fatal: base commit shouldn't be in revision list

This can be very confusing, as it is not necessarily immediately obvious
that the user requested a --base (since this was in the configuration,
not on the command line).

We do want --base=auto to fail when it cannot provide a suitable base,
as it would be equally confusing if a formatted patch did not include
the base information when it was requested.

Teach format.useAutoBase a new mode, "whenAble". This mode will cause
format-patch to attempt to include a base commit when it can. However,
if no valid base commit can be found, then format-patch will continue
formatting the patch without a base commit.

In order to avoid making yet another branch name unusable with --base,
do not teach --base=whenAble or --base=whenable.

Instead, refactor the base_commit option to use a callback, and rely on
the global configuration variable auto_base.

This does mean that a user cannot request this optional base commit
generation from the command line. However, this is likely not too
valuable. If the user requests base information manually, they will be
immediately informed of the failure to acquire a suitable base commit.
This allows the user to make an informed choice about whether to
continue the format.

Add tests to cover the new mode of operation for --base.

Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-10-01 15:22:10 -07:00
.github ci: avoid ugly "failure" in the `ci-config` job 2020-09-02 12:21:45 -07:00
Documentation format-patch: teach format.useAutoBase "whenAble" option 2020-10-01 15:22:10 -07:00
block-sha1
builtin format-patch: teach format.useAutoBase "whenAble" option 2020-10-01 15:22:10 -07:00
ci
compat vcbuild: fix batch file name in README 2020-09-03 10:19:48 -07:00
contrib Merge branch 'jk/diff-highlight-blank-match-fix' 2020-09-25 15:25:42 -07:00
ewah
git-gui
gitk-git
gitweb
mergetools Merge branch 'ls/mergetool-meld-auto-merge' 2020-09-22 12:36:29 -07:00
negotiator negotiator/noop: add noop fetch negotiator 2020-08-18 13:25:05 -07:00
perl
po po: add missing letter for French message 2020-08-28 14:02:07 -07:00
ppc
refs Merge branch 'hn/refs-trace-backend' 2020-09-22 12:36:28 -07:00
sha1collisiondetection@855827c583
sha1dc
sha256
t format-patch: teach format.useAutoBase "whenAble" option 2020-10-01 15:22:10 -07:00
templates
trace2
vcs-svn drop vcs-svn experiment 2020-08-13 11:02:15 -07:00
xdiff
.cirrus.yml
.clang-format
.editorconfig
.gitattributes
.gitignore Merge branch 'ds/maintenance-part-1' 2020-09-25 15:25:38 -07:00
.gitmodules
.mailmap
.travis.yml
.tsan-suppressions
CODE_OF_CONDUCT.md
COPYING
GIT-VERSION-GEN
INSTALL
LGPL-2.1
Makefile Merge branch 'jx/proc-receive-hook' 2020-09-25 15:25:39 -07:00
README.md
RelNotes
abspath.c
aclocal.m4
add-interactive.c
add-interactive.h
add-patch.c Merge branch 'pw/add-p-edit-ita-path' 2020-09-22 12:36:28 -07:00
advice.c
advice.h
alias.c
alias.h
alloc.c
alloc.h
apply.c Merge branch 'jk/leakfix' 2020-08-27 14:04:49 -07:00
apply.h
archive-tar.c
archive-zip.c
archive.c wt-status: tolerate dangling marks 2020-09-02 14:39:25 -07:00
archive.h
attr.c
attr.h
banned.h
base85.c
bisect.c Merge branch 'al/bisect-first-parent' 2020-08-17 17:02:45 -07:00
bisect.h
blame.c Merge branch 'ea/blame-use-oideq' 2020-09-18 17:58:01 -07:00
blame.h
blob.c
blob.h
bloom.c
bloom.h
branch.c wt-status: tolerate dangling marks 2020-09-02 14:39:25 -07:00
branch.h
builtin.h Merge branch 'ds/maintenance-part-1' 2020-09-25 15:25:38 -07:00
bulk-checkin.c
bulk-checkin.h
bundle.c Merge branch 'jt/interpret-branch-name-fallback' 2020-09-09 13:53:09 -07:00
bundle.h
cache-tree.c
cache-tree.h
cache.h Merge branch 'jt/interpret-branch-name-fallback' 2020-09-09 13:53:09 -07:00
chdir-notify.c
chdir-notify.h
check-builtins.sh
check_bindir
checkout.c config: drop git_config_get_string_const() 2020-08-17 15:35:47 -07:00
checkout.h
color.c
color.h
column.c
column.h
combine-diff.c
command-list.txt maintenance: create basic maintenance runner 2020-09-17 11:30:04 -07:00
commit-graph.c Merge branch 'ds/maintenance-part-1' 2020-09-25 15:25:38 -07:00
commit-graph.h maintenance: add commit-graph task 2020-09-17 11:30:05 -07:00
commit-reach.c
commit-reach.h
commit-slab-decl.h
commit-slab-impl.h
commit-slab.h
commit.c Merge branch 'jt/interpret-branch-name-fallback' 2020-09-09 13:53:09 -07:00
commit.h Merge branch 'mf/submodule-summary-with-correct-repository' 2020-09-18 17:58:05 -07:00
common-main.c
config.c Merge branch 'jk/leakfix' 2020-08-27 14:04:49 -07:00
config.h config: drop git_config_get_string_const() 2020-08-17 15:35:47 -07:00
config.mak.dev
config.mak.in
config.mak.uname
configure.ac
connect.c Merge branch 'jk/leakfix' 2020-08-27 14:04:49 -07:00
connect.h
connected.c Merge branch 'rs/more-buffered-io' 2020-08-24 14:54:31 -07:00
connected.h
convert.c run_command: teach API users to use embedded 'args' more 2020-08-26 15:32:37 -07:00
convert.h
copy.c
credential.c run_command: teach API users to use embedded 'args' more 2020-08-26 15:32:37 -07:00
credential.h
csum-file.c
csum-file.h
ctype.c
daemon.c
date.c
decorate.c
decorate.h
delta-islands.c
delta-islands.h
delta.h
detect-compiler
diff-delta.c
diff-lib.c Merge branch 'es/format-patch-interdiff-cleanup' 2020-09-22 12:36:28 -07:00
diff-no-index.c
diff.c Merge branch 'jc/quote-path-cleanup' 2020-09-18 17:58:04 -07:00
diff.h diff-lib: tighten show_interdiff()'s interface 2020-09-08 15:03:27 -07:00
diffcore-break.c
diffcore-delta.c
diffcore-order.c
diffcore-pickaxe.c
diffcore-rename.c
diffcore.h
dir-iterator.c
dir-iterator.h
dir.c Merge branch 'jk/leakfix' 2020-08-27 14:04:49 -07:00
dir.h dir: fix problematic API to avoid memory leaks 2020-08-18 17:17:31 -07:00
editor.c config: fix leaks from git_config_get_string_const() 2020-08-14 10:52:04 -07:00
entry.c checkout_entry(): remove unreachable error() call 2020-08-18 13:26:10 -07:00
environment.c Merge branch 'jk/leakfix' 2020-08-27 14:04:49 -07:00
exec-cmd.c
exec-cmd.h
fetch-negotiator.c negotiator/noop: add noop fetch negotiator 2020-08-18 13:25:05 -07:00
fetch-negotiator.h
fetch-pack.c Merge branch 'jt/lazy-fetch' 2020-09-03 12:37:04 -07:00
fetch-pack.h Merge branch 'jt/lazy-fetch' 2020-09-03 12:37:04 -07:00
fmt-merge-msg.c
fmt-merge-msg.h
fsck.c
fsck.h
fsmonitor.c
fsmonitor.h
fuzz-commit-graph.c
fuzz-pack-headers.c
fuzz-pack-idx.c
generate-cmdlist.sh Fit to Plan 9's ANSI/POSIX compatibility layer 2020-09-09 22:31:31 -07:00
generate-configlist.sh
gettext.c
gettext.h
git-add--interactive.perl Merge branch 'pw/add-p-edit-ita-path' 2020-09-22 12:36:28 -07:00
git-archimport.perl
git-bisect.sh Merge branch 'hl/bisect-doc-clarify-bad-good-ordering' 2020-09-03 12:37:06 -07:00
git-compat-util.h
git-cvsexportcommit.perl cvsexportcommit: do not run git programs in dashed form 2020-08-26 14:49:52 -07:00
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-p4: use HEAD~$n to find parent commit for unshelve 2020-09-19 13:44:55 -07:00
git-parse-remote.sh
git-quiltimport.sh
git-rebase--preserve-merges.sh rebase: remove unused function reschedule_last_action 2020-08-12 12:25:42 -07:00
git-request-pull.sh
git-send-email.perl
git-sh-i18n.sh
git-sh-setup.sh
git-submodule.sh submodule: port submodule subcommand 'summary' from shell to C 2020-08-12 14:12:58 -07:00
git-svn.perl
git-web--browse.sh
git.c Merge branch 'ds/maintenance-part-1' 2020-09-25 15:25:38 -07:00
git.rc
gpg-interface.c
gpg-interface.h
graph.c
graph.h
grep.c
grep.h
hash.h
hashmap.c
hashmap.h
help.c Merge branch 'jk/leakfix' 2020-08-27 14:04:49 -07:00
help.h
hex.c
http-backend.c
http-fetch.c
http-push.c
http-walker.c
http.c
http.h
ident.c Merge branch 'pw/rebase-i-more-options' 2020-09-03 12:37:01 -07:00
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
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 Merge branch 'es/format-patch-interdiff-cleanup' 2020-09-22 12:36:28 -07:00
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: use consistent pool variable name 2020-08-18 12:16:08 -07:00
mem-pool.h mem-pool: use consistent pool variable name 2020-08-18 12:16:08 -07:00
merge-blobs.c
merge-blobs.h
merge-recursive.c
merge-recursive.h
merge.c dir: fix problematic API to avoid memory leaks 2020-08-18 17:17:31 -07:00
mergesort.c
mergesort.h
midx.c Merge branch 'rs/misc-cleanups' 2020-09-18 17:58:00 -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-store.h
object.c
object.h maintenance: add auto condition for commit-graph task 2020-09-17 11:30:05 -07:00
oid-array.c
oid-array.h
oidmap.c
oidmap.h
oidset.c
oidset.h
pack-bitmap-write.c pack-bitmap-write: use hashwrite_be32() in write_hash_cache() 2020-09-06 13:40:41 -07:00
pack-bitmap.c
pack-bitmap.h
pack-check.c
pack-objects.c
pack-objects.h
pack-revindex.c
pack-revindex.h
pack-write.c pack-write: use hashwrite_be32() in write_idx_file() 2020-09-19 12:15:36 -07:00
pack.h
packfile.c Merge branch 'jk/dont-count-existing-objects-twice' 2020-09-22 12:36:32 -07:00
packfile.h midx: traverse the local MIDX first 2020-08-28 14:07:09 -07:00
pager.c
parse-options-cb.c
parse-options.c parse-options: add --git-completion-helper-all 2020-08-19 17:46:17 -07:00
parse-options.h messages: avoid SHA-1 in end-user facing messages 2020-08-14 09:33:37 -07:00
patch-delta.c
patch-ids.c
patch-ids.h
path.c sequencer: treat REVERT_HEAD as a pseudo ref 2020-08-21 11:20:11 -07:00
path.h sequencer: treat REVERT_HEAD as a pseudo ref 2020-08-21 11:20:11 -07:00
pathspec.c
pathspec.h
pkt-line.c
pkt-line.h
preload-index.c
pretty.c pretty: refactor `format_sanitized_subject()` 2020-08-28 13:52:51 -07:00
pretty.h pretty: refactor `format_sanitized_subject()` 2020-08-28 13:52:51 -07:00
prio-queue.c
prio-queue.h
progress.c Merge branch 'ma/stop-progress-null-fix' 2020-08-17 17:02:48 -07:00
progress.h
promisor-remote.c promisor-remote: lazy-fetch objects in subprocess 2020-08-18 16:46:53 -07:00
promisor-remote.h
prompt.c
prompt.h
protocol.c config: fix leaks from git_config_get_string_const() 2020-08-14 10:52:04 -07:00
protocol.h
prune-packed.c
prune-packed.h
quote.c quote: turn 'nodq' parameter into a set of flags 2020-09-10 13:08:07 -07:00
quote.h quote: turn 'nodq' parameter into a set of flags 2020-09-10 13:08:07 -07:00
range-diff.c
range-diff.h
reachable.c
reachable.h
read-cache.c read-cache: fix mem-pool allocation for multi-threaded index loading 2020-09-06 12:34:12 -07:00
rebase-interactive.c
rebase-interactive.h
rebase.c
rebase.h
ref-filter.c ref-filter: make internal reachable-filter API more precise 2020-09-18 15:41:55 -07:00
ref-filter.h ref-filter: make internal reachable-filter API more precise 2020-09-18 15:41:55 -07:00
reflog-walk.c
reflog-walk.h
refs.c Merge branch 'hn/refs-trace-backend' 2020-09-22 12:36:28 -07:00
refs.h Merge branch 'jt/interpret-branch-name-fallback' 2020-09-09 13:53:09 -07:00
refspec.c refspec: add and use refspec_appendf() 2020-09-06 13:15:46 -07:00
refspec.h refspec: add and use refspec_appendf() 2020-09-06 13:15:46 -07:00
remote-curl.c Merge branch 'jt/lazy-fetch' 2020-09-03 12:37:04 -07:00
remote.c Merge branch 'rs/refspec-leakfix' 2020-09-18 17:58:00 -07:00
remote.h Merge branch 'jx/proc-receive-hook' 2020-09-25 15:25:39 -07:00
replace-object.c
replace-object.h
repo-settings.c negotiator/noop: add noop fetch negotiator 2020-08-18 13:25:05 -07:00
repository.c
repository.h negotiator/noop: add noop fetch negotiator 2020-08-18 13:25:05 -07:00
rerere.c
rerere.h
reset.c
reset.h
resolve-undo.c
resolve-undo.h
revision.c Merge branch 'mf/submodule-summary-with-correct-repository' 2020-09-18 17:58:05 -07:00
revision.h revision: add separate field for "-m" of "diff-index -m" 2020-08-31 13:42:58 -07:00
run-command.c maintenance: replace run_auto_gc() 2020-09-17 11:30:05 -07:00
run-command.h maintenance: replace run_auto_gc() 2020-09-17 11:30:05 -07:00
send-pack.c Merge branch 'hx/push-atomic-with-cert' 2020-09-25 15:25:41 -07:00
send-pack.h
sequencer.c Merge branch 'pw/rebase-i-more-options' 2020-09-03 12:37:01 -07:00
sequencer.h Merge branch 'pw/rebase-i-more-options' 2020-09-03 12:37:01 -07:00
serve.c
serve.h
server-info.c
setup.c
sh-i18n--envsubst.c
sha1-file.c Merge branch 'jt/has_object' 2020-08-13 14:13:39 -07:00
sha1-lookup.c
sha1-lookup.h
sha1-name.c wt-status: tolerate dangling marks 2020-09-02 14:39:25 -07:00
sha1dc_git.c
sha1dc_git.h
shallow.c
shallow.h
shell.c
shortlog.h
sideband.c
sideband.h
sigchain.c
sigchain.h
split-index.c mem-pool: use more standard initialization and finalization 2020-08-18 12:16:06 -07:00
split-index.h
stable-qsort.c
strbuf.c
strbuf.h
streaming.c
streaming.h
string-list.c
string-list.h
strvec.c
strvec.h
sub-process.c
sub-process.h
submodule-config.c fetch: avoid reading submodule config until needed 2020-08-18 13:25:05 -07:00
submodule-config.h
submodule.c Merge branch 'mf/submodule-summary-with-correct-repository' 2020-09-18 17:58:05 -07:00
submodule.h submodule: rename helper functions to avoid ambiguity 2020-08-12 14:12:58 -07:00
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.h
trace2.c
trace2.h
trailer.c run_command: teach API users to use embedded 'args' more 2020-08-26 15:32:37 -07:00
trailer.h
transport-helper.c Merge branch 'jx/proc-receive-hook' 2020-09-25 15:25:39 -07:00
transport-internal.h
transport.c Merge branch 'jx/proc-receive-hook' 2020-09-25 15:25:39 -07:00
transport.h Merge branch 'jt/lazy-fetch' 2020-09-03 12:37:04 -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
unpack-trees.c
unpack-trees.h
upload-pack.c Merge branch 'rs/more-buffered-io' 2020-08-24 14:54:31 -07:00
upload-pack.h
url.c
url.h
urlmatch.c
urlmatch.h
usage.c
userdiff.c userdiff: improve Fortran xfuncname regex 2020-08-13 11:21:18 -07:00
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: teach "repair" to fix outgoing links to worktrees 2020-08-31 11:47:45 -07:00
worktree.h worktree: teach "repair" to fix outgoing links to worktrees 2020-08-31 11:47:45 -07:00
wrap-for-bin.sh
wrapper.c xrealloc: do not reuse pointer freed by zero-length realloc() 2020-09-02 12:18:14 -07:00
write-or-die.c
ws.c
wt-status.c Merge branch 'jc/quote-path-cleanup' 2020-09-18 17:58:04 -07:00
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). To subscribe to the list, send an email with just "subscribe git" in the body to majordomo@vger.kernel.org. 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