thodg/libgit2/include/git2/checkout.h

• Show log

  Commit

• Hash : 746642a6
  Author :
  Date : 2012-08-20T12:30:54
  

  checkout: fix documentation code alignment

Download

• include/git2/checkout.h

• /*
   * Copyright (C) 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_checkout_h__
  #define INCLUDE_git_checkout_h__
  
  #include "common.h"
  #include "types.h"
  #include "indexer.h"
  
  
  /**
   * @file git2/checkout.h
   * @brief Git checkout routines
   * @defgroup git_checkout Git checkout routines
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  
  #define GIT_CHECKOUT_OVERWRITE_EXISTING 0 /* default */
  #define GIT_CHECKOUT_SKIP_EXISTING 1
  
  /* Use zeros to indicate default settings */
  typedef struct git_checkout_opts {
  	int existing_file_action; /* default: GIT_CHECKOUT_OVERWRITE_EXISTING */
  	int disable_filters;
  	int dir_mode; /* default is 0755 */
  	int file_mode; /* default is 0644 */
  	int file_open_flags; /* default is O_CREAT | O_TRUNC | O_WRONLY */
  } git_checkout_opts;
  
  /**
   * Updates files in the working tree to match the commit pointed to by HEAD.
   *
   * @param repo repository to check out (must be non-bare)
   * @param opts specifies checkout options (may be NULL)
   * @param stats structure through which progress information is reported
   * @return 0 on success, GIT_ERROR otherwise (use giterr_last for information
   * about the error)
   */
  GIT_EXTERN(int) git_checkout_head(
  	git_repository *repo,
  	git_checkout_opts *opts,
  	git_indexer_stats *stats);
  
  /**
   * Updates files in the working tree to match a commit pointed to by a ref.
   *
   * @param ref reference to follow to a commit
   * @param opts specifies checkout options (may be NULL)
   * @param stats structure through which progress information is reported
   * @return 0 on success, GIT_ERROR otherwise (use giterr_last for information
   * about the error)
   */
  GIT_EXTERN(int) git_checkout_reference(
  	git_reference *ref,
  	git_checkout_opts *opts,
  	git_indexer_stats *stats);
  
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download