Documentation: --cherry-pick
[gitweb.git] / wt-status.c
index 9692dfa325b6153571c83d0f25dd0281d8795b43..a0559905a0b7072f4a4b44ea321c1316cfc84414 100644 (file)
@@ -1,6 +1,6 @@
+#include "cache.h"
 #include "wt-status.h"
 #include "color.h"
-#include "cache.h"
 #include "object.h"
 #include "dir.h"
 #include "commit.h"
@@ -16,11 +16,19 @@ static char wt_status_colors[][COLOR_MAXLEN] = {
        "\033[31m", /* WT_STATUS_UNTRACKED: red */
 };
 
+static const char use_add_msg[] =
+"use \"git add <file>...\" to update what will be committed";
+static const char use_add_rm_msg[] =
+"use \"git add/rm <file>...\" to update what will be committed";
+static const char use_add_to_include_msg[] =
+"use \"git add <file>...\" to include in what will be committed";
+
 static int parse_status_slot(const char *var, int offset)
 {
        if (!strcasecmp(var+offset, "header"))
                return WT_STATUS_HEADER;
-       if (!strcasecmp(var+offset, "updated"))
+       if (!strcasecmp(var+offset, "updated")
+               || !strcasecmp(var+offset, "added"))
                return WT_STATUS_UPDATED;
        if (!strcasecmp(var+offset, "changed"))
                return WT_STATUS_CHANGED;
@@ -39,16 +47,22 @@ void wt_status_prepare(struct wt_status *s)
        unsigned char sha1[20];
        const char *head;
 
-       s->is_initial = get_sha1("HEAD", sha1) ? 1 : 0;
-
+       memset(s, 0, sizeof(*s));
        head = resolve_ref("HEAD", sha1, 0, NULL);
        s->branch = head ? xstrdup(head) : NULL;
-
        s->reference = "HEAD";
-       s->amend = 0;
-       s->verbose = 0;
-       s->commitable = 0;
-       s->untracked = 0;
+}
+
+static void wt_status_print_cached_header(const char *reference)
+{
+       const char *c = color(WT_STATUS_HEADER);
+       color_printf_ln(c, "# Changes to be committed:");
+       if (reference) {
+               color_printf_ln(c, "#   (use \"git reset %s <file>...\" to unstage)", reference);
+       } else {
+               color_printf_ln(c, "#   (use \"git rm --cached <file>...\" to unstage)");
+       }
+       color_printf_ln(c, "#");
 }
 
 static void wt_status_print_header(const char *main, const char *sub)
@@ -64,31 +78,70 @@ static void wt_status_print_trailer(void)
        color_printf_ln(color(WT_STATUS_HEADER), "#");
 }
 
