thodg/got/include/got_reference.h

Branch : - branch - main - tag - 0.1 0.10 0.11 0.12 0.13 0.14 0.15 0.16 0.17 0.18 0.19 0.2 0.20 0.21 0.22 0.23 0.24 0.25 0.26 0.27 0.28 0.29 0.3 0.30 0.31 0.32 0.33 0.34 0.35 0.36 0.37 0.38 0.39 0.4 0.40 0.41 0.42 0.43 0.44 0.45 0.46 0.47 0.48 0.49 0.5 0.50 0.51 0.52 0.53 0.54 0.55 0.56 0.57 0.58 0.59 0.6 0.60 0.61 0.62 0.63 0.64 0.65 0.66 0.67 0.68 0.69 0.7 0.70 0.71 0.72 0.8 0.9

• Show log

  Commit

• Author : Stefan Sperling
  Date : 2018-04-02 11:10:05
  Hash : 0c60ce5a
  Message : document the current public API

• include/got_reference.h

• /*
   * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
   *
   * Permission to use, copy, modify, and distribute this software for any
   * purpose with or without fee is hereby granted, provided that the above
   * copyright notice and this permission notice appear in all copies.
   *
   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
   */
  
  /* A reference which points to an arbitrary object. */
  struct got_reference;
  
  /* Well-known reference names. */
  #define GOT_REF_HEAD		"HEAD"
  #define GOT_REF_ORIG_HEAD	"ORIG_HEAD"
  #define GOT_REF_MERGE_HEAD	"MERGE_HEAD"
  #define GOT_REF_FETCH_HEAD	"FETCH_HEAD"
  
  struct got_repository;
  struct got_object_id;
  
  /*
   * Attempt to open the reference with the provided name in a repository.
   * The caller must dispose of it with got_ref_close().
   */
  const struct got_error * got_ref_open(struct got_reference **,
      struct got_repository *, const char *);
  
  /* Dispose of a reference. */
  void got_ref_close(struct got_reference *);
  
  /*
   * Create a duplicate copy of a reference.
   * The caller must dispose of this copy with got_ref_close().
   */
  struct got_reference *got_ref_dup(struct got_reference *);
  
  /* Attempt to resolve a reference to an object ID. */
  const struct got_error *got_ref_resolve(struct got_object_id **,
      struct got_repository *, struct got_reference *);
  
  /* Return a string representation of a reference. */
  char *got_ref_to_str(struct got_reference *);