builtin / rm.con commit fetch: make the code more understandable (9528b80)
   1/*
   2 * "git rm" builtin command
   3 *
   4 * Copyright (C) Linus Torvalds 2006
   5 */
   6#include "builtin.h"
   7#include "config.h"
   8#include "lockfile.h"
   9#include "dir.h"
  10#include "cache-tree.h"
  11#include "tree-walk.h"
  12#include "parse-options.h"
  13#include "string-list.h"
  14#include "submodule.h"
  15#include "pathspec.h"
  16
  17static const char * const builtin_rm_usage[] = {
  18        N_("git rm [<options>] [--] <file>..."),
  19        NULL
  20};
  21
  22static struct {
  23        int nr, alloc;
  24        struct {
  25                const char *name;
  26                char is_submodule;
  27        } *entry;
  28} list;
  29
  30static int get_ours_cache_pos(const char *path, int pos)
  31{
  32        int i = -pos - 1;
  33
  34        while ((i < active_nr) && !strcmp(active_cache[i]->name, path)) {
  35                if (ce_stage(active_cache[i]) == 2)
  36                        return i;
  37                i++;
  38        }
  39        return -1;
  40}
  41
  42static void print_error_files(struct string_list *files_list,
  43                              const char *main_msg,
  44                              const char *hints_msg,
  45                              int *errs)
  46{
  47        if (files_list->nr) {
  48                int i;
  49                struct strbuf err_msg = STRBUF_INIT;
  50
  51                strbuf_addstr(&err_msg, main_msg);
  52                for (i = 0; i < files_list->nr; i++)
  53                        strbuf_addf(&err_msg,
  54                                    "\n    %s",
  55                                    files_list->items[i].string);
  56                if (advice_rm_hints)
  57                        strbuf_addstr(&err_msg, hints_msg);
  58                *errs = error("%s", err_msg.buf);
  59                strbuf_release(&err_msg);
  60        }
  61}
  62
  63static void submodules_absorb_gitdir_if_needed(const char *prefix)
  64{
  65        int i;
  66        for (i = 0; i < list.nr; i++) {
  67                const char *name = list.entry[i].name;
  68                int pos;
  69                const struct cache_entry *ce;
  70
  71                pos = cache_name_pos(name, strlen(name));
  72                if (pos < 0) {
  73                        pos = get_ours_cache_pos(name, pos);
  74                        if (pos < 0)
  75                                continue;
  76                }
  77                ce = active_cache[pos];
  78
  79                if (!S_ISGITLINK(ce->ce_mode) ||
  80                    !file_exists(ce->name) ||
  81                    is_empty_dir(name))
  82                        continue;
  83
  84                if (!submodule_uses_gitfile(name))
  85                        absorb_git_dir_into_superproject(prefix, name,
  86                                ABSORB_GITDIR_RECURSE_SUBMODULES);
  87        }
  88}
  89
  90static int check_local_mod(struct object_id *head, int index_only)
  91{
  92        /*
  93         * Items in list are already sorted in the cache order,
  94         * so we could do this a lot more efficiently by using
  95         * tree_desc based traversal if we wanted to, but I am
  96         * lazy, and who cares if removal of files is a tad
  97         * slower than the theoretical maximum speed?
  98         */
  99        int i, no_head;
 100        int errs = 0;
 101        struct string_list files_staged = STRING_LIST_INIT_NODUP;
 102        struct string_list files_cached = STRING_LIST_INIT_NODUP;
 103        struct string_list files_local = STRING_LIST_INIT_NODUP;
 104
 105        no_head = is_null_oid(head);
 106        for (i = 0; i < list.nr; i++) {
 107                struct stat st;
 108                int pos;
 109                const struct cache_entry *ce;
 110                const char *name = list.entry[i].name;
 111                struct object_id oid;
 112                unsigned mode;
 113                int local_changes = 0;
 114                int staged_changes = 0;
 115
 116                pos = cache_name_pos(name, strlen(name));
 117                if (pos < 0) {
 118                        /*
 119                         * Skip unmerged entries except for populated submodules
 120                         * that could lose history when removed.
 121                         */
 122                        pos = get_ours_cache_pos(name, pos);
 123                        if (pos < 0)
 124                                continue;
 125
 126                        if (!S_ISGITLINK(active_cache[pos]->ce_mode) ||
 127                            is_empty_dir(name))
 128                                continue;
 129                }
 130                ce = active_cache[pos];
 131
 132                if (lstat(ce->name, &st) < 0) {
 133                        if (!is_missing_file_error(errno))
 134                                warning_errno(_("failed to stat '%s'"), ce->name);
 135                        /* It already vanished from the working tree */
 136                        continue;
 137                }
 138                else if (S_ISDIR(st.st_mode)) {
 139                        /* if a file was removed and it is now a
 140                         * directory, that is the same as ENOENT as
 141                         * far as git is concerned; we do not track
 142                         * directories unless they are submodules.
 143                         */
 144                        if (!S_ISGITLINK(ce->ce_mode))
 145                                continue;
 146                }
 147
 148                /*
 149                 * "rm" of a path that has changes need to be treated
 150                 * carefully not to allow losing local changes
 151                 * accidentally.  A local change could be (1) file in
 152                 * work tree is different since the index; and/or (2)
 153                 * the user staged a content that is different from
 154                 * the current commit in the index.
 155                 *
 156                 * In such a case, you would need to --force the
 157                 * removal.  However, "rm --cached" (remove only from
 158                 * the index) is safe if the index matches the file in
 159                 * the work tree or the HEAD commit, as it means that
 160                 * the content being removed is available elsewhere.
 161                 */
 162
 163                /*
 164                 * Is the index different from the file in the work tree?
 165                 * If it's a submodule, is its work tree modified?
 166                 */
 167                if (ce_match_stat(ce, &st, 0) ||
 168                    (S_ISGITLINK(ce->ce_mode) &&
 169                     bad_to_remove_submodule(ce->name,
 170                                SUBMODULE_REMOVAL_DIE_ON_ERROR |
 171                                SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED)))
 172                        local_changes = 1;
 173
 174                /*
 175                 * Is the index different from the HEAD commit?  By
 176                 * definition, before the very initial commit,
 177                 * anything staged in the index is treated by the same
 178                 * way as changed from the HEAD.
 179                 */
 180                if (no_head
 181                     || get_tree_entry(head, name, &oid, &mode)
 182                     || ce->ce_mode != create_ce_mode(mode)
 183                     || !oideq(&ce->oid, &oid))
 184                        staged_changes = 1;
 185
 186                /*
 187                 * If the index does not match the file in the work
 188                 * tree and if it does not match the HEAD commit
 189                 * either, (1) "git rm" without --cached definitely
 190                 * will lose information; (2) "git rm --cached" will
 191                 * lose information unless it is about removing an
 192                 * "intent to add" entry.
 193                 */
 194                if (local_changes && staged_changes) {
 195                        if (!index_only || !ce_intent_to_add(ce))
 196                                string_list_append(&files_staged, name);
 197                }
 198                else if (!index_only) {
 199                        if (staged_changes)
 200                                string_list_append(&files_cached, name);
 201                        if (local_changes)
 202                                string_list_append(&files_local, name);
 203                }
 204        }
 205        print_error_files(&files_staged,
 206                          Q_("the following file has staged content different "
 207                             "from both the\nfile and the HEAD:",
 208                             "the following files have staged content different"
 209                             " from both the\nfile and the HEAD:",
 210                             files_staged.nr),
 211                          _("\n(use -f to force removal)"),
 212                          &errs);
 213        string_list_clear(&files_staged, 0);
 214        print_error_files(&files_cached,
 215                          Q_("the following file has changes "
 216                             "staged in the index:",
 217                             "the following files have changes "
 218                             "staged in the index:", files_cached.nr),
 219                          _("\n(use --cached to keep the file,"
 220                            " or -f to force removal)"),
 221                          &errs);
 222        string_list_clear(&files_cached, 0);
 223
 224        print_error_files(&files_local,
 225                          Q_("the following file has local modifications:",
 226                             "the following files have local modifications:",
 227                             files_local.nr),
 228                          _("\n(use --cached to keep the file,"
 229                            " or -f to force removal)"),
 230                          &errs);
 231        string_list_clear(&files_local, 0);
 232
 233        return errs;
 234}
 235
 236static int show_only = 0, force = 0, index_only = 0, recursive = 0, quiet = 0;
 237static int ignore_unmatch = 0;
 238
 239static struct option builtin_rm_options[] = {
 240        OPT__DRY_RUN(&show_only, N_("dry run")),
 241        OPT__QUIET(&quiet, N_("do not list removed files")),
 242        OPT_BOOL( 0 , "cached",         &index_only, N_("only remove from the index")),
 243        OPT__FORCE(&force, N_("override the up-to-date check"), PARSE_OPT_NOCOMPLETE),
 244        OPT_BOOL('r', NULL,             &recursive,  N_("allow recursive removal")),
 245        OPT_BOOL( 0 , "ignore-unmatch", &ignore_unmatch,
 246                                N_("exit with a zero status even if nothing matched")),
 247        OPT_END(),
 248};
 249
 250int cmd_rm(int argc, const char **argv, const char *prefix)
 251{
 252        struct lock_file lock_file = LOCK_INIT;
 253        int i;
 254        struct pathspec pathspec;
 255        char *seen;
 256
 257        git_config(git_default_config, NULL);
 258
 259        argc = parse_options(argc, argv, prefix, builtin_rm_options,
 260                             builtin_rm_usage, 0);
 261        if (!argc)
 262                usage_with_options(builtin_rm_usage, builtin_rm_options);
 263
 264        if (!index_only)
 265                setup_work_tree();
 266
 267        hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
 268
 269        if (read_cache() < 0)
 270                die(_("index file corrupt"));
 271
 272        parse_pathspec(&pathspec, 0,
 273                       PATHSPEC_PREFER_CWD,
 274                       prefix, argv);
 275        refresh_index(&the_index, REFRESH_QUIET, &pathspec, NULL, NULL);
 276
 277        seen = xcalloc(pathspec.nr, 1);
 278
 279        for (i = 0; i < active_nr; i++) {
 280                const struct cache_entry *ce = active_cache[i];
 281                if (!ce_path_match(&the_index, ce, &pathspec, seen))
 282                        continue;
 283                ALLOC_GROW(list.entry, list.nr + 1, list.alloc);
 284                list.entry[list.nr].name = xstrdup(ce->name);
 285                list.entry[list.nr].is_submodule = S_ISGITLINK(ce->ce_mode);
 286                if (list.entry[list.nr++].is_submodule &&
 287                    !is_staging_gitmodules_ok(&the_index))
 288                        die(_("please stage your changes to .gitmodules or stash them to proceed"));
 289        }
 290
 291        if (pathspec.nr) {
 292                const char *original;
 293                int seen_any = 0;
 294                for (i = 0; i < pathspec.nr; i++) {
 295                        original = pathspec.items[i].original;
 296                        if (!seen[i]) {
 297                                if (!ignore_unmatch) {
 298                                        die(_("pathspec '%s' did not match any files"),
 299                                            original);
 300                                }
 301                        }
 302                        else {
 303                                seen_any = 1;
 304                        }
 305                        if (!recursive && seen[i] == MATCHED_RECURSIVELY)
 306                                die(_("not removing '%s' recursively without -r"),
 307                                    *original ? original : ".");
 308                }
 309
 310                if (!seen_any)
 311                        exit(0);
 312        }
 313
 314        if (!index_only)
 315                submodules_absorb_gitdir_if_needed(prefix);
 316
 317        /*
 318         * If not forced, the file, the index and the HEAD (if exists)
 319         * must match; but the file can already been removed, since
 320         * this sequence is a natural "novice" way:
 321         *
 322         *      rm F; git rm F
 323         *
 324         * Further, if HEAD commit exists, "diff-index --cached" must
 325         * report no changes unless forced.
 326         */
 327        if (!force) {
 328                struct object_id oid;
 329                if (get_oid("HEAD", &oid))
 330                        oidclr(&oid);
 331                if (check_local_mod(&oid, index_only))
 332                        exit(1);
 333        }
 334
 335        /*
 336         * First remove the names from the index: we won't commit
 337         * the index unless all of them succeed.
 338         */
 339        for (i = 0; i < list.nr; i++) {
 340                const char *path = list.entry[i].name;
 341                if (!quiet)
 342                        printf("rm '%s'\n", path);
 343
 344                if (remove_file_from_cache(path))
 345                        die(_("git rm: unable to remove %s"), path);
 346        }
 347
 348        if (show_only)
 349                return 0;
 350
 351        /*
 352         * Then, unless we used "--cached", remove the filenames from
 353         * the workspace. If we fail to remove the first one, we
 354         * abort the "git rm" (but once we've successfully removed
 355         * any file at all, we'll go ahead and commit to it all:
 356         * by then we've already committed ourselves and can't fail
 357         * in the middle)
 358         */
 359        if (!index_only) {
 360                int removed = 0, gitmodules_modified = 0;
 361                struct strbuf buf = STRBUF_INIT;
 362                for (i = 0; i < list.nr; i++) {
 363                        const char *path = list.entry[i].name;
 364                        if (list.entry[i].is_submodule) {
 365                                strbuf_reset(&buf);
 366                                strbuf_addstr(&buf, path);
 367                                if (remove_dir_recursively(&buf, 0))
 368                                        die(_("could not remove '%s'"), path);
 369
 370                                removed = 1;
 371                                if (!remove_path_from_gitmodules(path))
 372                                        gitmodules_modified = 1;
 373                                continue;
 374                        }
 375                        if (!remove_path(path)) {
 376                                removed = 1;
 377                                continue;
 378                        }
 379                        if (!removed)
 380                                die_errno("git rm: '%s'", path);
 381                }
 382                strbuf_release(&buf);
 383                if (gitmodules_modified)
 384                        stage_updated_gitmodules(&the_index);
 385        }
 386
 387        if (write_locked_index(&the_index, &lock_file,
 388                               COMMIT_LOCK | SKIP_IF_UNCHANGED))
 389                die(_("Unable to write new index file"));
 390
 391        return 0;
 392}