+static const char *quote_crlf(const char *in, char *buf, size_t sz)
+{
+       const char *scan;
+       char *out;
+       const char *ret = in;
+
+       for (scan = in, out = buf; *scan; scan++) {
+               int ch = *scan;
+               int quoted;
+
+               switch (ch) {
+               case '\n':
+                       quoted = 'n';
+                       break;
+               case '\r':
+                       quoted = 'r';
+                       break;
+               default:
+                       *out++ = ch;
+                       continue;
+               }
+               *out++ = '\\';
+               *out++ = quoted;
+               ret = buf;
+       }
+       *out = '\0';
+       return ret;
+}
+
 static void wt_status_print_filepair(int t, struct diff_filepair *p)
 {
        const char *c = color(t);
+       const char *one, *two;
+       char onebuf[PATH_MAX], twobuf[PATH_MAX];
+
+       one = quote_crlf(p->one->path, onebuf, sizeof(onebuf));
+       two = quote_crlf(p->two->path, twobuf, sizeof(twobuf));
+
        color_printf(color(WT_STATUS_HEADER), "#\t");
        switch (p->status) {
        case DIFF_STATUS_ADDED:
-               color_printf(c, "new file:   %s", p->one->path); break;
+               color_printf(c, "new file:   %s", one);
+               break;
        case DIFF_STATUS_COPIED:
-               color_printf(c, "copied:     %s -> %s",
-                               p->one->path, p->two->path);
+               color_printf(c, "copied:     %s -> %s", one, two);
                break;
        case DIFF_STATUS_DELETED:
-               color_printf(c, "deleted:    %s", p->one->path); break;
+               color_printf(c, "deleted:    %s", one);
+               break;
        case DIFF_STATUS_MODIFIED:
-               color_printf(c, "modified:   %s", p->one->path); break;
+               color_printf(c, "modified:   %s", one);
+               break;
        case DIFF_STATUS_RENAMED:
-               color_printf(c, "renamed:    %s -> %s",
-                               p->one->path, p->two->path);
+               color_printf(c, "renamed:    %s -> %s", one, two);
                break;
        case DIFF_STATUS_TYPE_CHANGED:
-               color_printf(c, "typechange: %s", p->one->path); break;
+               color_printf(c, "typechange: %s", one);
+               break;
        case DIFF_STATUS_UNKNOWN:
-               color_printf(c, "unknown:    %s", p->one->path); break;
+               color_printf(c, "unknown:    %s", one);
+               break;
        case DIFF_STATUS_UNMERGED:
-               color_printf(c, "unmerged:   %s", p->one->path); break;
+               color_printf(c, "unmerged:   %s", one);
+               break;
        default:
                die("bug: unhandled diff status %c", p->status);
        }
@@ -102,14 +155,11 @@ static void wt_status_print_updated_cb(struct diff_queue_struct *q,
        struct wt_status *s = data;
        int shown_header = 0;
        int i;
-       if (q->nr) {
-       }
        for (i = 0; i < q->nr; i++) {
                if (q->queue[i]->status == 'U')
                        continue;
                if (!shown_header) {
-                       wt_status_print_header("Updated but not checked in",
-                                       "will commit");
+                       wt_status_print_cached_header(s->reference);
                        s->commitable = 1;
                        shown_header = 1;
                }
@@ -123,29 +173,45 @@ static void wt_status_print_changed_cb(struct diff_queue_struct *q,
                         struct diff_options *options,
                         void *data)
 {
+       struct wt_status *s = data;
        int i;
-       if (q->nr)
-               wt_status_print_header("Changed but not updated",
-                               "use git-update-index to mark for commit");
+       if (q->nr) {
+               const char *msg = use_add_msg;
+               s->workdir_dirty = 1;
+               for (i = 0; i < q->nr; i++)
+                       if (q->queue[i]->status == DIFF_STATUS_DELETED) {
+                               msg = use_add_rm_msg;
+                               break;
+                       }
+               wt_status_print_header("Changed but not updated", msg);
+       }
        for (i = 0; i < q->nr; i++)
                wt_status_print_filepair(WT_STATUS_CHANGED, q->queue[i]);
        if (q->nr)
                wt_status_print_trailer();
 }
 
+static void wt_read_cache(struct wt_status *s)
+{
+       discard_cache();
+       read_cache();
+}
+
 void wt_status_print_initial(struct wt_status *s)
 {
        int i;
-       read_cache();
+       char buf[PATH_MAX];
+
+       wt_read_cache(s);
        if (active_nr) {
                s->commitable = 1;
-               wt_status_print_header("Updated but not checked in",
-                               "will commit");
+               wt_status_print_cached_header(NULL);
        }
        for (i = 0; i < active_nr; i++) {
                color_printf(color(WT_STATUS_HEADER), "#\t");
                color_printf_ln(color(WT_STATUS_UPDATED), "new file: %s",
-                               active_cache[i]->name);
+                               quote_crlf(active_cache[i]->name,
+                                          buf, sizeof(buf)));
        }
        if (active_nr)
                wt_status_print_trailer();
@@ -160,6 +226,7 @@ static void wt_status_print_updated(struct wt_status *s)
        rev.diffopt.format_callback = wt_status_print_updated_cb;
        rev.diffopt.format_callback_data = s;
        rev.diffopt.detect_rename = 1;
+       wt_read_cache(s);
        run_diff_index(&rev, 1);
 }
 
@@ -171,10 +238,11 @@ static void wt_status_print_changed(struct wt_status *s)
        rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
        rev.diffopt.format_callback = wt_status_print_changed_cb;
        rev.diffopt.format_callback_data = s;
+       wt_read_cache(s);
        run_diff_files(&rev, 0);
 }
 
-static void wt_status_print_untracked(const struct wt_status *s)
+static void wt_status_print_untracked(struct wt_status *s)
 {
        struct dir_struct dir;
        const char *x;
@@ -192,7 +260,7 @@ static void wt_status_print_untracked(const struct wt_status *s)
        if (file_exists(x))
                add_excludes_from_file(&dir, x);
 
-       read_directory(&dir, ".", "", 0);
+       read_directory(&dir, ".", "", 0, NULL);
        for(i = 0; i < dir.nr; i++) {
                /* check for matching entry, which is unmerged; lifted from
                 * builtin-ls-files:show_other_files */
@@ -209,8 +277,9 @@ static void wt_status_print_untracked(const struct wt_status *s)
                                continue;
                }
                if (!shown_header) {
+                       s->workdir_untracked = 1;
                        wt_status_print_header("Untracked files",
-                               "use \"git add\" to add to commit");
+                                              use_add_to_include_msg);
                        shown_header = 1;
                }
                color_printf(color(WT_STATUS_HEADER), "#\t");
@@ -226,14 +295,27 @@ static void wt_status_print_verbose(struct wt_status *s)
        setup_revisions(0, NULL, &rev, s->reference);
        rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
        rev.diffopt.detect_rename = 1;
+       wt_read_cache(s);
        run_diff_index(&rev, 1);
 }
 
 void wt_status_print(struct wt_status *s)
 {
-       if (s->branch && strcmp(s->branch, "refs/heads/master"))
+       unsigned char sha1[20];
+       s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
+
+       if (s->branch) {
+               const char *on_what = "On branch ";
+               const char *branch_name = s->branch;
+               if (!prefixcmp(branch_name, "refs/heads/"))
+                       branch_name += 11;
+               else if (!strcmp(branch_name, "HEAD")) {
+                       branch_name = "";
+                       on_what = "Not currently on any branch.";
+               }
                color_printf_ln(color(WT_STATUS_HEADER),
-                       "# On branch %s", s->branch);
+                       "# %s%s", on_what, branch_name);
+       }
 
        if (s->is_initial) {
                color_printf_ln(color(WT_STATUS_HEADER), "#");
@@ -243,7 +325,6 @@ void wt_status_print(struct wt_status *s)
        }
        else {
                wt_status_print_updated(s);
-               discard_cache();
        }
 
        wt_status_print_changed(s);
