Skip to content

Commit

Permalink
commit: add "#" characters to commit advice automatically
Browse files Browse the repository at this point in the history 
Let the text pass through gettext, but the functional part not do so.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
  • Loading branch information
@jrn @avar
jrn authored and avar committed Feb 23, 2011
1 parent 394a9d1 commit da15d84
Show file tree
Hide file tree
Showing 2 changed files with 112 additions and 68 deletions.
87 changes: 64 additions & 23 deletions builtin/commit.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,47 @@ static char *cut_ident_timestamp_part(char *string)
return ket;
}

__attribute__((format(printf, 4, 5)))
void fprintf_commented(FILE *fp, int mid_line, const char *color, const char *fmt, ...)
{
struct strbuf sb = STRBUF_INIT;
struct strbuf linebuf = STRBUF_INIT;
const char *line, *eol;
va_list ap;

va_start(ap, fmt);
strbuf_vaddf(&sb, fmt, ap);
va_end(ap);

if (!*sb.buf) {
color_fprintf(fp, color, "# ");
return;
}
for (line = sb.buf; ; line = eol + 1) {
eol = strchr(line, '\n');

if (!eol && !*line)
break; /* "...\n" */
strbuf_reset(&linebuf);
if (!mid_line) {
strbuf_addch(&linebuf, '#');
if (*line && *line != '\t')
strbuf_addch(&linebuf, ' ');
}
if (eol) {
strbuf_add(&linebuf, line, eol - line);
color_fprintf_ln(fp, color, "%s", linebuf.buf);
} else {
strbuf_addstr(&linebuf, line);
color_fprintf(fp, color, "%s", linebuf.buf);
break;
}
mid_line = 0;
}
strbuf_release(&linebuf);
strbuf_release(&sb);
}

