Documentation
¶
Overview ¶
Package merge git-merge - Join two or more development histories together.
SYNOPSIS ¶
Reference: https://git-scm.com/docs/git-merge
git merge [-n] [--stat] [--no-commit] [--squash] [--[no-]edit] [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]] [--[no-]allow-unrelated-histories] [--[no-]rerere-autoupdate] [-m <msg>] [<commit>...] git merge --abort git merge --continue
DESCRIPTION ¶
Incorporates changes from the named commits (since the time their histories diverged from the current branch) into the current branch. This command is used by git pull to incorporate changes from another repository and can be used by hand to merge changes from one branch into another.
Assume the following history exists and the current branch is "master":
A---B---C topic / D---E---F---G master
Then "git merge topic" will replay the changes made on the topic branch since it diverged from master (i.e., E) until its current commit (C) on top of master, and record the result in a new commit along with the names of the two parent commits and a log message from the user describing the changes.
A---B---C topic / \ D---E---F---G---H master
The second syntax ("git merge --abort") can only be run after the merge has resulted in conflicts. git merge --abort will abort the merge process and try to reconstruct the pre-merge state. However, if there were uncommitted changes when the merge started (and especially if those changes were further modified after the merge was started), git merge --abort will in some cases be unable to reconstruct the original (pre-merge) changes. Therefore:
Warning: Running git merge with non-trivial uncommitted changes is discouraged: while possible, it may leave you in a state that is hard to back out of in the case of a conflict.
The fourth syntax ("git merge --continue") can only be run after the merge has resulted in conflicts.
Index ¶
- func Abort(g *types.Cmd)
- func AllowUnrelatedHistories(g *types.Cmd)
- func Commit(g *types.Cmd)
- func Commits(values ...string) func(*types.Cmd)
- func Continue(g *types.Cmd)
- func Edit(g *types.Cmd)
- func Ff(g *types.Cmd)
- func FfOnly(g *types.Cmd)
- func GpgSign(keyid string) func(*types.Cmd)
- func Log(n string) func(*types.Cmd)
- func M(msg string) func(*types.Cmd)
- func NoCommit(g *types.Cmd)
- func NoEdit(g *types.Cmd)
- func NoFf(g *types.Cmd)
- func NoLog(g *types.Cmd)
- func NoProgress(g *types.Cmd)
- func NoRerereAutoupdate(g *types.Cmd)
- func NoSquash(g *types.Cmd)
- func NoStat(g *types.Cmd)
- func NoSummary(g *types.Cmd)
- func NoVerifySignatures(g *types.Cmd)
- func Progress(g *types.Cmd)
- func Quiet(g *types.Cmd)
- func RerereAutoupdate(g *types.Cmd)
- func Squash(g *types.Cmd)
- func Stat(g *types.Cmd)
- func Strategy(value string) func(*types.Cmd)
- func StrategyOption(option string) func(*types.Cmd)
- func Summary(g *types.Cmd)
- func Verbose(g *types.Cmd)
- func VerifySignatures(g *types.Cmd)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Abort ¶
Abort Abort the current conflict resolution process, and try to reconstruct the pre-merge state. If there were uncommitted worktree changes present when the merge started, git merge --abort will in some cases be unable to reconstruct these changes. It is therefore recommended to always commit or stash your changes before running git merge. git merge --abort is equivalent to git reset --merge when MERGE_HEAD is present. --abort
func AllowUnrelatedHistories ¶
AllowUnrelatedHistories By default, git merge command refuses to merge histories that do not share a common ancestor. This option can be used to override this safety when merging histories of two projects that started their lives independently. As that is a very rare occasion, no configuration variable to enable this by default exists and will not be added. --allow-unrelated-histories
func Commit ¶
Commit Perform the merge and commit the result. This option can be used to override --no-commit. --commit, --no-commit
func Commits ¶
Commits <commit>... Commits, usually other branch heads, to merge into our branch. Specifying more than one commit will create a merge with more than two parents (affectionately called an Octopus merge).
func Continue ¶
Continue After a git merge stops due to conflicts you can conclude the merge by running git merge --continue (see 'HOW TO RESOLVE CONFLICTS' section below). --continue
func Edit ¶
Edit Invoke an editor before committing successful mechanical merge to further edit the auto-generated merge message, so that the user can explain and justify the merge. The --no-edit option can be used to accept the auto-generated message (this is generally discouraged). The --edit (or -e) option is still useful if you are giving a draft message with the -m option from the command line and want to edit it in the editor. Older scripts may depend on the historical behaviour of not allowing the user to edit the merge log message. They will see an editor opened when they run git merge. To make it easier to adjust such scripts to the updated behaviour, the environment variable GIT_MERGE_AUTOEDIT can be set to no at the beginning of them. --edit, -e, --no-edit
func Ff ¶
Ff When the merge resolves as a fast-forward, only update the branch pointer, without creating a merge commit. This is the default behavior. --ff
func FfOnly ¶
FfOnly Refuse to merge and exit with a non-zero status unless the current HEAD is already up-to-date or the merge can be resolved as a fast-forward. --ff-only
func GpgSign ¶
GpgSign GPG-sign the resulting merge commit. The keyid argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space. -S[<keyid>], --gpg-sign[=<keyid>]
func Log ¶
Log In addition to branch names, populate the log message with one-line descriptions from at most <n> actual commits that are being merged. See also git-fmt-merge-msg(1). With --no-log do not list one-line descriptions from the actual commits being merged. --log[=<n>], --no-log
func M ¶
M Set the commit message to be used for the merge commit (in case one is created). If --log is specified, a shortlog of the commits being merged will be appended to the specified message. The git fmt-merge-msg command can be used to give a good default for automated git merge invocations. The automated message can include the branch description. -m <msg>
func NoCommit ¶
NoCommit With --no-commit perform the merge but pretend the merge failed and do not autocommit, to give the user a chance to inspect and further tweak the merge result before committing. --commit, --no-commit
func NoEdit ¶
NoEdit Invoke an editor before committing successful mechanical merge to further edit the auto-generated merge message, so that the user can explain and justify the merge. The --no-edit option can be used to accept the auto-generated message (this is generally discouraged). The --edit (or -e) option is still useful if you are giving a draft message with the -m option from the command line and want to edit it in the editor. Older scripts may depend on the historical behaviour of not allowing the user to edit the merge log message. They will see an editor opened when they run git merge. To make it easier to adjust such scripts to the updated behaviour, the environment variable GIT_MERGE_AUTOEDIT can be set to no at the beginning of them. --edit, -e, --no-edit
func NoFf ¶
NoFf Create a merge commit even when the merge resolves as a fast-forward. This is the default behaviour when merging an annotated (and possibly signed) tag. --no-ff
func NoLog ¶
NoLog In addition to branch names, populate the log message with one-line descriptions from at most <n> actual commits that are being merged. See also git-fmt-merge-msg(1). With --no-log do not list one-line descriptions from the actual commits being merged. --log[=<n>], --no-log
func NoProgress ¶
NoProgress Turn progress on/off explicitly. If neither is specified, progress is shown if standard error is connected to a terminal. Note that not all merge strategies may support progress reporting. --progress, --no-progress
func NoRerereAutoupdate ¶
NoRerereAutoupdate Allow the rerere mechanism to update the index with the result of auto-conflict resolution if possible. --[no-]rerere-autoupdate
func NoSquash ¶
NoSquash Produce the working tree and index state as if a real merge happened (except for the merge information), but do not actually make a commit, move the HEAD, or record $GIT_DIR/MERGE_HEAD (to cause the next git commit command to create a merge commit). This allows you to create a single commit on top of the current branch whose effect is the same as merging another branch (or more in case of an octopus). With --no-squash perform the merge and commit the result. This option can be used to override --squash. --squash, --no-squash
func NoStat ¶
NoStat Show a diffstat at the end of the merge. The diffstat is also controlled by the configuration option merge.stat. With -n or --no-stat do not show a diffstat at the end of the merge. --stat, -n, --no-stat
func NoSummary ¶
NoSummary Synonyms to --stat and --no-stat; these are deprecated and will be removed in the future. --summary, --no-summary
func NoVerifySignatures ¶
NoVerifySignatures Verify that the tip commit of the side branch being merged is signed with a valid key, i.e. a key that has a valid uid: in the default trust model, this means the signing key has been signed by a trusted key. If the tip commit of the side branch is not signed with a valid key, the merge is aborted. --verify-signatures, --no-verify-signatures
func Progress ¶
Progress Turn progress on/off explicitly. If neither is specified, progress is shown if standard error is connected to a terminal. Note that not all merge strategies may support progress reporting. --progress, --no-progress
func RerereAutoupdate ¶
RerereAutoupdate Allow the rerere mechanism to update the index with the result of auto-conflict resolution if possible. --[no-]rerere-autoupdate
func Squash ¶
Squash Produce the working tree and index state as if a real merge happened (except for the merge information), but do not actually make a commit, move the HEAD, or record $GIT_DIR/MERGE_HEAD (to cause the next git commit command to create a merge commit). This allows you to create a single commit on top of the current branch whose effect is the same as merging another branch (or more in case of an octopus). With --no-squash perform the merge and commit the result. This option can be used to override --squash. --squash, --no-squash
func Stat ¶
Stat Show a diffstat at the end of the merge. The diffstat is also controlled by the configuration option merge.stat. With -n or --no-stat do not show a diffstat at the end of the merge. --stat, -n, --no-stat
func Strategy ¶
Strategy Use the given merge strategy; can be supplied more than once to specify them in the order they should be tried. If there is no -s option, a built-in list of strategies is used instead (git merge-recursive when merging a single head, git merge-octopus otherwise). -s <strategy>, --strategy=<strategy>
func StrategyOption ¶
StrategyOption Pass merge strategy specific option through to the merge strategy. -X <option>, --strategy-option=<option>
func Summary ¶
Summary Synonyms to --stat and --no-stat; these are deprecated and will be removed in the future. --summary, --no-summary
func VerifySignatures ¶
VerifySignatures Verify that the tip commit of the side branch being merged is signed with a valid key, i.e. a key that has a valid uid: in the default trust model, this means the signing key has been signed by a trusted key. If the tip commit of the side branch is not signed with a valid key, the merge is aborted. --verify-signatures, --no-verify-signatures
Types ¶
This section is empty.