git-clean: add documentation for interactive git-clean
Add new section "Interactive mode" for documentation of interactive git-clean. Signed-off-by: Jiang Xin <worldhello.net@gmail.com> Helped-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jiang Xin committed
Jun 25, 2013 at 23:53 UTC
c0be6b4c8a1d16a92efad00d73683075cf2da60d
1 file changed
+63
-2
Documentation/git-clean.txt
+63
-2
@@ -39,8 +39,8 @@ OPTIONS
39
40
-i::
41
--interactive::
42
- Show what would be done and the user must confirm before actually
43
- cleaning.
42
+ Show what would be done and clean files interactively. See
43
+ ``Interactive mode'' for details.
44
45
-n::
46
--dry-run::
@@ -69,6 +69,67 @@ OPTIONS
69
Remove only files ignored by Git. This may be useful to rebuild
70
everything from scratch, but keep manually created files.
71
72
+Interactive mode
73
+----------------
74
+When the command enters the interactive mode, it shows the
75
+files and directories to be cleaned, and goes into its
76
+interactive command loop.
77
+
78
+The command loop shows the list of subcommands available, and
79
+gives a prompt "What now> ". In general, when the prompt ends
80
+with a single '>', you can pick only one of the choices given
81
+and type return, like this:
82
+
83
+------------
84
+ *** Commands ***
85
+ 1: clean 2: filter by pattern 3: select by numbers
86
+ 4: ask each 5: quit 6: help
87
+ What now> 1
88
+------------
89
+
90
+You also could say `c` or `clean` above as long as the choice is unique.
91
+
92
+The main command loop has 6 subcommands.
93
+
94
+clean::
95
+
96
+ Start cleaning files and directories, and then quit.
97
+
98
+filter by pattern::
99
+
100
+ This shows the files and directories to be deleted and issues an
101
+ "Input ignore patterns>>" prompt. You can input space-seperated
102
+ patterns to exclude files and directories from deletion.
103
+ E.g. "*.c *.h" will excludes files end with ".c" and ".h" from
104
+ deletion. When you are satisfied with the filtered result, press
105
+ ENTER (empty) back to the main menu.
106
+
107
+select by numbers::
108
+
109
+ This shows the files and directories to be deleted and issues an
110
+ "Select items to delete>>" prompt. When the prompt ends with double
111
+ '>>' like this, you can make more than one selection, concatenated
112
+ with whitespace or comma. Also you can say ranges. E.g. "2-5 7,9"
113
+ to choose 2,3,4,5,7,9 from the list. If the second number in a
114
+ range is omitted, all remaining patches are taken. E.g. "7-" to
115
+ choose 7,8,9 from the list. You can say '*' to choose everything.
116
+ Also when you are satisfied with the filtered result, press ENTER
117
+ (empty) back to the main menu.
118
+
119
+ask each::
120
+
121
+ This will start to clean, and you must confirm one by one in order
122
+ to delete items. Please note that this action is not as efficient
123
+ as the above two actions.
124
+
125
+quit::
126
+
127
+ This lets you quit without do cleaning.
128
+
129
+help::
130
+
131
+ Show brief usage of interactive git-clean.
132
+
133
SEE ALSO
134
--------
135
linkgit:gitignore[5]