Improve UX for oneline with decorations

The current oneline log format prints the decoration before the commit message, which breaks up the commit message alignment. Teach `log` to understand a new option `--newlinefor` where `decorations` can be passed in for a newline to be added after decorations. Signed-off-by: John Cai <johncai86@gmail.com>

Author: john-cai

Documentation/pretty-options.txt

@@ -32,6 +32,10 @@ people using 80-column terminals.
 This is a shorthand for "--pretty=oneline --abbrev-commit"
 used together.
 
+--newlinefor[=(decorations)]
+Used in conjunction with --pretty=oneline to add a line break after
+decorations
+
 --encoding=<encoding>::
 Commit objects record the character encoding used for the log message
 in their encoding header; this option can be used to tell the

builtin/log.c

@@ -141,6 +141,8 @@ static void init_log_defaults(void)
 
 static void cmd_log_init_defaults(struct rev_info *rev)
 {
+struct newlinefor newlineforopts = {0};
+
 if (fmt_pretty)
 get_commit_format(fmt_pretty, rev);
 if (default_follow)
@@ -156,6 +158,7 @@ static void cmd_log_init_defaults(struct rev_info *rev)
 rev->show_signature = default_show_signature;
 rev->encode_email_headers = default_encode_email_headers;
 rev->diffopt.flags.allow_textconv = 1;
+rev->newlinefor = &newlineforopts;
 
 if (default_date_mode)
 parse_date_format(default_date_mode, &rev->date_mode);
@@ -170,6 +173,7 @@ static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
 static struct string_list decorate_refs_exclude = STRING_LIST_INIT_NODUP;
 static struct string_list decorate_refs_exclude_config = STRING_LIST_INIT_NODUP;
 static struct string_list decorate_refs_include = STRING_LIST_INIT_NODUP;
+static struct string_list newlinefor = STRING_LIST_INIT_NODUP;
 struct decoration_filter decoration_filter = {&decorate_refs_include,
  &decorate_refs_exclude,
  &decorate_refs_exclude_config};
@@ -189,6 +193,7 @@ static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
 OPT_CALLBACK('L', NULL, &line_cb, "range:file",
  N_("trace the evolution of line range <start>,<end> or function :<funcname> in <file>"),
  log_line_range_callback),
+OPT_STRING_LIST(0, "newlinefor", &newlinefor, N_("newlinefor"), N_("new line for <commit>,<source>, or <deocrations>")),
 OPT_END()
 };
 
@@ -229,6 +234,9 @@ static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
 rev->sources = &revision_sources;
 }
 
