mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

format: create docs for pretty.h

Browse Source 
Write some docs for functions in pretty.h.
Take it as a first draft, they would be changed later.

Signed-off-by: Olga Telezhnaia <olyatelezhnaya@gmail.com>
Mentored-by: Christian Couder <christian.couder@gmail.com>
Mentored by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Olga Telezhnaya
2017-12-12 08:55:35 +00:00
committed by Junio C Hamano
parent cf3947193c
commit d0e6326026
1 changed files with 44 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
pretty.h
View File

@ -48,6 +48,7 @@ struct pretty_print_context {
int graph_width; int graph_width;
}; };
/* Check whether commit format is mail. */
static inline int cmit_fmt_is_mail(enum cmit_fmt fmt) static inline int cmit_fmt_is_mail(enum cmit_fmt fmt)
{ {
return (fmt == CMIT_FMT_EMAIL || fmt == CMIT_FMT_MBOXRD); return (fmt == CMIT_FMT_EMAIL || fmt == CMIT_FMT_MBOXRD);
@ -57,31 +58,74 @@ struct userformat_want {
unsigned notes:1; unsigned notes:1;
}; };
/* Set the flag "w->notes" if there is placeholder %N in "fmt". */
void userformat_find_requirements(const char *fmt, struct userformat_want *w); void userformat_find_requirements(const char *fmt, struct userformat_want *w);
/*
* Shortcut for invoking pretty_print_commit if we do not have any context.
* Context would be set empty except "fmt".
*/
void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit, void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
struct strbuf *sb); struct strbuf *sb);
/*
* Get information about user and date from "line", format it and
* put it into "sb".
* Format of "line" must be readable for split_ident_line function.
* The resulting format is "what: name <email> date".
*/
void pp_user_info(struct pretty_print_context *pp, const char *what, void pp_user_info(struct pretty_print_context *pp, const char *what,
struct strbuf *sb, const char *line, struct strbuf *sb, const char *line,
const char *encoding); const char *encoding);
/*
* Format title line of commit message taken from "msg_p" and
* put it into "sb".
* First line of "msg_p" is also affected.
*/
void pp_title_line(struct pretty_print_context *pp, const char **msg_p, void pp_title_line(struct pretty_print_context *pp, const char **msg_p,
struct strbuf *sb, const char *encoding, struct strbuf *sb, const char *encoding,
int need_8bit_cte); int need_8bit_cte);
/*
* Get current state of commit message from "msg_p" and continue formatting
* by adding indentation and '>' signs. Put result into "sb".
*/
void pp_remainder(struct pretty_print_context *pp, const char **msg_p, void pp_remainder(struct pretty_print_context *pp, const char **msg_p,
struct strbuf *sb, int indent); struct strbuf *sb, int indent);
/*
* Create a text message about commit using given "format" and "context".
* Put the result to "sb".
* Please use this function for custom formats.
*/
void format_commit_message(const struct commit *commit, void format_commit_message(const struct commit *commit,
const char *format, struct strbuf *sb, const char *format, struct strbuf *sb,
const struct pretty_print_context *context); const struct pretty_print_context *context);
/*
* Parse given arguments from "arg", check it for correctness and
* fill struct rev_info.
*/
void get_commit_format(const char *arg, struct rev_info *); void get_commit_format(const char *arg, struct rev_info *);
/*
* Make a commit message with all rules from given "pp"
* and put it into "sb".
* Please use this function if you have a context (candidate for "pp").
*/
void pretty_print_commit(struct pretty_print_context *pp, void pretty_print_commit(struct pretty_print_context *pp,
const struct commit *commit, const struct commit *commit,
struct strbuf *sb); struct strbuf *sb);
/*
* Change line breaks in "msg" to "line_separator" and put it into "sb".
* Return "msg" itself.
*/
const char *format_subject(struct strbuf *sb, const char *msg, const char *format_subject(struct strbuf *sb, const char *msg,
const char *line_separator); const char *line_separator);
/* Check if "cmit_fmt" will produce an empty output. */
int commit_format_is_empty(enum cmit_fmt); int commit_format_is_empty(enum cmit_fmt);
#endif /* PRETTY_H */ #endif /* PRETTY_H */