mirror of
https://github.com/git/git
synced 2024-10-30 13:20:15 +00:00
06cf4f2d87
"git interpret-trailers" has been taught a "--parse" and a few other options to make it easier for scripts to grab existing trailer lines from a commit log message. * jk/trailers-parse: doc/interpret-trailers: fix "the this" typo pretty: support normalization options for %(trailers) t4205: refactor %(trailers) tests pretty: move trailer formatting to trailer.c interpret-trailers: add --parse convenience option interpret-trailers: add an option to unfold values interpret-trailers: add an option to show only existing trailers interpret-trailers: add an option to show only the trailers trailer: put process_trailers() options into a struct
98 lines
2.3 KiB
C
98 lines
2.3 KiB
C
#ifndef TRAILER_H
|
|
#define TRAILER_H
|
|
|
|
#include "list.h"
|
|
|
|
enum trailer_where {
|
|
WHERE_DEFAULT,
|
|
WHERE_END,
|
|
WHERE_AFTER,
|
|
WHERE_BEFORE,
|
|
WHERE_START
|
|
};
|
|
enum trailer_if_exists {
|
|
EXISTS_DEFAULT,
|
|
EXISTS_ADD_IF_DIFFERENT_NEIGHBOR,
|
|
EXISTS_ADD_IF_DIFFERENT,
|
|
EXISTS_ADD,
|
|
EXISTS_REPLACE,
|
|
EXISTS_DO_NOTHING
|
|
};
|
|
enum trailer_if_missing {
|
|
MISSING_DEFAULT,
|
|
MISSING_ADD,
|
|
MISSING_DO_NOTHING
|
|
};
|
|
|
|
int trailer_set_where(enum trailer_where *item, const char *value);
|
|
int trailer_set_if_exists(enum trailer_if_exists *item, const char *value);
|
|
int trailer_set_if_missing(enum trailer_if_missing *item, const char *value);
|
|
|
|
struct trailer_info {
|
|
/*
|
|
* True if there is a blank line before the location pointed to by
|
|
* trailer_start.
|
|
*/
|
|
int blank_line_before_trailer;
|
|
|
|
/*
|
|
* Pointers to the start and end of the trailer block found. If there
|
|
* is no trailer block found, these 2 pointers point to the end of the
|
|
* input string.
|
|
*/
|
|
const char *trailer_start, *trailer_end;
|
|
|
|
/*
|
|
* Array of trailers found.
|
|
*/
|
|
char **trailers;
|
|
size_t trailer_nr;
|
|
};
|
|
|
|
/*
|
|
* A list that represents newly-added trailers, such as those provided
|
|
* with the --trailer command line option of git-interpret-trailers.
|
|
*/
|
|
struct new_trailer_item {
|
|
struct list_head list;
|
|
|
|
const char *text;
|
|
|
|
enum trailer_where where;
|
|
enum trailer_if_exists if_exists;
|
|
enum trailer_if_missing if_missing;
|
|
};
|
|
|
|
struct process_trailer_options {
|
|
int in_place;
|
|
int trim_empty;
|
|
int only_trailers;
|
|
int only_input;
|
|
int unfold;
|
|
};
|
|
|
|
#define PROCESS_TRAILER_OPTIONS_INIT {0}
|
|
|
|
void process_trailers(const char *file,
|
|
const struct process_trailer_options *opts,
|
|
struct list_head *new_trailer_head);
|
|
|
|
void trailer_info_get(struct trailer_info *info, const char *str);
|
|
|
|
void trailer_info_release(struct trailer_info *info);
|
|
|
|
/*
|
|
* Format the trailers from the commit msg "msg" into the strbuf "out".
|
|
* Note two caveats about "opts":
|
|
*
|
|
* - this is primarily a helper for pretty.c, and not
|
|
* all of the flags are supported.
|
|
*
|
|
* - this differs from process_trailers slightly in that we always format
|
|
* only the trailer block itself, even if the "only_trailers" option is not
|
|
* set.
|
|
*/
|
|
void format_trailers_from_commit(struct strbuf *out, const char *msg,
|
|
const struct process_trailer_options *opts);
|
|
|
|
#endif /* TRAILER_H */
|