+if (string_list_has_string(&newlinefor, "decorations"))
+rev->newlinefor->decorations = 1;
+
 if (mailmap) {
 rev->mailmap = xcalloc(1, sizeof(struct string_list));
 read_mailmap(rev->mailmap);

cache.h

@@ -1147,6 +1147,7 @@ const char *repo_find_unique_abbrev(struct repository *r, const struct object_id
 #define find_unique_abbrev(oid, len) repo_find_unique_abbrev(the_repository, oid, len)
 int repo_find_unique_abbrev_r(struct repository *r, char *hex, const struct object_id *oid, int len);
 #define find_unique_abbrev_r(hex, oid, len) repo_find_unique_abbrev_r(the_repository, hex, oid, len)
+int find_unique_abbrev_len(struct repository *r, int len);
 
 /* set default permissions by passing mode arguments to open(2) */
 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);

log-tree.c

@@ -278,16 +278,24 @@ static void show_name(struct strbuf *sb, const struct name_decoration *decoratio
 strbuf_addstr(sb, decoration->name);
 }
 
+static void indent(struct strbuf *sb, int len)
+{
+strbuf_addchars(sb, ' ', len);
+}
+
 /*
  * The caller makes sure there is no funny color before calling.
  * format_decorations_extended makes sure the same after return.
  */
 void format_decorations_extended(struct strbuf *sb,
 const struct commit *commit,
 int use_color,
+int format,
 const char *prefix,
 const char *separator,
-const char *suffix)
+const char *suffix,
+int abbrev_len,
+int newline)
 {
 const struct name_decoration *decoration;
 const struct name_decoration *current_and_HEAD;
@@ -333,11 +341,16 @@ void format_decorations_extended(struct strbuf *sb,
 strbuf_addstr(sb, color_commit);
 strbuf_addstr(sb, suffix);
 strbuf_addstr(sb, color_reset);
+if ((format == CMIT_FMT_ONELINE) && newline == 1) {
+strbuf_addstr(sb, "\n");
+indent(sb, abbrev_len);
+}
 }
 
 void show_decorations(struct rev_info *opt, struct commit *commit)
 {
 struct strbuf sb = STRBUF_INIT;
+int newline = 0;
 
 if (opt->sources) {
 char **slot = revision_sources_peek(opt->sources, commit);
@@ -347,7 +360,12 @@ void show_decorations(struct rev_info *opt, struct commit *commit)
 }
 if (!opt->show_decorations)
 return;
-format_decorations(&sb, commit, opt->diffopt.use_color);
+
+if (opt->newlinefor != NULL){
+newline = opt->newlinefor->decorations;
+}
+
+format_decorations(&sb, commit, opt->diffopt.use_color, opt->commit_format, opt->abbrev, newline);
 fputs(sb.buf, opt->diffopt.file);
 strbuf_release(&sb);
 }
@@ -624,6 +642,8 @@ void show_log(struct rev_info *opt)
 const char *extra_headers = opt->extra_headers;
 struct pretty_print_context ctx = {0};
 
+opt->abbrev = find_unique_abbrev_len(the_repository, abbrev_commit);
+
 opt->loginfo = NULL;
 if (!opt->verbose_header) {
 graph_show_commit(opt->graph);

log-tree.h

@@ -19,11 +19,14 @@ int log_tree_commit(struct rev_info *, struct commit *);
 void show_log(struct rev_info *opt);
 void format_decorations_extended(struct strbuf *sb, const struct commit *commit,
  int use_color,
+ int format,
  const char *prefix,
  const char *separator,
- const char *suffix);
-#define format_decorations(strbuf, commit, color) \
- format_decorations_extended((strbuf), (commit), (color), " (", ", ", ")")
+ const char *suffix,
+ int abbrev_len,
+ int newline);
+#define format_decorations(strbuf, commit, color, format, abbrev_len, newline) \
+ format_decorations_extended((strbuf), (commit), (color), (format), " (", ", ", ")", (abbrev_len), (newline))
 void show_decorations(struct rev_info *opt, struct commit *commit);
 void log_write_email_headers(struct rev_info *opt, struct commit *commit,
  const char **extra_headers_p,

object-name.c

@@ -660,14 +660,8 @@ static void find_abbrev_len_packed(struct min_abbrev_data *mad)
 find_abbrev_len_for_pack(p, mad);
 }
 
-int repo_find_unique_abbrev_r(struct repository *r, char *hex,
- const struct object_id *oid, int len)
+int find_unique_abbrev_len(struct repository *r, int len)
 {
-struct disambiguate_state ds;
-struct min_abbrev_data mad;
-struct object_id oid_ret;
-const unsigned hexsz = r->hash_algo->hexsz;
-
 if (len < 0) {
 unsigned long count = repo_approximate_object_count(r);
 /*
@@ -690,6 +684,19 @@ int repo_find_unique_abbrev_r(struct repository *r, char *hex,
 len = FALLBACK_DEFAULT_ABBREV;
 }
 
+return len;
+}
+
+int repo_find_unique_abbrev_r(struct repository *r, char *hex,
+ const struct object_id *oid, int len)
+{
+struct disambiguate_state ds;
+struct min_abbrev_data mad;
+struct object_id oid_ret;
+const unsigned hexsz = r->hash_algo->hexsz;
+
+len = find_unique_abbrev_len(r, len);
+
 oid_to_hex_r(hex, oid);
 if (len == hexsz || !len)
 return hexsz;

pretty.c

@@ -1385,10 +1385,10 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
 strbuf_addstr(sb, get_revision_mark(NULL, commit));
 return 1;
 case 'd':
-format_decorations(sb, commit, c->auto_color);
+format_decorations(sb, commit, c->auto_color, c->pretty_ctx->fmt, 0, 0);
 return 1;
 case 'D':
-format_decorations_extended(sb, commit, c->auto_color, "", ", ", "");
+format_decorations_extended(sb, commit, c->auto_color, c->pretty_ctx->fmt, "", ", ", "", 0, 0);
 return 1;
 case 'S':/* tag/branch like --source */
 if (!(c->pretty_ctx->rev && c->pretty_ctx->rev->sources))

revision.h

@@ -81,6 +81,10 @@ struct rev_cmdline_info {
 
 struct oidset;
 struct topo_walk_info;
+struct newlinefor {
+unsigned int decorations;
+};
+
 
 struct rev_info {
 /* Starting list */
@@ -243,6 +247,7 @@ struct rev_info {
 intno_inline;
 intshow_log_size;
 struct string_list *mailmap;
+struct newlinefor *newlinefor;
 
 /* Filter by commit log message */
 struct grep_optgrep_filter;