thodg/libgit2/include/git2/branch.h

• Show log

  Commit

• Hash : 1a2b8725
  Author :
  Date : 2012-04-11T14:27:40
  

  Typedefs don't have enum in front

Download

• include/git2/branch.h

• /*
   * Copyright (C) 2009-2012 the libgit2 contributors
   *
   * 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_branch_h__
  #define INCLUDE_git_branch_h__
  
  #include "common.h"
  #include "types.h"
  
  /**
   * @file git2/branch.h
   * @brief Git branch parsing routines
   * @defgroup git_branch Git branch management
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /**
   * Create a new branch pointing at a target commit
   *
   * A new direct reference will be created pointing to
   * this target commit. If `force` is true and a reference
   * already exists with the given name, it'll be replaced.
   *
   * @param oid_out Pointer where to store the OID of the target commit.
   *
   * @param repo Repository where to store the branch.
   *
   * @param branch_name Name for the branch; this name is
   * validated for consistency. It should also not conflict with
   * an already existing branch name.
   *
   * @param target Object to which this branch should point. This object
   * must belong to the given `repo` and can either be a git_commit or a
   * git_tag. When a git_tag is being passed, it should be dereferencable
   * to a git_commit which oid will be used as the target of the branch.
   *
   * @param force Overwrite existing branch.
   *
   * @return GIT_SUCCESS or an error code.
   * A proper reference is written in the refs/heads namespace
   * pointing to the provided target commit.
   */
  GIT_EXTERN(int) git_branch_create(
  		git_oid *oid_out,
  		git_repository *repo,
  		const char *branch_name,
  		const git_object *target,
  		int force);
  
  /**
   * Delete an existing branch reference.
   *
   * @param repo Repository where lives the branch.
   *
   * @param branch_name Name of the branch to be deleted;
   * this name is validated for consistency.
   *
   * @param branch_type Type of the considered branch. This should
   * be valued with either GIT_BRANCH_LOCAL or GIT_BRANCH_REMOTE.
   *
   * @return GIT_SUCCESS on success, GIT_ENOTFOUND if the branch
   * doesn't exist or an error code.
   */
  GIT_EXTERN(int) git_branch_delete(
  		git_repository *repo,
  		const char *branch_name,
  		git_branch_type branch_type);
  
  /**
   * Fill a list with all the branches in the Repository
   *
   * The string array will be filled with the names of the
   * matching branches; these values are owned by the user and
   * should be free'd manually when no longer needed, using
   * `git_strarray_free`.
   *
   * @param branch_names Pointer to a git_strarray structure
   * where the branch names will be stored.
   *
   * @param repo Repository where to find the branches.
   *
   * @param list_flags Filtering flags for the branch
   * listing. Valid values are GIT_BRANCH_LOCAL, GIT_BRANCH_REMOTE
   * or a combination of the two.
   *
   * @return GIT_SUCCESS or an error code.
   */
  GIT_EXTERN(int) git_branch_list(
  		git_strarray *branch_names,
  		git_repository *repo,
  		unsigned int list_flags);
  
  /**
   * Move/rename an existing branch reference.
   *
   * @param repo Repository where lives the branch.
   *
   * @param old_branch_name Current name of the branch to be moved;
   * this name is validated for consistency.
   *
   * @param new_branch_name Target name of the branch once the move
   * is performed; this name is validated for consistency.
   *
   * @param force Overwrite existing branch.
   *
   * @return GIT_SUCCESS on success, GIT_ENOTFOUND if the branch
   * doesn't exist or an error code.
   */
  GIT_EXTERN(int) git_branch_move(
  		git_repository *repo,
  		const char *old_branch_name,
  		const char *new_branch_name,
  		int force);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download