thodg/libgit2/include/git2/indexer.h

• Show log

  Commit

• Hash : e1967164
  Author :
  Date : 2013-06-24T15:33:41
  

  Fixed most documentation header bugs Fixed a few header @param and @return typos with the help of -Wdocumentation in Xcode. The following warnings have not been fixed: common.h:213 - Not sure how the documentation format is for '...' notes.h:102 - Correct @param name but empty text notes.h:111 - Correct @param name but empty text pack.h:140 - @return missing text pack.h:148 - @return missing text

Download

• include/git2/indexer.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_indexer_h__
  #define _INCLUDE_git_indexer_h__
  
  #include "common.h"
  #include "types.h"
  #include "oid.h"
  
  GIT_BEGIN_DECL
  
  typedef struct git_indexer_stream git_indexer_stream;
  
  /**
   * Create a new streaming indexer instance
   *
   * @param out where to store the indexer instance
   * @param path to the directory where the packfile should be stored
   * @param progress_cb function to call with progress information
   * @param progress_cb_payload payload for the progress callback
   */
  GIT_EXTERN(int) git_indexer_stream_new(
  		git_indexer_stream **out,
  		const char *path,
  		git_transfer_progress_callback progress_cb,
  		void *progress_cb_payload);
  
  /**
   * Add data to the indexer
   *
   * @param idx the indexer
   * @param data the data to add
   * @param size the size of the data in bytes
   * @param stats stat storage
   */
  GIT_EXTERN(int) git_indexer_stream_add(git_indexer_stream *idx, const void *data, size_t size, git_transfer_progress *stats);
  
  /**
   * Finalize the pack and index
   *
   * Resolve any pending deltas and write out the index file
   *
   * @param idx the indexer
   */
  GIT_EXTERN(int) git_indexer_stream_finalize(git_indexer_stream *idx, git_transfer_progress *stats);
  
  /**
   * Get the packfile's hash
   *
   * A packfile's name is derived from the sorted hashing of all object
   * names. This is only correct after the index has been finalized.
   *
   * @param idx the indexer instance
   */
  GIT_EXTERN(const git_oid *) git_indexer_stream_hash(const git_indexer_stream *idx);
  
  /**
   * Free the indexer and its resources
   *
   * @param idx the indexer to free
   */
  GIT_EXTERN(void) git_indexer_stream_free(git_indexer_stream *idx);
  
  GIT_END_DECL
  
  #endif
  

Download