mirror of
https://github.com/git/git
synced 2024-08-27 19:49:21 +00:00
![Josh Steadmon](/assets/img/avatar_default.png)
It can be helpful when creating a new branch to use the existing tracking configuration from the branch point. However, there is currently not a method to automatically do so. Teach git-{branch,checkout,switch} an "inherit" argument to the "--track" option. When this is set, creating a new branch will cause the tracking configuration to default to the configuration of the branch point, if set. For example, if branch "main" tracks "origin/main", and we run `git checkout --track=inherit -b feature main`, then branch "feature" will track "origin/main". Thus, `git status` will show us how far ahead/behind we are from origin, and `git pull` will pull from origin. This is particularly useful when creating branches across many submodules, such as with `git submodule foreach ...` (or if running with a patch such as [1], which we use at $job), as it avoids having to manually set tracking info for each submodule. Since we've added an argument to "--track", also add "--track=direct" as another way to explicitly get the original "--track" behavior ("--track" without an argument still works as well). Finally, teach branch.autoSetupMerge a new "inherit" option. When this is set, "--track=inherit" becomes the default behavior. [1]: https://lore.kernel.org/git/20180927221603.148025-1-sbeller@google.com/ Signed-off-by: Josh Steadmon <steadmon@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
105 lines
3 KiB
C
105 lines
3 KiB
C
#ifndef BRANCH_H
|
|
#define BRANCH_H
|
|
|
|
struct repository;
|
|
struct strbuf;
|
|
|
|
enum branch_track {
|
|
BRANCH_TRACK_UNSPECIFIED = -1,
|
|
BRANCH_TRACK_NEVER = 0,
|
|
BRANCH_TRACK_REMOTE,
|
|
BRANCH_TRACK_ALWAYS,
|
|
BRANCH_TRACK_EXPLICIT,
|
|
BRANCH_TRACK_OVERRIDE,
|
|
BRANCH_TRACK_INHERIT,
|
|
};
|
|
|
|
extern enum branch_track git_branch_track;
|
|
|
|
/* Functions for acting on the information about branches. */
|
|
|
|
/*
|
|
* Creates a new branch, where:
|
|
*
|
|
* - r is the repository to add a branch to
|
|
*
|
|
* - name is the new branch name
|
|
*
|
|
* - start_name is the name of the existing branch that the new branch should
|
|
* start from
|
|
*
|
|
* - force enables overwriting an existing (non-head) branch
|
|
*
|
|
* - clobber_head_ok allows the currently checked out (hence existing)
|
|
* branch to be overwritten; without 'force', it has no effect.
|
|
*
|
|
* - reflog creates a reflog for the branch
|
|
*
|
|
* - quiet suppresses tracking information
|
|
*
|
|
* - track causes the new branch to be configured to merge the remote branch
|
|
* that start_name is a tracking branch for (if any).
|
|
*
|
|
*/
|
|
void create_branch(struct repository *r,
|
|
const char *name, const char *start_name,
|
|
int force, int clobber_head_ok,
|
|
int reflog, int quiet, enum branch_track track);
|
|
|
|
/*
|
|
* Check if 'name' can be a valid name for a branch; die otherwise.
|
|
* Return 1 if the named branch already exists; return 0 otherwise.
|
|
* Fill ref with the full refname for the branch.
|
|
*/
|
|
int validate_branchname(const char *name, struct strbuf *ref);
|
|
|
|
/*
|
|
* Check if a branch 'name' can be created as a new branch; die otherwise.
|
|
* 'force' can be used when it is OK for the named branch already exists.
|
|
* Return 1 if the named branch already exists; return 0 otherwise.
|
|
* Fill ref with the full refname for the branch.
|
|
*/
|
|
int validate_new_branchname(const char *name, struct strbuf *ref, int force);
|
|
|
|
/*
|
|
* Remove information about the merge state on the current
|
|
* branch. (E.g., MERGE_HEAD)
|
|
*/
|
|
void remove_merge_branch_state(struct repository *r);
|
|
|
|
/*
|
|
* Remove information about the state of working on the current
|
|
* branch. (E.g., MERGE_HEAD)
|
|
*/
|
|
void remove_branch_state(struct repository *r, int verbose);
|
|
|
|
/*
|
|
* Configure local branch "local" as downstream to branch "remote"
|
|
* from remote "origin". Used by git branch --set-upstream.
|
|
* Returns 0 on success.
|
|
*/
|
|
#define BRANCH_CONFIG_VERBOSE 01
|
|
int install_branch_config(int flag, const char *local, const char *origin, const char *remote);
|
|
|
|
/*
|
|
* Read branch description
|
|
*/
|
|
int read_branch_desc(struct strbuf *, const char *branch_name);
|
|
|
|
/*
|
|
* Check if a branch is checked out in the main worktree or any linked
|
|
* worktree and die (with a message describing its checkout location) if
|
|
* it is.
|
|
*/
|
|
void die_if_checked_out(const char *branch, int ignore_current_worktree);
|
|
|
|
/*
|
|
* Update all per-worktree HEADs pointing at the old ref to point the new ref.
|
|
* This will be used when renaming a branch. Returns 0 if successful, non-zero
|
|
* otherwise.
|
|
*/
|
|
int replace_each_worktree_head_symref(const char *oldref, const char *newref,
|
|
const char *logmsg);
|
|
|
|
#endif
|