mirror of
https://github.com/git/git
synced 2024-08-27 19:49:21 +00:00
Introduce new pretty formats %g[sdD] for reflog information
Add three new --pretty=format escapes: %gD long reflog descriptor (e.g. refs/stash@{0}) %gd short reflog descriptor (e.g. stash@{0}) %gs reflog message This is achieved by passing down the reflog info, if any, inside the pretty_print_context struct. We use the newly refactored get_reflog_selector(), and give it some extra functionality to extract a shortened ref. The shortening is cached inside the commit_reflogs struct; the only allocation of it happens in read_complete_reflog(), where it is initialised to 0. Also add another helper get_reflog_message() for the message extraction. Note that the --format="%h %gD: %gs" tests may not work in real repositories, as the --pretty formatter doesn't know to leave away the ": " on the last commit in an incomplete (because git-gc removed the old part) reflog. This equivalence is nevertheless the main goal of this patch. Thanks to Jeff King for reviews, the %gd testcase and documentation. Signed-off-by: Thomas Rast <trast@student.ethz.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
72b103fec7
commit
8f8f5476cd
|
@ -123,6 +123,9 @@ The placeholders are:
|
||||||
- '%s': subject
|
- '%s': subject
|
||||||
- '%f': sanitized subject line, suitable for a filename
|
- '%f': sanitized subject line, suitable for a filename
|
||||||
- '%b': body
|
- '%b': body
|
||||||
|
- '%gD': reflog selector, e.g., `refs/stash@\{1\}`
|
||||||
|
- '%gd': shortened reflog selector, e.g., `stash@\{1\}`
|
||||||
|
- '%gs': reflog subject
|
||||||
- '%Cred': switch color to red
|
- '%Cred': switch color to red
|
||||||
- '%Cgreen': switch color to green
|
- '%Cgreen': switch color to green
|
||||||
- '%Cblue': switch color to blue
|
- '%Cblue': switch color to blue
|
||||||
|
@ -132,6 +135,12 @@ The placeholders are:
|
||||||
- '%n': newline
|
- '%n': newline
|
||||||
- '%x00': print a byte from a hex code
|
- '%x00': print a byte from a hex code
|
||||||
|
|
||||||
|
NOTE: Some placeholders may depend on other options given to the
|
||||||
|
revision traversal engine. For example, the `%g*` reflog options will
|
||||||
|
insert an empty string unless we are traversing reflog entries (e.g., by
|
||||||
|
`git log -g`). The `%d` placeholder will use the "short" decoration
|
||||||
|
format if `--decorate` was not already provided on the command line.
|
||||||
|
|
||||||
* 'tformat:'
|
* 'tformat:'
|
||||||
+
|
+
|
||||||
The 'tformat:' format works exactly like 'format:', except that it
|
The 'tformat:' format works exactly like 'format:', except that it
|
||||||
|
|
1
commit.h
1
commit.h
|
@ -70,6 +70,7 @@ struct pretty_print_context
|
||||||
const char *after_subject;
|
const char *after_subject;
|
||||||
enum date_mode date_mode;
|
enum date_mode date_mode;
|
||||||
int need_8bit_cte;
|
int need_8bit_cte;
|
||||||
|
struct reflog_walk_info *reflog_info;
|
||||||
};
|
};
|
||||||
|
|
||||||
extern int non_ascii(int);
|
extern int non_ascii(int);
|
||||||
|
|
|
@ -411,6 +411,7 @@ void show_log(struct rev_info *opt)
|
||||||
ctx.date_mode = opt->date_mode;
|
ctx.date_mode = opt->date_mode;
|
||||||
ctx.abbrev = opt->diffopt.abbrev;
|
ctx.abbrev = opt->diffopt.abbrev;
|
||||||
ctx.after_subject = extra_headers;
|
ctx.after_subject = extra_headers;
|
||||||
|
ctx.reflog_info = opt->reflog_info;
|
||||||
pretty_print_commit(opt->commit_format, commit, &msgbuf, &ctx);
|
pretty_print_commit(opt->commit_format, commit, &msgbuf, &ctx);
|
||||||
|
|
||||||
if (opt->add_signoff)
|
if (opt->add_signoff)
|
||||||
|
|
17
pretty.c
17
pretty.c
|
@ -7,6 +7,7 @@
|
||||||
#include "mailmap.h"
|
#include "mailmap.h"
|
||||||
#include "log-tree.h"
|
#include "log-tree.h"
|
||||||
#include "color.h"
|
#include "color.h"
|
||||||
|
#include "reflog-walk.h"
|
||||||
|
|
||||||
static char *user_format;
|
static char *user_format;
|
||||||
|
|
||||||
|
@ -701,6 +702,22 @@ static size_t format_commit_item(struct strbuf *sb, const char *placeholder,
|
||||||
case 'd':
|
case 'd':
|
||||||
format_decoration(sb, commit);
|
format_decoration(sb, commit);
|
||||||
return 1;
|
return 1;
|
||||||
|
case 'g': /* reflog info */
|
||||||
|
switch(placeholder[1]) {
|
||||||
|
case 'd': /* reflog selector */
|
||||||
|
case 'D':
|
||||||
|
if (c->pretty_ctx->reflog_info)
|
||||||
|
get_reflog_selector(sb,
|
||||||
|
c->pretty_ctx->reflog_info,
|
||||||
|
c->pretty_ctx->date_mode,
|
||||||
|
(placeholder[1] == 'd'));
|
||||||
|
return 2;
|
||||||
|
case 's': /* reflog message */
|
||||||
|
if (c->pretty_ctx->reflog_info)
|
||||||
|
get_reflog_message(sb, c->pretty_ctx->reflog_info);
|
||||||
|
return 2;
|
||||||
|
}
|
||||||
|
return 0; /* unknown %g placeholder */
|
||||||
}
|
}
|
||||||
|
|
||||||
/* For the rest we have to parse the commit header. */
|
/* For the rest we have to parse the commit header. */
|
||||||
|
|
|
@ -8,6 +8,7 @@
|
||||||
|
|
||||||
struct complete_reflogs {
|
struct complete_reflogs {
|
||||||
char *ref;
|
char *ref;
|
||||||
|
const char *short_ref;
|
||||||
struct reflog_info {
|
struct reflog_info {
|
||||||
unsigned char osha1[20], nsha1[20];
|
unsigned char osha1[20], nsha1[20];
|
||||||
char *email;
|
char *email;
|
||||||
|
@ -243,15 +244,26 @@ void fake_reflog_parent(struct reflog_walk_info *info, struct commit *commit)
|
||||||
|
|
||||||
void get_reflog_selector(struct strbuf *sb,
|
void get_reflog_selector(struct strbuf *sb,
|
||||||
struct reflog_walk_info *reflog_info,
|
struct reflog_walk_info *reflog_info,
|
||||||
enum date_mode dmode)
|
enum date_mode dmode,
|
||||||
|
int shorten)
|
||||||
{
|
{
|
||||||
struct commit_reflog *commit_reflog = reflog_info->last_commit_reflog;
|
struct commit_reflog *commit_reflog = reflog_info->last_commit_reflog;
|
||||||
struct reflog_info *info;
|
struct reflog_info *info;
|
||||||
|
const char *printed_ref;
|
||||||
|
|
||||||
if (!commit_reflog)
|
if (!commit_reflog)
|
||||||
return;
|
return;
|
||||||
|
|
||||||
strbuf_addf(sb, "%s@{", commit_reflog->reflogs->ref);
|
if (shorten) {
|
||||||
|
if (!commit_reflog->reflogs->short_ref)
|
||||||
|
commit_reflog->reflogs->short_ref
|
||||||
|
= shorten_unambiguous_ref(commit_reflog->reflogs->ref, 0);
|
||||||
|
printed_ref = commit_reflog->reflogs->short_ref;
|
||||||
|
} else {
|
||||||
|
printed_ref = commit_reflog->reflogs->ref;
|
||||||
|
}
|
||||||
|
|
||||||
|
strbuf_addf(sb, "%s@{", printed_ref);
|
||||||
if (commit_reflog->flag || dmode) {
|
if (commit_reflog->flag || dmode) {
|
||||||
info = &commit_reflog->reflogs->items[commit_reflog->recno+1];
|
info = &commit_reflog->reflogs->items[commit_reflog->recno+1];
|
||||||
strbuf_addstr(sb, show_date(info->timestamp, info->tz, dmode));
|
strbuf_addstr(sb, show_date(info->timestamp, info->tz, dmode));
|
||||||
|
@ -263,6 +275,23 @@ void get_reflog_selector(struct strbuf *sb,
|
||||||
strbuf_addch(sb, '}');
|
strbuf_addch(sb, '}');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void get_reflog_message(struct strbuf *sb,
|
||||||
|
struct reflog_walk_info *reflog_info)
|
||||||
|
{
|
||||||
|
struct commit_reflog *commit_reflog = reflog_info->last_commit_reflog;
|
||||||
|
struct reflog_info *info;
|
||||||
|
size_t len;
|
||||||
|
|
||||||
|
if (!commit_reflog)
|
||||||
|
return;
|
||||||
|
|
||||||
|
info = &commit_reflog->reflogs->items[commit_reflog->recno+1];
|
||||||
|
len = strlen(info->message);
|
||||||
|
if (len > 0)
|
||||||
|
len--; /* strip away trailing newline */
|
||||||
|
strbuf_add(sb, info->message, len);
|
||||||
|
}
|
||||||
|
|
||||||
void show_reflog_message(struct reflog_walk_info *reflog_info, int oneline,
|
void show_reflog_message(struct reflog_walk_info *reflog_info, int oneline,
|
||||||
enum date_mode dmode)
|
enum date_mode dmode)
|
||||||
{
|
{
|
||||||
|
@ -272,7 +301,7 @@ void show_reflog_message(struct reflog_walk_info *reflog_info, int oneline,
|
||||||
struct strbuf selector = STRBUF_INIT;
|
struct strbuf selector = STRBUF_INIT;
|
||||||
|
|
||||||
info = &commit_reflog->reflogs->items[commit_reflog->recno+1];
|
info = &commit_reflog->reflogs->items[commit_reflog->recno+1];
|
||||||
get_reflog_selector(&selector, reflog_info, dmode);
|
get_reflog_selector(&selector, reflog_info, dmode, 0);
|
||||||
if (oneline) {
|
if (oneline) {
|
||||||
printf("%s: %s", selector.buf, info->message);
|
printf("%s: %s", selector.buf, info->message);
|
||||||
}
|
}
|
||||||
|
|
|
@ -3,6 +3,8 @@
|
||||||
|
|
||||||
#include "cache.h"
|
#include "cache.h"
|
||||||
|
|
||||||
|
struct reflog_walk_info;
|
||||||
|
|
||||||
extern void init_reflog_walk(struct reflog_walk_info** info);
|
extern void init_reflog_walk(struct reflog_walk_info** info);
|
||||||
extern int add_reflog_for_walk(struct reflog_walk_info *info,
|
extern int add_reflog_for_walk(struct reflog_walk_info *info,
|
||||||
struct commit *commit, const char *name);
|
struct commit *commit, const char *name);
|
||||||
|
@ -10,5 +12,11 @@ extern void fake_reflog_parent(struct reflog_walk_info *info,
|
||||||
struct commit *commit);
|
struct commit *commit);
|
||||||
extern void show_reflog_message(struct reflog_walk_info *info, int,
|
extern void show_reflog_message(struct reflog_walk_info *info, int,
|
||||||
enum date_mode);
|
enum date_mode);
|
||||||
|
extern void get_reflog_message(struct strbuf *sb,
|
||||||
|
struct reflog_walk_info *reflog_info);
|
||||||
|
extern void get_reflog_selector(struct strbuf *sb,
|
||||||
|
struct reflog_walk_info *reflog_info,
|
||||||
|
enum date_mode dmode,
|
||||||
|
int shorten);
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
|
@ -162,4 +162,22 @@ test_expect_success 'empty email' '
|
||||||
}
|
}
|
||||||
'
|
'
|
||||||
|
|
||||||
|
test_expect_success '"%h %gD: %gs" is same as git-reflog' '
|
||||||
|
git reflog >expect &&
|
||||||
|
git log -g --format="%h %gD: %gs" >actual &&
|
||||||
|
test_cmp expect actual
|
||||||
|
'
|
||||||
|
|
||||||
|
test_expect_success '"%h %gD: %gs" is same as git-reflog (with date)' '
|
||||||
|
git reflog --date=raw >expect &&
|
||||||
|
git log -g --format="%h %gD: %gs" --date=raw >actual &&
|
||||||
|
test_cmp expect actual
|
||||||
|
'
|
||||||
|
|
||||||
|
test_expect_success '%gd shortens ref name' '
|
||||||
|
echo "master@{0}" >expect.gd-short &&
|
||||||
|
git log -g -1 --format=%gd refs/heads/master >actual.gd-short &&
|
||||||
|
test_cmp expect.gd-short actual.gd-short
|
||||||
|
'
|
||||||
|
|
||||||
test_done
|
test_done
|
||||||
|
|
Loading…
Reference in a new issue