mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-03 01:58:32 +00:00
93a7004cc2
Already cherry-picked commits should not be re-included. If all changes included in a commit exist in the upstream, then we should error with GIT_EAPPLIED.
130 lines
4.2 KiB
C
130 lines
4.2 KiB
C
/*
|
|
* Copyright (C) the libgit2 contributors. All rights reserved.
|
|
*
|
|
* This file is part of libgit2, distributed under the GNU GPL v2 with
|
|
* a Linking Exception. For full terms see the included COPYING file.
|
|
*/
|
|
#ifndef INCLUDE_git_rebase_h__
|
|
#define INCLUDE_git_rebase_h__
|
|
|
|
#include "common.h"
|
|
#include "types.h"
|
|
#include "oid.h"
|
|
|
|
/**
|
|
* @file git2/rebase.h
|
|
* @brief Git rebase routines
|
|
* @defgroup git_rebase Git merge routines
|
|
* @ingroup Git
|
|
* @{
|
|
*/
|
|
GIT_BEGIN_DECL
|
|
|
|
typedef struct {
|
|
unsigned int version;
|
|
|
|
/**
|
|
* Provide a quiet rebase experience; unused by libgit2 but provided for
|
|
* interoperability with other clients.
|
|
*/
|
|
int quiet;
|
|
} git_rebase_options;
|
|
|
|
#define GIT_REBASE_OPTIONS_VERSION 1
|
|
#define GIT_REBASE_OPTIONS_INIT {GIT_REBASE_OPTIONS_VERSION}
|
|
|
|
/**
|
|
* Initializes a `git_rebase_options` with default values. Equivalent to
|
|
* creating an instance with GIT_REBASE_OPTIONS_INIT.
|
|
*
|
|
* @param opts the `git_rebase_options` instance to initialize.
|
|
* @param version the version of the struct; you should pass
|
|
* `GIT_REBASE_OPTIONS_VERSION` here.
|
|
* @return Zero on success; -1 on failure.
|
|
*/
|
|
GIT_EXTERN(int) git_rebase_init_options(
|
|
git_rebase_options *opts,
|
|
unsigned int version);
|
|
|
|
/**
|
|
* Sets up a rebase operation to rebase the changes in ours relative to
|
|
* upstream onto another branch.
|
|
*
|
|
* @param repo The repository to perform the rebase
|
|
* @param branch The terminal commit to rebase
|
|
* @param upstream The commit to begin rebasing from, or NULL to rebase all
|
|
* reachable commits
|
|
* @param onto The branch to rebase onto, or NULL to rebase onto the given
|
|
* upstream
|
|
* @param signature The signature of the rebaser
|
|
* @param opts Options to specify how rebase is performed
|
|
* @return Zero on success; -1 on failure.
|
|
*/
|
|
GIT_EXTERN(int) git_rebase(
|
|
git_repository *repo,
|
|
const git_merge_head *branch,
|
|
const git_merge_head *upstream,
|
|
const git_merge_head *onto,
|
|
const git_signature *signature,
|
|
const git_rebase_options *opts);
|
|
|
|
/**
|
|
* Applies the next patch, updating the index and working directory with the
|
|
* changes. If there are conflicts, you will need to address those before
|
|
* committing the changes.
|
|
*
|
|
* @param repo The repository with a rebase in progress
|
|
* @param checkout_opts Options to specify how the patch should be checked out
|
|
* @return Zero on success; -1 on failure.
|
|
*/
|
|
GIT_EXTERN(int) git_rebase_next(
|
|
git_repository *repo,
|
|
git_checkout_options *checkout_opts);
|
|
|
|
/**
|
|
* Commits the current patch. You must have resolved any conflicts that
|
|
* were introduced during the patch application from the `git_rebase_next`
|
|
* invocation.
|
|
*
|
|
* @param id Pointer in which to store the OID of the newly created commit
|
|
* @param repo The repository with the in-progress rebase
|
|
* @param author The author of the updated commit, or NULL to keep the
|
|
* author from the original commit
|
|
* @param committer The committer of the rebase
|
|
* @param message_encoding The encoding for the message in the commit,
|
|
* represented with a standard encoding name. If message is NULL,
|
|
* this should also be NULL, and the encoding from the original
|
|
* commit will be maintained. If message is specified, this may be
|
|
* NULL to indicate that "UTF-8" is to be used.
|
|
* @param message The message for this commit, or NULL to keep the message
|
|
* from the original commit
|
|
* @return Zero on success, GIT_EUNMERGED if there are unmerged changes in
|
|
* the index, GIT_EAPPLIED if the current commit has already
|
|
* been applied to the upstream and there is nothing to commit,
|
|
* -1 on failure.
|
|
*/
|
|
GIT_EXTERN(int) git_rebase_commit(
|
|
git_oid *id,
|
|
git_repository *repo,
|
|
const git_signature *author,
|
|
const git_signature *committer,
|
|
const char *message_encoding,
|
|
const char *message);
|
|
|
|
/**
|
|
* Aborts a rebase that is currently in progress, resetting the repository
|
|
* and working directory to their state before rebase began.
|
|
*
|
|
* @param repo The repository with the in-progress rebase
|
|
* @param signature The identity that is aborting the rebase
|
|
* @return Zero on success; GIT_ENOTFOUND if a rebase is not in progress,
|
|
* -1 on other errors.
|
|
*/
|
|
GIT_EXTERN(int) git_rebase_abort(
|
|
git_repository *repo,
|
|
const git_signature *signature);
|
|
|
|
/** @} */
|
|
GIT_END_DECL
|
|
#endif
|