thodg/got/include/got_repository.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 : 2019-01-06 10:49:53
  Hash : 4b0bb327
  Message : document got_repo_get_path() and got_repo_get_path_git_dir()

• include/got_repository.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.
   */
  
  struct got_repository;
  
  /* Open and close repositories. */
  const struct got_error *got_repo_open(struct got_repository**, const char *);
  const struct got_error *got_repo_close(struct got_repository*);
  
  /* Obtain the on-disk path to the repository. */
  const char *got_repo_get_path(struct got_repository *);
  
  /*
   * Obtain the path to a non-bare repository's .git directory.
   * For bare repositories, this returns the same result as got_repo_get_path().
   */
  const char *got_repo_get_path_git_dir(struct got_repository *);
  
  /*
   * Obtain paths to various directories within a repository.
   * The caller must dispose of a path with free(3).
   */
  char *got_repo_get_path_objects(struct got_repository *);
  char *got_repo_get_path_objects_pack(struct got_repository *);
  char *got_repo_get_path_refs(struct got_repository *);
  
  struct got_reference;
  
  /*
   * Obtain a reference, by name, from a repository.
   * The caller must dispose of it with got_ref_close().
   */
  const struct got_error *got_repo_get_reference(struct got_reference **,
      struct got_repository *, const char *);
  
  
  /* Indicate whether this is a bare repositiry (contains no git working tree). */
  int got_repo_is_bare(struct got_repository *);
  
  /* Attempt to map an arbitrary path to a path within the repository. */
  const struct got_error *got_repo_map_path(char **, struct got_repository *,
      const char *, int);