stash: remove now superfluos help for "stash push"
[git.git] / trailer.h
blob6d7f8c2a52305d3d937b69a877f1ae0b7af94363
1 #ifndef TRAILER_H
2 #define TRAILER_H
4 #include "list.h"
6 enum trailer_where {
7 WHERE_DEFAULT,
8 WHERE_END,
9 WHERE_AFTER,
10 WHERE_BEFORE,
11 WHERE_START
13 enum trailer_if_exists {
14 EXISTS_DEFAULT,
15 EXISTS_ADD_IF_DIFFERENT_NEIGHBOR,
16 EXISTS_ADD_IF_DIFFERENT,
17 EXISTS_ADD,
18 EXISTS_REPLACE,
19 EXISTS_DO_NOTHING
21 enum trailer_if_missing {
22 MISSING_DEFAULT,
23 MISSING_ADD,
24 MISSING_DO_NOTHING
27 int trailer_set_where(enum trailer_where *item, const char *value);
28 int trailer_set_if_exists(enum trailer_if_exists *item, const char *value);
29 int trailer_set_if_missing(enum trailer_if_missing *item, const char *value);
31 struct trailer_info {
33 * True if there is a blank line before the location pointed to by
34 * trailer_start.
36 int blank_line_before_trailer;
39 * Pointers to the start and end of the trailer block found. If there
40 * is no trailer block found, these 2 pointers point to the end of the
41 * input string.
43 const char *trailer_start, *trailer_end;
46 * Array of trailers found.
48 char **trailers;
49 size_t trailer_nr;
53 * A list that represents newly-added trailers, such as those provided
54 * with the --trailer command line option of git-interpret-trailers.
56 struct new_trailer_item {
57 struct list_head list;
59 const char *text;
61 enum trailer_where where;
62 enum trailer_if_exists if_exists;
63 enum trailer_if_missing if_missing;
66 struct process_trailer_options {
67 int in_place;
68 int trim_empty;
69 int only_trailers;
70 int only_input;
71 int unfold;
74 #define PROCESS_TRAILER_OPTIONS_INIT {0}
76 void process_trailers(const char *file,
77 const struct process_trailer_options *opts,
78 struct list_head *new_trailer_head);
80 void trailer_info_get(struct trailer_info *info, const char *str);
82 void trailer_info_release(struct trailer_info *info);
85 * Format the trailers from the commit msg "msg" into the strbuf "out".
86 * Note two caveats about "opts":
88 * - this is primarily a helper for pretty.c, and not
89 * all of the flags are supported.
91 * - this differs from process_trailers slightly in that we always format
92 * only the trailer block itself, even if the "only_trailers" option is not
93 * set.
95 void format_trailers_from_commit(struct strbuf *out, const char *msg,
96 const struct process_trailer_options *opts);
98 #endif /* TRAILER_H */