@@ -251,17 +332,27 @@ void wt_status_print(struct wt_status *s)
 
        if (s->verbose && !s->is_initial)
                wt_status_print_verbose(s);
-       if (!s->commitable)
-               printf("%s\n", s->amend ? "# No changes" : "nothing to commit");
+       if (!s->commitable) {
+               if (s->amend)
+                       printf("# No changes\n");
+               else if (s->workdir_dirty)
+                       printf("no changes added to commit (use \"git add\" and/or \"git commit -a\")\n");
+               else if (s->workdir_untracked)
+                       printf("nothing added to commit but untracked files present (use \"git add\" to track)\n");
+               else if (s->is_initial)
+                       printf("nothing to commit (create/copy files and use \"git add\" to track)\n");
+               else
+                       printf("nothing to commit (working directory clean)\n");
+       }
 }
 
 int git_status_config(const char *k, const char *v)
 {
-       if (!strcmp(k, "status.color")) {
+       if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
                wt_status_use_color = git_config_colorbool(k, v);
                return 0;
        }
-       if (!strncmp(k, "status.color.", 13)) {
+       if (!prefixcmp(k, "status.color.") || !prefixcmp(k, "color.status.")) {
                int slot = parse_status_slot(k, 13);
                color_parse(v, k, wt_status_colors[slot]);
        }