thodg/libgit2/include/git2/tag.h

• Show log

  Commit

• Hash : 72a3fe42
  Author :
  Date : 2011-03-18T19:38:49
  

  I broke your bindings Hey. Apologies in advance -- I broke your bindings. This is a major commit that includes a long-overdue redesign of the whole object-database structure. This is expected to be the last major external API redesign of the library until the first non-alpha release. Please get your bindings up to date with these changes. They will be included in the next minor release. Sorry again! Major features include: - Real caching and refcounting on parsed objects - Real caching and refcounting on objects read from the ODB - Streaming writes & reads from the ODB - Single-method writes for all object types - The external API is now partially thread-safe The speed increases are significant in all aspects, specially when reading an object several times from the ODB (revwalking) and when writing big objects to the ODB. Here's a full changelog for the external API: blob.h ------ - Remove `git_blob_new` - Remove `git_blob_set_rawcontent` - Remove `git_blob_set_rawcontent_fromfile` - Rename `git_blob_writefile` -> `git_blob_create_fromfile` - Change `git_blob_create_fromfile`: The `path` argument is now relative to the repository's working dir - Add `git_blob_create_frombuffer` commit.h -------- - Remove `git_commit_new` - Remove `git_commit_add_parent` - Remove `git_commit_set_message` - Remove `git_commit_set_committer` - Remove `git_commit_set_author` - Remove `git_commit_set_tree` - Add `git_commit_create` - Add `git_commit_create_v` - Add `git_commit_create_o` - Add `git_commit_create_ov` tag.h ----- - Remove `git_tag_new` - Remove `git_tag_set_target` - Remove `git_tag_set_name` - Remove `git_tag_set_tagger` - Remove `git_tag_set_message` - Add `git_tag_create` - Add `git_tag_create_o` tree.h ------ - Change `git_tree_entry_2object`: New signature is `(git_object **object_out, git_repository *repo, git_tree_entry *entry)` - Remove `git_tree_new` - Remove `git_tree_add_entry` - Remove `git_tree_remove_entry_byindex` - Remove `git_tree_remove_entry_byname` - Remove `git_tree_clearentries` - Remove `git_tree_entry_set_id` - Remove `git_tree_entry_set_name` - Remove `git_tree_entry_set_attributes` object.h ------------ - Remove `git_object_new - Remove `git_object_write` - Change `git_object_close`: This method is now *mandatory*. Not closing an object causes a memory leak. odb.h ----- - Remove type `git_rawobj` - Remove `git_rawobj_close` - Rename `git_rawobj_hash` -> `git_odb_hash` - Change `git_odb_hash`: New signature is `(git_oid *id, const void *data, size_t len, git_otype type)` - Add type `git_odb_object` - Add `git_odb_object_close` - Change `git_odb_read`: New signature is `(git_odb_object **out, git_odb *db, const git_oid *id)` - Change `git_odb_read_header`: New signature is `(size_t *len_p, git_otype *type_p, git_odb *db, const git_oid *id)` - Remove `git_odb_write` - Add `git_odb_open_wstream` - Add `git_odb_open_rstream` odb_backend.h ------------- - Change type `git_odb_backend`: New internal signatures are as follows int (* read)(void **, size_t *, git_otype *, struct git_odb_backend *, const git_oid *) int (* read_header)(size_t *, git_otype *, struct git_odb_backend *, const git_oid *) int (* writestream)(struct git_odb_stream **, struct git_odb_backend *, size_t, git_otype) int (* readstream)( struct git_odb_stream **, struct git_odb_backend *, const git_oid *) - Add type `git_odb_stream` - Add enum `git_odb_streammode` Signed-off-by: Vicent Marti <tanoku@gmail.com>

Download

• include/git2/tag.h

• /*
   * This file is free software; you can redistribute it and/or modify
   * it under the terms of the GNU General Public License, version 2,
   * as published by the Free Software Foundation.
   *
   * In addition to the permissions in the GNU General Public License,
   * the authors give you unlimited permission to link the compiled
   * version of this file into combinations with other programs,
   * and to distribute those combinations without any restriction
   * coming from the use of this file.  (The General Public License
   * restrictions do apply in other respects; for example, they cover
   * modification of the file, and distribution when not linked into
   * a combined executable.)
   *
   * This file is distributed in the hope that it will be useful, but
   * WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   * General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with this program; see the file COPYING.  If not, write to
   * the Free Software Foundation, 51 Franklin Street, Fifth Floor,
   * Boston, MA 02110-1301, USA.
   */
  #ifndef INCLUDE_git_tag_h__
  #define INCLUDE_git_tag_h__
  
  #include "common.h"
  #include "types.h"
  #include "oid.h"
  #include "object.h"
  
  /**
   * @file git2/tag.h
   * @brief Git tag parsing routines
   * @defgroup git_tag Git tag management
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /**
   * Lookup a tag object from the repository.
   *
   * @param tag pointer to the looked up tag
   * @param repo the repo to use when locating the tag.
   * @param id identity of the tag to locate.
   * @return 0 on success; error code otherwise
   */
  GIT_INLINE(int) git_tag_lookup(git_tag **tag, git_repository *repo, const git_oid *id)
  {
  	return git_object_lookup((git_object **)tag, repo, id, (git_otype)GIT_OBJ_TAG);
  }
  
  /**
   * Get the id of a tag.
   *
   * @param tag a previously loaded tag.
   * @return object identity for the tag.
   */
  GIT_EXTERN(const git_oid *) git_tag_id(git_tag *tag);
  
  /**
   * Get the tagged object of a tag
   *
   * This method performs a repository lookup for the
   * given object and returns it
   *
   * @param target pointer where to store the target
   * @param tag a previously loaded tag.
   * @return 0 on success; error code otherwise
   */
  GIT_EXTERN(int) git_tag_target(git_object **target, git_tag *t);
  
  /**
   * Get the OID of the tagged object of a tag
   *
   * @param tag a previously loaded tag.
   * @return pointer to the OID
   */
  GIT_EXTERN(const git_oid *) git_tag_target_oid(git_tag *t);
  
  /**
   * Get the type of a tag's tagged object
   *
   * @param tag a previously loaded tag.
   * @return type of the tagged object
   */
  GIT_EXTERN(git_otype) git_tag_type(git_tag *t);
  
  /**
   * Get the name of a tag
   *
   * @param tag a previously loaded tag.
   * @return name of the tag
   */
  GIT_EXTERN(const char *) git_tag_name(git_tag *t);
  
  /**
   * Get the tagger (author) of a tag
   *
   * @param tag a previously loaded tag.
   * @return reference to the tag's author
   */
  GIT_EXTERN(const git_signature *) git_tag_tagger(git_tag *t);
  
  /**
   * Get the message of a tag
   *
   * @param tag a previously loaded tag.
   * @return message of the tag
   */
  GIT_EXTERN(const char *) git_tag_message(git_tag *t);
  
  
  /**
   * Create a new tag in the repository from an OID
   *
   * @param oid Pointer where to store the OID of the
   *	newly created tag
   *
   * @param repo Repository where to store the tag
   *
   * @param tag_name Name for the tag; this name is validated
   * for consistency
   *
   * @param target OID to which this tag points; note that no
   *	validation is done on this OID. Use the _o version of this
   *	method to assure a proper object is being tagged
   *
   * @param target_type Type of the tagged OID; note that no
   *	validation is performed here either
   *
   * @param tagger Signature of the tagger for this tag, and
   *  of the tagging time
   *
   * @param message Full message for this tag
   *
   * @return 0 on success; error code otherwise.
   *	A tag object is written to the ODB, and a proper reference
   *	is written in the /refs/tags folder, pointing to it
   */
  GIT_EXTERN(int) git_tag_create(
  		git_oid *oid,
  		git_repository *repo,
  		const char *tag_name,
  		const git_oid *target,
  		git_otype target_type,
  		const git_signature *tagger,
  		const char *message);
  
  
  /**
   * Create a new tag in the repository from an existing
   * `git_object` instance
   *
   * This method replaces the `target` and `target_type`
   * paremeters of `git_tag_create` by a single instance
   * of a `const git_object *`, which is assured to be
   * a proper object in the ODB and hence will create
   * a valid tag
   *
   * @see git_tag_create
   */
  GIT_EXTERN(int) git_tag_create_o(
  		git_oid *oid,
  		git_repository *repo,
  		const char *tag_name,
  		const git_object *target,
  		const git_signature *tagger,
  		const char *message);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download