user-manual: Add section on ignoring files
[git/jnareb-git.git] / git-clean.sh
blobdb177a7886b6407b4c4ad7b778a1ae99471355ac
1 #!/bin/sh
3 # Copyright (c) 2005-2006 Pavel Roskin
6 USAGE="[-d] [-n] [-q] [-x | -X] [--] <paths>..."
7 LONG_USAGE='Clean untracked files from the working directory
8 -d remove directories as well
9 -n don'\''t remove anything, just show what would be done
10 -q be quiet, only report errors
11 -x remove ignored files as well
12 -X remove only ignored files
13 When optional <paths>... arguments are given, the paths
14 affected are further limited to those that match them.'
15 SUBDIRECTORY_OK=Yes
16 . git-sh-setup
17 require_work_tree
19 ignored=
20 ignoredonly=
21 cleandir=
22 rmf="rm -f --"
23 rmrf="rm -rf --"
24 rm_refuse="echo Not removing"
25 echo1="echo"
27 while case "$#" in 0) break ;; esac
29 case "$1" in
30 -d)
31 cleandir=1
33 -n)
34 rmf="echo Would remove"
35 rmrf="echo Would remove"
36 rm_refuse="echo Would not remove"
37 echo1=":"
39 -q)
40 echo1=":"
42 -x)
43 ignored=1
45 -X)
46 ignoredonly=1
48 --)
49 shift
50 break
52 -*)
53 usage
56 break
57 esac
58 shift
59 done
61 case "$ignored,$ignoredonly" in
62 1,1) usage;;
63 esac
65 if [ -z "$ignored" ]; then
66 excl="--exclude-per-directory=.gitignore"
67 if [ -f "$GIT_DIR/info/exclude" ]; then
68 excl_info="--exclude-from=$GIT_DIR/info/exclude"
70 if [ "$ignoredonly" ]; then
71 excl="$excl --ignored"
75 git-ls-files --others --directory $excl ${excl_info:+"$excl_info"} -- "$@" |
76 while read -r file; do
77 if [ -d "$file" -a ! -L "$file" ]; then
78 if [ -z "$cleandir" ]; then
79 $rm_refuse "$file"
80 continue
82 $echo1 "Removing $file"
83 $rmrf "$file"
84 else
85 $echo1 "Removing $file"
86 $rmf "$file"
88 done