static int prepare_to_commit(const char *index_file, const char *prefix,
struct wt_status *s,
struct strbuf *author_ident)
Expand Down Expand Up @@ -695,50 +736,50 @@ static int prepare_to_commit(const char *index_file, const char *prefix,
if (use_editor && include_status) {
char *ai_tmp, *ci_tmp;
if (in_merge)
fprintf(fp,
_("#\n"
"# It looks like you may be committing a MERGE.\n"
"# If this is not correct, please remove the file\n"
"# %s\n"
"# and try again.\n"
"#\n"),
fprintf_commented(fp, 0, "",
_("\n"
"It looks like you may be committing a MERGE.\n"
"If this is not correct, please remove the file\n"
" %s\n"
"and try again.\n"
"\n"),
git_path("MERGE_HEAD"));

fprintf(fp,
_("\n"
"# Please enter the commit message for your changes."));
fprintf(fp, "\n");
fprintf_commented(fp, 0, "",
_("Please enter the commit message for your changes."));
if (cleanup_mode == CLEANUP_ALL)
fprintf(fp,
fprintf_commented(fp, 1, "",
_(" Lines starting\n"
"# with '#' will be ignored, and an empty"
"with '#' will be ignored, and an empty"
" message aborts the commit.\n"));
else /* CLEANUP_SPACE, that is. */
fprintf(fp,
fprintf_commented(fp, 1, "",
_(" Lines starting\n"
"# with '#' will be kept; you may remove them"
"with '#' will be kept; you may remove them"
" yourself if you want to.\n"
"# An empty message aborts the commit.\n"));
"An empty message aborts the commit.\n"));
if (only_include_assumed)
fprintf(fp, "# %s\n", only_include_assumed);
fprintf_commented(fp, 0, "", "%s\n", only_include_assumed);

ai_tmp = cut_ident_timestamp_part(author_ident->buf);
ci_tmp = cut_ident_timestamp_part(committer_ident.buf);
if (strcmp(author_ident->buf, committer_ident.buf))
fprintf(fp,
fprintf_commented(fp, 0, "",
_("%s"
"# Author: %s\n"),
ident_shown++ ? "" : "#\n",
"Author: %s\n"),
ident_shown++ ? "" : "\n",
author_ident->buf);

if (!user_ident_sufficiently_given())
fprintf(fp,
fprintf_commented(fp, 0, "",
_("%s"
"# Committer: %s\n"),
ident_shown++ ? "" : "#\n",
"Committer: %s\n"),
ident_shown++ ? "" : "\n",
committer_ident.buf);

if (ident_shown)
fprintf(fp, "#\n");
fprintf_commented(fp, 0, "", "\n");

saved_color_setting = s->use_color;
s->use_color = 0;
Expand Down
93 changes: 48 additions & 45 deletions wt-status.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
#include "refs.h"
#include "submodule.h"

__attribute__((format(printf, 4, 5)))
extern void fprintf_commented(FILE *fp, int mid_line, const char *color, const char *fmt, ...);

static char default_wt_status_colors[][COLOR_MAXLEN] = {
GIT_COLOR_NORMAL, /* WT_STATUS_HEADER */
GIT_COLOR_GREEN, /* WT_STATUS_UPDATED */
Expand Down Expand Up @@ -57,33 +60,33 @@ static void wt_status_print_unmerged_header(struct wt_status *s)
{
const char *c = color(WT_STATUS_HEADER, s);

color_fprintf_ln(s->fp, c, _("# Unmerged paths:"));
fprintf_commented(s->fp, 0, c, _("Unmerged paths:\n"));
if (!advice_status_hints)
return;
if (s->in_merge)
;
else if (!s->is_initial)
color_fprintf_ln(s->fp, c, _("# (use \"git reset %s <file>...\" to unstage)"), s->reference);
fprintf_commented(s->fp, 0, c, _(" (use \"git reset %s <file>...\" to unstage)\n"), s->reference);
else
color_fprintf_ln(s->fp, c, _("# (use \"git rm --cached <file>...\" to unstage)"));
color_fprintf_ln(s->fp, c, _("# (use \"git add/rm <file>...\" as appropriate to mark resolution)"));
color_fprintf_ln(s->fp, c, "#");
fprintf_commented(s->fp, 0, c, _(" (use \"git rm --cached <file>...\" to unstage)\n"));
fprintf_commented(s->fp, 0, c, _(" (use \"git add/rm <file>...\" as appropriate to mark resolution)\n"));
fprintf_commented(s->fp, 0, c, "\n");
}

static void wt_status_print_cached_header(struct wt_status *s)
{
const char *c = color(WT_STATUS_HEADER, s);

color_fprintf_ln(s->fp, c, _("# Changes to be committed:"));
fprintf_commented(s->fp, 0, c, _("Changes to be committed:\n"));
if (!advice_status_hints)
return;
if (s->in_merge)
; /* NEEDSWORK: use "git reset --unresolve"??? */
else if (!s->is_initial)
color_fprintf_ln(s->fp, c, _("# (use \"git reset %s <file>...\" to unstage)"), s->reference);
fprintf_commented(s->fp, 0, c, _(" (use \"git reset %s <file>...\" to unstage)\n"), s->reference);
else
color_fprintf_ln(s->fp, c, _("# (use \"git rm --cached <file>...\" to unstage)"));
color_fprintf_ln(s->fp, c, "#");
fprintf_commented(s->fp, 0, c, _(" (use \"git rm --cached <file>...\" to unstage)\n"));
fprintf_commented(s->fp, 0, c, "\n");
}

static void wt_status_print_dirty_header(struct wt_status *s,
Expand All @@ -92,34 +95,34 @@ static void wt_status_print_dirty_header(struct wt_status *s,
{
const char *c = color(WT_STATUS_HEADER, s);

color_fprintf_ln(s->fp, c, _("# Changes not staged for commit:"));
fprintf_commented(s->fp, 0, c, _("Changes not staged for commit:\n"));
if (!advice_status_hints)
return;
if (!has_deleted)
color_fprintf_ln(s->fp, c, _("# (use \"git add <file>...\" to update what will be committed)"));
fprintf_commented(s->fp, 0, c, _(" (use \"git add <file>...\" to update what will be committed)\n"));
else
color_fprintf_ln(s->fp, c, _("# (use \"git add/rm <file>...\" to update what will be committed)"));
color_fprintf_ln(s->fp, c, _("# (use \"git checkout -- <file>...\" to discard changes in working directory)"));
fprintf_commented(s->fp, 0, c, _(" (use \"git add/rm <file>...\" to update what will be committed)\n"));
fprintf_commented(s->fp, 0, c, _(" (use \"git checkout -- <file>...\" to discard changes in working directory)\n"));
if (has_dirty_submodules)
color_fprintf_ln(s->fp, c, _("# (commit or discard the untracked or modified content in submodules)"));
color_fprintf_ln(s->fp, c, "#");
fprintf_commented(s->fp, 0, c, _(" (commit or discard the untracked or modified content in submodules)\n"));
fprintf_commented(s->fp, 0, c, "\n");
}

static void wt_status_print_other_header(struct wt_status *s,
const char *what,
const char *how)
{
const char *c = color(WT_STATUS_HEADER, s);
color_fprintf_ln(s->fp, c, _("# %s files:"), what);
fprintf_commented(s->fp, 0, c, _("%s files:\n"), what);
if (!advice_status_hints)
return;
color_fprintf_ln(s->fp, c, _("# (use \"git %s <file>...\" to include in what will be committed)"), how);
color_fprintf_ln(s->fp, c, "#");
fprintf_commented(s->fp, 0, c, _(" (use \"git %s <file>...\" to include in what will be committed)\n"), how);
fprintf_commented(s->fp, 0, c, "\n");
}

static void wt_status_print_trailer(struct wt_status *s)
{
color_fprintf_ln(s->fp, color(WT_STATUS_HEADER, s), "#");
fprintf_commented(s->fp, 0, color(WT_STATUS_HEADER, s), "\n");
}

#define quote_path quote_path_relative
Expand All @@ -133,7 +136,7 @@ static void wt_status_print_unmerged_data(struct wt_status *s,
const char *one, *how = _("bug");

one = quote_path(it->string, -1, &onebuf, s->prefix);
color_fprintf(s->fp, color(WT_STATUS_HEADER, s), "#\t");
fprintf_commented(s->fp, 0, color(WT_STATUS_HEADER, s), "\t");
switch (d->stagemask) {
case 1: how = _("both deleted:"); break;
case 2: how = _("added by us:"); break;
Expand All @@ -143,7 +146,7 @@ static void wt_status_print_unmerged_data(struct wt_status *s,
case 6: how = _("both added:"); break;
case 7: how = _("both modified:"); break;
}
color_fprintf(s->fp, c, "%-20s%s\n", how, one);
fprintf_commented(s->fp, 1, c, "%-20s%s\n", how, one);
strbuf_release(&onebuf);
}

Expand Down Expand Up @@ -186,40 +189,40 @@ static void wt_status_print_change_data(struct wt_status *s,
one = quote_path(one_name, -1, &onebuf, s->prefix);
two = quote_path(two_name, -1, &twobuf, s->prefix);

color_fprintf(s->fp, color(WT_STATUS_HEADER, s), "#\t");
fprintf_commented(s->fp, 0, color(WT_STATUS_HEADER, s), "\t");
switch (status) {
case DIFF_STATUS_ADDED:
color_fprintf(s->fp, c, _("new file: %s"), one);
fprintf_commented(s->fp, 1, c, _("new file: %s"), one);
break;
case DIFF_STATUS_COPIED:
color_fprintf(s->fp, c, _("copied: %s -> %s"), one, two);
fprintf_commented(s->fp, 1, c, _("copied: %s -> %s"), one, two);
break;
case DIFF_STATUS_DELETED:
color_fprintf(s->fp, c, _("deleted: %s"), one);
fprintf_commented(s->fp, 1, c, _("deleted: %s"), one);
break;
case DIFF_STATUS_MODIFIED:
color_fprintf(s->fp, c, _("modified: %s"), one);
fprintf_commented(s->fp, 1, c, _("modified: %s"), one);
break;
case DIFF_STATUS_RENAMED:
color_fprintf(s->fp, c, _("renamed: %s -> %s"), one, two);
fprintf_commented(s->fp, 1, c, _("renamed: %s -> %s"), one, two);
break;
case DIFF_STATUS_TYPE_CHANGED:
color_fprintf(s->fp, c, _("typechange: %s"), one);
fprintf_commented(s->fp, 1, c, _("typechange: %s"), one);
break;
case DIFF_STATUS_UNKNOWN:
color_fprintf(s->fp, c, _("unknown: %s"), one);
fprintf_commented(s->fp, 1, c, _("unknown: %s"), one);
break;
case DIFF_STATUS_UNMERGED:
color_fprintf(s->fp, c, _("unmerged: %s"), one);
fprintf_commented(s->fp, 1, c, _("unmerged: %s"), one);
break;
default:
die(_("bug: unhandled diff status %c"), status);
}
if (extra.len) {
color_fprintf(s->fp, color(WT_STATUS_HEADER, s), "%s", extra.buf);
fprintf_commented(s->fp, 1, color(WT_STATUS_HEADER, s), "%s", extra.buf);
strbuf_release(&extra);
}
fprintf(s->fp, "\n");
fprintf_commented(s->fp, 1, "", "\n");
strbuf_release(&onebuf);
strbuf_release(&twobuf);
}
Expand Down Expand Up @@ -573,8 +576,8 @@ static void wt_status_print_other(struct wt_status *s,
for (i = 0; i < l->nr; i++) {
struct string_list_item *it;
it = &(l->items[i]);
color_fprintf(s->fp, color(WT_STATUS_HEADER, s), "#\t");
color_fprintf_ln(s->fp, color(WT_STATUS_UNTRACKED, s), "%s",
fprintf_commented(s->fp, 0, color(WT_STATUS_HEADER, s), "\t");
fprintf_commented(s->fp, 1, color(WT_STATUS_UNTRACKED, s), "%s\n",
quote_path(it->string, strlen(it->string),
&buf, s->prefix));
}
Expand Down Expand Up @@ -622,9 +625,9 @@ static void wt_status_print_tracking(struct wt_status *s)
return;

for (cp = sb.buf; (ep = strchr(cp, '\n')) != NULL; cp = ep + 1)
color_fprintf_ln(s->fp, color(WT_STATUS_HEADER, s),
"# %.*s", (int)(ep - cp), cp);
color_fprintf_ln(s->fp, color(WT_STATUS_HEADER, s), "#");
fprintf_commented(s->fp, 0, color(WT_STATUS_HEADER, s),
"%.*s\n", (int)(ep - cp), cp);
fprintf_commented(s->fp, 0, color(WT_STATUS_HEADER, s), "\n");
}

void wt_status_print(struct wt_status *s)
Expand All @@ -642,17 +645,17 @@ void wt_status_print(struct wt_status *s)
branch_status_color = color(WT_STATUS_NOBRANCH, s);
on_what = _("Not currently on any branch.");
}
color_fprintf(s->fp, color(WT_STATUS_HEADER, s), "# ");
color_fprintf(s->fp, branch_status_color, "%s", on_what);
color_fprintf_ln(s->fp, branch_color, "%s", branch_name);
fprintf_commented(s->fp, 0, color(WT_STATUS_HEADER, s), "");
fprintf_commented(s->fp, 1, branch_status_color, "%s", on_what);
fprintf_commented(s->fp, 1, branch_color, "%s\n", branch_name);
if (!s->is_initial)
wt_status_print_tracking(s);
}

if (s->is_initial) {
color_fprintf_ln(s->fp, color(WT_STATUS_HEADER, s), "#");
color_fprintf_ln(s->fp, color(WT_STATUS_HEADER, s), _("# Initial commit"));
color_fprintf_ln(s->fp, color(WT_STATUS_HEADER, s), "#");
fprintf_commented(s->fp, 0, color(WT_STATUS_HEADER, s), "\n");
fprintf_commented(s->fp, 0, color(WT_STATUS_HEADER, s), _("Initial commit\n"));
fprintf_commented(s->fp, 0, color(WT_STATUS_HEADER, s), "\n");
}

wt_status_print_updated(s);
Expand All @@ -669,15 +672,15 @@ void wt_status_print(struct wt_status *s)
if (s->show_ignored_files)
wt_status_print_other(s, &s->ignored, _("Ignored"), "add -f");
} else if (s->commitable)
fprintf(s->fp, _("# Untracked files not listed%s\n"),
fprintf_commented(s->fp, 0, _("Untracked files not listed%s\n"),
advice_status_hints
? _(" (use -u option to show untracked files)") : "");

if (s->verbose)
wt_status_print_verbose(s);
if (!s->commitable) {
if (s->amend)
fprintf(s->fp, _("# No changes\n"));
fprintf_commented(s->fp, 0, "", _("No changes\n"));
else if (s->nowarn)
; /* nothing */
else if (s->workdir_dirty)
Expand Down

0 comments on commit da15d84

Please sign in to comment.