Document git-filter-branch
[git] / git-clean.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2005-2006 Pavel Roskin
4 #
5
6 USAGE="[-d] [-f] [-n] [-q] [-x | -X] [--] <paths>..."
7 LONG_USAGE='Clean untracked files from the working directory
8         -d      remove directories as well
9         -f      override clean.requireForce and clean anyway
10         -n      don'\''t remove anything, just show what would be done
11         -q      be quiet, only report errors
12         -x      remove ignored files as well
13         -X      remove only ignored files
14 When optional <paths>... arguments are given, the paths
15 affected are further limited to those that match them.'
16 SUBDIRECTORY_OK=Yes
17 . git-sh-setup
18 require_work_tree
19
20 ignored=
21 ignoredonly=
22 cleandir=
23 disabled="`git config --bool clean.requireForce`"
24 rmf="rm -f --"
25 rmrf="rm -rf --"
26 rm_refuse="echo Not removing"
27 echo1="echo"
28
29 while case "$#" in 0) break ;; esac
30 do
31         case "$1" in
32         -d)
33                 cleandir=1
34                 ;;
35         -f)
36                 disabled=
37                 ;;
38         -n)
39                 disabled=
40                 rmf="echo Would remove"
41                 rmrf="echo Would remove"
42                 rm_refuse="echo Would not remove"
43                 echo1=":"
44                 ;;
45         -q)
46                 echo1=":"
47                 ;;
48         -x)
49                 ignored=1
50                 ;;
51         -X)
52                 ignoredonly=1
53                 ;;
54         --)
55                 shift
56                 break
57                 ;;
58         -*)
59                 usage
60                 ;;
61         *)
62                 break
63         esac
64         shift
65 done
66
67 if [ "$disabled" = true ]; then
68         echo "clean.requireForce set and -n or -f not given; refusing to clean"
69         exit 1
70 fi
71
72 case "$ignored,$ignoredonly" in
73         1,1) usage;;
74 esac
75
76 if [ -z "$ignored" ]; then
77         excl="--exclude-per-directory=.gitignore"
78         if [ -f "$GIT_DIR/info/exclude" ]; then
79                 excl_info="--exclude-from=$GIT_DIR/info/exclude"
80         fi
81         if [ "$ignoredonly" ]; then
82                 excl="$excl --ignored"
83         fi
84 fi
85
86 git ls-files --others --directory $excl ${excl_info:+"$excl_info"} -- "$@" |
87 while read -r file; do
88         if [ -d "$file" -a ! -L "$file" ]; then
89                 if [ -z "$cleandir" ]; then
90                         $rm_refuse "$file"
91                         continue
92                 fi
93                 $echo1 "Removing $file"
94                 $rmrf "$file"
95         else
96                 $echo1 "Removing $file"
97                 $rmf "$file"
98         fi
99 done