notes-utils.hon commit diff-tree: update stale in-code comments (8ba74bf)
   1#ifndef NOTES_UTILS_H
   2#define NOTES_UTILS_H
   3
   4#include "notes.h"
   5
   6/*
   7 * Create new notes commit from the given notes tree
   8 *
   9 * Properties of the created commit:
  10 * - tree: the result of converting t to a tree object with write_notes_tree().
  11 * - parents: the given parents OR (if NULL) the commit referenced by t->ref.
  12 * - author/committer: the default determined by commit_tree().
  13 * - commit message: msg
  14 *
  15 * The resulting commit SHA1 is stored in result_sha1.
  16 */
  17void create_notes_commit(struct notes_tree *t, struct commit_list *parents,
  18                         const char *msg, size_t msg_len, unsigned char *result_sha1);
  19
  20void commit_notes(struct notes_tree *t, const char *msg);
  21
  22struct notes_rewrite_cfg {
  23        struct notes_tree **trees;
  24        const char *cmd;
  25        int enabled;
  26        combine_notes_fn combine;
  27        struct string_list *refs;
  28        int refs_from_env;
  29        int mode_from_env;
  30};
  31
  32struct notes_rewrite_cfg *init_copy_notes_for_rewrite(const char *cmd);
  33int copy_note_for_rewrite(struct notes_rewrite_cfg *c,
  34                          const unsigned char *from_obj, const unsigned char *to_obj);
  35void finish_copy_notes_for_rewrite(struct notes_rewrite_cfg *c, const char *msg);
  36
  37#endif