2009-09-09 11:38:58 +00:00
|
|
|
#ifndef ADVICE_H
|
|
|
|
|
#define ADVICE_H
|
|
|
|
|
|
Be more user-friendly when refusing to do something because of conflict.
Various commands refuse to run in the presence of conflicts (commit,
merge, pull, cherry-pick/revert). They all used to provide rough, and
inconsistant error messages.
A new variable advice.resolveconflict is introduced, and allows more
verbose messages, pointing the user to the appropriate solution.
For commit, the error message used to look like this:
$ git commit
foo.txt: needs merge
foo.txt: unmerged (c34a92682e0394bc0d6f4d4a67a8e2d32395c169)
foo.txt: unmerged (3afcd75de8de0bb5076942fcb17446be50451030)
foo.txt: unmerged (c9785d77b76dfe4fb038bf927ee518f6ae45ede4)
error: Error building trees
The "need merge" line is given by refresh_cache. We add the IN_PORCELAIN
option to make the output more consistant with the other porcelain
commands, and catch the error in return, to stop with a clean error
message. The next lines were displayed by a call to cache_tree_update(),
which is not reached anymore if we noticed the conflict.
The new output looks like:
U foo.txt
fatal: 'commit' is not possible because you have unmerged files.
Please, fix them up in the work tree, and then use 'git add/rm <file>' as
appropriate to mark resolution and make a commit, or use 'git commit -a'.
Pull is slightly modified to abort immediately if $GIT_DIR/MERGE_HEAD
exists instead of waiting for merge to complain.
The behavior of merge and the test-case are slightly modified to reflect
the usual flow: start with conflicts, fix them, and afterwards get rid of
MERGE_HEAD, with different error messages at each stage.
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-01-12 09:54:44 +00:00
|
|
|
#include "git-compat-util.h"
|
|
|
|
|
|
2021-04-08 20:41:27 +00:00
|
|
|
struct string_list;
|
|
|
|
|
|
2019-06-18 20:25:27 +00:00
|
|
|
extern int advice_fetch_show_forced_updates;
|
2012-12-03 03:27:50 +00:00
|
|
|
extern int advice_push_update_rejected;
|
push: Provide situational hints for non-fast-forward errors
Pushing a non-fast-forward update to a remote repository will result in
an error, but the hint text doesn't provide the correct resolution in
every case. Give better resolution advice in three push scenarios:
1) If you push your current branch and it triggers a non-fast-forward
error, you should merge remote changes with 'git pull' before pushing
again.
2) If you push to a shared repository others push to, and your local
tracking branches are not kept up to date, the 'matching refs' default
will generate non-fast-forward errors on outdated branches. If this is
your workflow, the 'matching refs' default is not for you. Consider
setting the 'push.default' configuration variable to 'current' or
'upstream' to ensure only your current branch is pushed.
3) If you explicitly specify a ref that is not your current branch or
push matching branches with ':', you will generate a non-fast-forward
error if any pushed branch tip is out of date. You should checkout the
offending branch and merge remote changes before pushing again.
Teach transport.c to recognize these scenarios and configure push.c
to hint for them. If 'git push's default behavior changes or we
discover more scenarios, extension is easy. Standardize on the
advice API and add three new advice variables, 'pushNonFFCurrent',
'pushNonFFDefault', and 'pushNonFFMatching'. Setting any of these
to 'false' will disable their affiliated advice. Setting
'pushNonFastForward' to false will disable all three, thus preserving the
config option for users who already set it, but guaranteeing new
users won't disable push advice accidentally.
Based-on-patch-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Christopher Tiwald <christiwald@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-03-20 04:31:33 +00:00
|
|
|
extern int advice_push_non_ff_current;
|
|
|
|
|
extern int advice_push_non_ff_matching;
|
2012-12-03 03:27:51 +00:00
|
|
|
extern int advice_push_already_exists;
|
push: introduce REJECT_FETCH_FIRST and REJECT_NEEDS_FORCE
When we push to update an existing ref, if:
* the object at the tip of the remote is not a commit; or
* the object we are pushing is not a commit,
it won't be correct to suggest to fetch, integrate and push again,
as the old and new objects will not "merge". We should explain that
the push must be forced when there is a non-committish object is
involved in such a case.
If we do not have the current object at the tip of the remote, we do
not even know that object, when fetched, is something that can be
merged. In such a case, suggesting to pull first just like
non-fast-forward case may not be technically correct, but in
practice, most such failures are seen when you try to push your work
to a branch without knowing that somebody else already pushed to
update the same branch since you forked, so "pull first" would work
as a suggestion most of the time. And if the object at the tip is
not a commit, "pull first" will fail, without making any permanent
damage. As a side effect, it also makes the error message the user
will get during the next "push" attempt easier to understand, now
the user is aware that a non-commit object is involved.
In these cases, the current code already rejects such a push on the
client end, but we used the same error and advice messages as the
ones used when rejecting a non-fast-forward push, i.e. pull from
there and integrate before pushing again.
Introduce new rejection reasons and reword the messages
appropriately.
[jc: with help by Peff on message details]
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-01-23 21:55:30 +00:00
|
|
|
extern int advice_push_fetch_first;
|
|
|
|
|
extern int advice_push_needs_force;
|
push: add an advice on unqualified <dst> push
Add an advice to the recently improved error message added in
f8aae12034 ("push: allow unqualified dest refspecs to DWIM",
2008-04-23).
Now with advice.pushUnqualifiedRefName=true (on by default) we show a
hint about how to proceed:
$ ./git-push avar v2.19.0^{commit}:newbranch -n
error: The destination you provided is not a full refname (i.e.,
starting with "refs/"). We tried to guess what you meant by:
- Looking for a ref that matches 'newbranch' on the remote side.
- Checking if the <src> being pushed ('v2.19.0^{commit}')
is a ref in "refs/{heads,tags}/". If so we add a corresponding
refs/{heads,tags}/ prefix on the remote side.
Neither worked, so we gave up. You must fully qualify the ref.
hint: The <src> part of the refspec is a commit object.
hint: Did you mean to create a new branch by pushing to
hint: 'v2.19.0^{commit}:refs/heads/newbranch'?
error: failed to push some refs to 'git@github.com:avar/git.git'
When trying to push a tag, tree or a blob we suggest that perhaps the
user meant to push them to refs/tags/ instead.
The if/else duplication for all of OBJ_{COMMIT,TAG,TREE,BLOB} is
unfortunate, but is required to correctly mark the messages for
translation. See the discussion in
<87r2gxebsi.fsf@evledraar.gmail.com> about that.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-11-13 19:52:43 +00:00
|
|
|
extern int advice_push_unqualified_ref_name;
|
2020-10-03 12:10:45 +00:00
|
|
|
extern int advice_push_ref_needs_update;
|
2009-09-09 11:43:03 +00:00
|
|
|
extern int advice_status_hints;
|
2013-03-13 12:59:16 +00:00
|
|
|
extern int advice_status_u_option;
|
2019-06-18 20:21:27 +00:00
|
|
|
extern int advice_status_ahead_behind_warning;
|
2009-11-22 22:26:17 +00:00
|
|
|
extern int advice_commit_before_merge;
|
2018-10-23 19:04:23 +00:00
|
|
|
extern int advice_reset_quiet_warning;
|
Be more user-friendly when refusing to do something because of conflict.
Various commands refuse to run in the presence of conflicts (commit,
merge, pull, cherry-pick/revert). They all used to provide rough, and
inconsistant error messages.
A new variable advice.resolveconflict is introduced, and allows more
verbose messages, pointing the user to the appropriate solution.
For commit, the error message used to look like this:
$ git commit
foo.txt: needs merge
foo.txt: unmerged (c34a92682e0394bc0d6f4d4a67a8e2d32395c169)
foo.txt: unmerged (3afcd75de8de0bb5076942fcb17446be50451030)
foo.txt: unmerged (c9785d77b76dfe4fb038bf927ee518f6ae45ede4)
error: Error building trees
The "need merge" line is given by refresh_cache. We add the IN_PORCELAIN
option to make the output more consistant with the other porcelain
commands, and catch the error in return, to stop with a clean error
message. The next lines were displayed by a call to cache_tree_update(),
which is not reached anymore if we noticed the conflict.
The new output looks like:
U foo.txt
fatal: 'commit' is not possible because you have unmerged files.
Please, fix them up in the work tree, and then use 'git add/rm <file>' as
appropriate to mark resolution and make a commit, or use 'git commit -a'.
Pull is slightly modified to abort immediately if $GIT_DIR/MERGE_HEAD
exists instead of waiting for merge to complain.
The behavior of merge and the test-case are slightly modified to reflect
the usual flow: start with conflicts, fix them, and afterwards get rid of
MERGE_HEAD, with different error messages at each stage.
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-01-12 09:54:44 +00:00
|
|
|
extern int advice_resolve_conflict;
|
2019-07-02 09:11:25 +00:00
|
|
|
extern int advice_sequencer_in_use;
|
2010-01-13 20:17:08 +00:00
|
|
|
extern int advice_implicit_identity;
|
2010-01-30 06:03:24 +00:00
|
|
|
extern int advice_detached_head;
|
2013-04-02 19:05:12 +00:00
|
|
|
extern int advice_set_upstream_failure;
|
2013-05-29 12:12:42 +00:00
|
|
|
extern int advice_object_name_warning;
|
2018-05-26 13:55:27 +00:00
|
|
|
extern int advice_amworkdir;
|
2013-06-12 08:06:44 +00:00
|
|
|
extern int advice_rm_hints;
|
add: warn when adding an embedded repository
It's an easy mistake to add a repository inside another
repository, like:
git clone $url
git add .
The resulting entry is a gitlink, but there's no matching
.gitmodules entry. Trying to use "submodule init" (or clone
with --recursive) doesn't do anything useful. Prior to
v2.13, such an entry caused git-submodule to barf entirely.
In v2.13, the entry is considered "inactive" and quietly
ignored. Either way, no clone of your repository can do
anything useful with the gitlink without the user manually
adding the submodule config.
In most cases, the user probably meant to either add a real
submodule, or they forgot to put the embedded repository in
their .gitignore file.
Let's issue a warning when we see this case. There are a few
things to note:
- the warning will go in the git-add porcelain; anybody
wanting to do low-level manipulation of the index is
welcome to create whatever funny states they want.
- we detect the case by looking for a newly added gitlink;
updates via "git add submodule" are perfectly reasonable,
and this avoids us having to investigate .gitmodules
entirely
- there's a command-line option to suppress the warning.
This is needed for git-submodule itself (which adds the
entry before adding any submodule config), but also
provides a mechanism for other scripts doing
submodule-like things.
We could make this a hard error instead of a warning.
However, we do add lots of sub-repos in our test suite. It's
not _wrong_ to do so. It just creates a state where users
may be surprised. Pointing them in the right direction with
a gentle hint is probably the best option.
There is a config knob that can disable the (long) hint. But
I intentionally omitted a config knob to disable the warning
entirely. Whether the warning is sensible or not is
generally about context, not about the user's preferences.
If there's a tool or workflow that adds gitlinks without
matching .gitmodules, it should probably be taught about the
new command-line option, rather than blanket-disabling the
warning.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-06-14 10:58:22 +00:00
|
|
|
extern int advice_add_embedded_repo;
|
2017-10-06 08:07:55 +00:00
|
|
|
extern int advice_ignored_hook;
|
2017-12-07 15:16:41 +00:00
|
|
|
extern int advice_waiting_for_editor;
|
Deprecate support for .git/info/grafts
The grafts feature was a convenient way to "stitch together" ancient
history to the fresh start of linux.git.
Its implementation is, however, not up to Git's standards, as there are
too many ways where it can lead to surprising and unwelcome behavior.
For example, when pushing from a repository with active grafts, it is
possible to miss commits that have been "grafted out", resulting in a
broken state on the other side.
Also, the grafts feature is limited to "rewriting" commits' list of
parents, it cannot replace anything else.
The much younger feature implemented as `git replace` set out to remedy
those limitations and dangerous bugs.
Seeing as `git replace` is pretty mature by now (since 4228e8bc98
(replace: add --graft option, 2014-07-19) it can perform the graft
file's duties), it is time to deprecate support for the graft file, and
to retire it eventually.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Reviewed-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-04-28 22:44:44 +00:00
|
|
|
extern int advice_graft_file_deprecated;
|
checkout: add advice for ambiguous "checkout <branch>"
As the "checkout" documentation describes:
If <branch> is not found but there does exist a tracking branch in
exactly one remote (call it <remote>) with a matching name, treat
as equivalent to [...] <remote>/<branch.
This is a really useful feature. The problem is that when you add
another remote (e.g. a fork), git won't find a unique branch name
anymore, and will instead print this unhelpful message:
$ git checkout master
error: pathspec 'master' did not match any file(s) known to git
Now it will, on my git.git checkout, print:
$ ./git --exec-path=$PWD checkout master
error: pathspec 'master' did not match any file(s) known to git.
hint: 'master' matched more than one remote tracking branch.
hint: We found 26 remotes with a reference that matched. So we fell back
hint: on trying to resolve the argument as a path, but failed there too!
hint:
hint: If you meant to check out a remote tracking branch on, e.g. 'origin',
hint: you can do so by fully qualifying the name with the --track option:
hint:
hint: git checkout --track origin/<name>
Note that the "error: pathspec[...]" message is still printed. This is
because whatever else checkout may have tried earlier, its final
fallback is to try to resolve the argument as a path. E.g. in this
case:
$ ./git --exec-path=$PWD checkout master pu
error: pathspec 'master' did not match any file(s) known to git.
error: pathspec 'pu' did not match any file(s) known to git.
There we don't print the "hint:" implicitly due to earlier logic
around the DWIM fallback. That fallback is only used if it looks like
we have one argument that might be a branch.
I can't think of an intrinsic reason for why we couldn't in some
future change skip printing the "error: pathspec[...]" error. However,
to do so we'd need to pass something down to checkout_paths() to make
it suppress printing an error on its own, and for us to be confident
that we're not silencing cases where those errors are meaningful.
I don't think that's worth it since determining whether that's the
case could easily change due to future changes in the checkout logic.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-06-05 14:40:48 +00:00
|
|
|
extern int advice_checkout_ambiguous_remote_branch_name;
|
2019-12-02 19:57:52 +00:00
|
|
|
extern int advice_submodule_alternate_error_strategy_die;
|
2020-02-06 10:57:30 +00:00
|
|
|
extern int advice_add_ignored_file;
|
|
|
|
|
extern int advice_add_empty_pathspec;
|
2009-09-09 11:38:58 +00:00
|
|
|
|
2020-03-02 20:01:59 +00:00
|
|
|
/*
|
|
|
|
|
* To add a new advice, you need to:
|
|
|
|
|
* Define a new advice_type.
|
|
|
|
|
* Add a new entry to advice_setting array.
|
|
|
|
|
* Add the new config variable to Documentation/config/advice.txt.
|
|
|
|
|
* Call advise_if_enabled to print your advice.
|
|
|
|
|
*/
|
|
|
|
|
enum advice_type {
|
|
|
|
|
ADVICE_ADD_EMBEDDED_REPO,
|
|
|
|
|
ADVICE_AM_WORK_DIR,
|
|
|
|
|
ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME,
|
|
|
|
|
ADVICE_COMMIT_BEFORE_MERGE,
|
|
|
|
|
ADVICE_DETACHED_HEAD,
|
|
|
|
|
ADVICE_FETCH_SHOW_FORCED_UPDATES,
|
|
|
|
|
ADVICE_GRAFT_FILE_DEPRECATED,
|
|
|
|
|
ADVICE_IGNORED_HOOK,
|
|
|
|
|
ADVICE_IMPLICIT_IDENTITY,
|
|
|
|
|
ADVICE_NESTED_TAG,
|
|
|
|
|
ADVICE_OBJECT_NAME_WARNING,
|
|
|
|
|
ADVICE_PUSH_ALREADY_EXISTS,
|
|
|
|
|
ADVICE_PUSH_FETCH_FIRST,
|
|
|
|
|
ADVICE_PUSH_NEEDS_FORCE,
|
|
|
|
|
ADVICE_PUSH_NON_FF_CURRENT,
|
|
|
|
|
ADVICE_PUSH_NON_FF_MATCHING,
|
|
|
|
|
ADVICE_PUSH_UNQUALIFIED_REF_NAME,
|
|
|
|
|
ADVICE_PUSH_UPDATE_REJECTED_ALIAS,
|
|
|
|
|
ADVICE_PUSH_UPDATE_REJECTED,
|
2020-10-03 12:10:45 +00:00
|
|
|
ADVICE_PUSH_REF_NEEDS_UPDATE,
|
2020-03-02 20:01:59 +00:00
|
|
|
ADVICE_RESET_QUIET_WARNING,
|
|
|
|
|
ADVICE_RESOLVE_CONFLICT,
|
|
|
|
|
ADVICE_RM_HINTS,
|
|
|
|
|
ADVICE_SEQUENCER_IN_USE,
|
|
|
|
|
ADVICE_SET_UPSTREAM_FAILURE,
|
|
|
|
|
ADVICE_STATUS_AHEAD_BEHIND_WARNING,
|
|
|
|
|
ADVICE_STATUS_HINTS,
|
|
|
|
|
ADVICE_STATUS_U_OPTION,
|
|
|
|
|
ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE,
|
2021-04-08 20:41:27 +00:00
|
|
|
ADVICE_UPDATE_SPARSE_PATH,
|
2020-03-02 20:01:59 +00:00
|
|
|
ADVICE_WAITING_FOR_EDITOR,
|
|
|
|
|
};
|
|
|
|
|
|
2009-09-09 11:38:58 +00:00
|
|
|
int git_default_advice_config(const char *var, const char *value);
|
2013-07-10 00:18:40 +00:00
|
|
|
__attribute__((format (printf, 1, 2)))
|
2011-08-04 10:38:59 +00:00
|
|
|
void advise(const char *advice, ...);
|
2020-03-02 20:01:59 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Checks if advice type is enabled (can be printed to the user).
|
|
|
|
|
* Should be called before advise().
|
|
|
|
|
*/
|
|
|
|
|
int advice_enabled(enum advice_type type);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Checks the visibility of the advice before printing.
|
|
|
|
|
*/
|
|
|
|
|
void advise_if_enabled(enum advice_type type, const char *advice, ...);
|
|
|
|
|
|
2011-08-04 10:38:59 +00:00
|
|
|
int error_resolve_conflict(const char *me);
|
2019-04-29 08:28:14 +00:00
|
|
|
void NORETURN die_resolve_conflict(const char *me);
|
2015-06-18 10:54:04 +00:00
|
|
|
void NORETURN die_conclude_merge(void);
|
2021-04-08 20:41:27 +00:00
|
|
|
void advise_on_updating_sparse_paths(struct string_list *pathspec_list);
|
2012-01-16 09:46:16 +00:00
|
|
|
void detach_advice(const char *new_name);
|
Be more user-friendly when refusing to do something because of conflict.
Various commands refuse to run in the presence of conflicts (commit,
merge, pull, cherry-pick/revert). They all used to provide rough, and
inconsistant error messages.
A new variable advice.resolveconflict is introduced, and allows more
verbose messages, pointing the user to the appropriate solution.
For commit, the error message used to look like this:
$ git commit
foo.txt: needs merge
foo.txt: unmerged (c34a92682e0394bc0d6f4d4a67a8e2d32395c169)
foo.txt: unmerged (3afcd75de8de0bb5076942fcb17446be50451030)
foo.txt: unmerged (c9785d77b76dfe4fb038bf927ee518f6ae45ede4)
error: Error building trees
The "need merge" line is given by refresh_cache. We add the IN_PORCELAIN
option to make the output more consistant with the other porcelain
commands, and catch the error in return, to stop with a clean error
message. The next lines were displayed by a call to cache_tree_update(),
which is not reached anymore if we noticed the conflict.
The new output looks like:
U foo.txt
fatal: 'commit' is not possible because you have unmerged files.
Please, fix them up in the work tree, and then use 'git add/rm <file>' as
appropriate to mark resolution and make a commit, or use 'git commit -a'.
Pull is slightly modified to abort immediately if $GIT_DIR/MERGE_HEAD
exists instead of waiting for merge to complain.
The behavior of merge and the test-case are slightly modified to reflect
the usual flow: start with conflicts, fix them, and afterwards get rid of
MERGE_HEAD, with different error messages at each stage.
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-01-12 09:54:44 +00:00
|
|
|
|
2009-09-09 11:38:58 +00:00
|
|
|
#endif /* ADVICE_H */
|