mirror of
https://github.com/git/git.git
synced 2024-06-20 06:10:17 +02:00
709f79b089
Created by a simple refactoring of initialize_notes(). Also add a new 'flags' parameter, which is a bitwise combination of notes initialization flags. For now, there is only one flag - NOTES_INIT_EMPTY - which indicates that the notes tree should not auto-load the contents of the given (or default) notes ref, but rather should leave the notes tree initialized to an empty state. This will become useful in the future when manipulating the notes tree through the notes API. Signed-off-by: Johan Herland <johan@herland.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
43 lines
1.3 KiB
C
43 lines
1.3 KiB
C
#ifndef NOTES_H
|
|
#define NOTES_H
|
|
|
|
/*
|
|
* Flags controlling behaviour of notes tree initialization
|
|
*
|
|
* Default behaviour is to initialize the notes tree from the tree object
|
|
* specified by the given (or default) notes ref.
|
|
*/
|
|
#define NOTES_INIT_EMPTY 1
|
|
|
|
/*
|
|
* Initialize internal notes tree structure with the notes tree at the given
|
|
* ref. If given ref is NULL, the value of the $GIT_NOTES_REF environment
|
|
* variable is used, and if that is missing, the default notes ref is used
|
|
* ("refs/notes/commits").
|
|
*
|
|
* If you need to re-intialize the internal notes tree structure (e.g. loading
|
|
* from a different notes ref), please first de-initialize the current notes
|
|
* tree by calling free_notes().
|
|
*/
|
|
void init_notes(const char *notes_ref, int flags);
|
|
|
|
/* Free (and de-initialize) the internal notes tree structure */
|
|
void free_notes(void);
|
|
|
|
/* Flags controlling how notes are formatted */
|
|
#define NOTES_SHOW_HEADER 1
|
|
#define NOTES_INDENT 2
|
|
|
|
/*
|
|
* Fill the given strbuf with the notes associated with the given object.
|
|
*
|
|
* If the internal notes structure is not initialized, it will be auto-
|
|
* initialized to the default value (see documentation for init_notes() above).
|
|
*
|
|
* 'flags' is a bitwise combination of the above formatting flags.
|
|
*/
|
|
void format_note(const unsigned char *object_sha1, struct strbuf *sb,
|
|
const char *output_encoding, int flags);
|
|
|
|
#endif
|