thodg/got/include/got_worktree.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_worktree.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_worktree;
  
  /*
   * Attempt to initialize a new work tree on disk.
   * The first argument is the path to a directory where the work tree
   * will be created. The path itself must not yet exist, but the dirname(3)
   * of the path must already exist.
   * The reference provided will be used as the new worktree's HEAD.
   * The third argument speficies the work tree's path prefix.
   */
  const struct got_error *got_worktree_init(const char *, struct got_reference *,
      const char *, struct got_repository *);
  
  /*
   * Attempt to open a worktree at the specified path.
   * The caller must dispose of it with got_worktree_close().
   */
  const struct got_error *got_worktree_open(struct got_worktree **, const char *);
  
  /* Dispose of an open work tree. */
  void got_worktree_close(struct got_worktree *);
  
  /*
   * Get the path to the repository associated with a worktree.
   * The caller must dispose of it with free(3).
   */
  char *got_worktree_get_repo_path(struct got_worktree *);
  
  /*
   * Get the name of a work tree's HEAD reference.
   * The caller must dispose of it with free(3).
   */
  char  *got_worktree_get_head_ref_name(struct got_worktree *);
  
  /* A callback function which is invoked when a path is checked out. */
  typedef void (*got_worktree_checkout_cb)(void *, const char *);
  
  /*
   * Attempt to check out files into a work tree from its associated repository
   * and path prefix, and update the work tree's file index accordingly.
   * File content is obtained from blobs within the work tree's path prefix
   * inside the tree resolved via the provided reference.
   * The checkout progress callback will be invoked with the provided
   * void * argument, and the path of each checked out file.
   */
  const struct got_error *got_worktree_checkout_files(struct got_worktree *,
      struct got_reference *, struct got_repository *,
      got_worktree_checkout_cb progress, void *);