thodg/libgit2/include/git2/worktree.h

• Show log

  Commit

• Hash : d3bc09e8
  Author :
  Date : 2015-10-21T12:02:31
  

  worktree: introduce `struct git_worktree`
  
  Introduce a new `struct git_worktree`, which holds information
  about a possible working tree connected to a repository.
  Introduce functions to allow opening working trees for a
  repository.
  

Download

• include/git2/worktree.h

• /*
   * 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_worktree_h__
  #define INCLUDE_git_worktree_h__
  
  #include "common.h"
  #include "types.h"
  #include "strarray.h"
  
  /**
   * @file git2/worktrees.h
   * @brief Git worktree related functions
   * @defgroup git_commit Git worktree related functions
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /**
   * List names of linked working trees
   *
   * The returned list should be released with `git_strarray_free`
   * when no longer needed.
   *
   * @param out pointer to the array of working tree names
   * @param repo the repo to use when listing working trees
   * @return 0 or an error code
   */
  GIT_EXTERN(int) git_worktree_list(git_strarray *out, git_repository *repo);
  
  /**
   * Lookup a working tree by its name for a given repository
   *
   * @param out Output pointer to looked up worktree or `NULL`
   * @param repo The repository containing worktrees
   * @param name Name of the working tree to look up
   * @return 0 or an error code
   */
  GIT_EXTERN(int) git_worktree_lookup(git_worktree **out, git_repository *repo, const char *name);
  
  /**
   * Free a previously allocated worktree
   *
   * @param wt worktree handle to close. If NULL nothing occurs.
   */
  GIT_EXTERN(void) git_worktree_free(git_worktree *wt);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download