Interactive git clean
v15 cover Interactive git clean
Update since v14:
* Add more testcases for relative_path. See patch 01/16.
* Refactor: change arguments name for relative_path (in path.c), i.e. abc -> in, base -> prefix. This is because the first argument is not restricted to absolute path any more. See patch 02/16.
* Move git-ls-files fix from patch 05/16 to patch 03/16. See patch 03/16.
* Remove NO_MINGW and related functions from t0060 script. See patch 16/16.
Jiang Xin (16):
test: add test cases for relative_path
path.c: refactor relative_path(), not only strip prefix quote.c: substitute path_relative with relative_path Refactor quote_path_relative, remove unused params Refactor write_name_quoted_relative, remove unused params
git-clean: refactor git-clean into two phases
git-clean: add support for -i/--interactive
git-clean: show items of del_list in columns
git-clean: add colors to interactive git-clean
git-clean: use a git-add-interactive compatible UI
git-clean: add filter by pattern interactive action
git-clean: add select by numbers interactive action
git-clean: add ask each interactive action
git-clean: add documentation for interactive git-clean
test: add t7301 for git-clean--interactive
test: run testcases with POSIX absolute paths on Windows
Documentation/config.txt | 21 +- Documentation/git-clean.txt | 71 +++- builtin/clean.c | 778 +++++++++++++++++++++++++++++++++++++++++-- builtin/grep.c | 5 +- builtin/ls-files.c | 17 +- cache.h | 2 +- path.c | 116 +++++-- quote.c | 65 +--- quote.h | 7 +- setup.c | 5 +- t/t0060-path-utils.sh | 72 +++- t/t7301-clean-interactive.sh | 439 ++++++++++++++++++++++++ test-path-utils.c | 32 ++ wt-status.c | 17 +- 14 files changed, 1474 insertions(+), 173 deletions(-) create mode 100755 t/t7301-clean-interactive.sh
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 1/16 test: add test cases for relative_path
Add subcommand "relative_path" in test-path-utils, and add test cases in t0060.
Johannes tested this commit on Windows, and found that some relative_path tests should be skipped on Windows. This is because the bash on Windows rewrites arguments of regular Windows programs, such as git and the test helpers, if the arguments look like absolute POSIX paths. As a consequence, the actual tests performed are not what the tests scripts expect.
The tests that need *not* be skipped are those where the two paths passed to 'test-path-utils relative_path' have the same prefix and the result is expected to be a relative path. This is because the rewriting changes "/a/b" to "D:/Src/MSysGit/a/b", and when both inputs are extended the same way, this just cancels out in the relative path computation.
--- t/t0060-path-utils.sh | 37 +++++++++++++++++++++++++++++++++++++ test-path-utils.c | 25 +++++++++++++++++++++++++ 2 files changed, 62 insertions(+)
t/t0060-path-utils.sh +37 -0
@@ -12,6 +12,11 @@ norm_path() { "test \"\$(test-path-utils normalize_path_copy '$1')\" = '$2'" } +relative_path() { + test_expect_success $4 "relative path: $1 $2 => $3" \ + "test \"\$(test-path-utils relative_path '$1' '$2')\" = '$3'" +} + # On Windows, we are using MSYS's bash, which mangles the paths. # Absolute paths are anchored at the MSYS installation directory, # which means that the path / accounts for this many characters:
@@ -183,4 +188,36 @@ test_expect_success SYMLINKS 'real path works on symlinks' ' test "$sym" = "$(test-path-utils real_path "$dir2/syml")" ' +relative_path /a/b/c/ /a/b/ c/ +relative_path /a/b/c/ /a/b c/ +relative_path /a//b//c/ //a/b// c/ POSIX +relative_path /a/b /a/b . +relative_path /a/b/ /a/b . +relative_path /a /a/b /a POSIX +relative_path / /a/b/ / POSIX +relative_path /a/c /a/b/ /a/c POSIX +relative_path /a/c /a/b /a/c POSIX +relative_path /x/y /a/b/ /x/y POSIX +relative_path /a/b "<empty>" /a/b POSIX +relative_path /a/b "<null>" /a/b POSIX +relative_path a/b/c/ a/b/ c/ +relative_path a/b/c/ a/b c/ +relative_path a/b//c a//b c +relative_path a/b/ a/b/ . +relative_path a/b/ a/b . +relative_path a a/b a # TODO: should be: .. +relative_path x/y a/b x/y # TODO: should be: ../../x/y +relative_path a/c a/b a/c # TODO: should be: ../c +relative_path a/b "<empty>" a/b +relative_path a/b "<null>" a/b +relative_path "<empty>" /a/b "(empty)" +relative_path "<empty>" "<empty>" "(empty)" +relative_path "<empty>" "<null>" "(empty)" +relative_path "<null>" "<empty>" "(null)" +relative_path "<null>" "<null>" "(null)" + +test_expect_failure 'relative path: <null> /a/b => segfault' ' + test-path-utils relative_path "<null>" "/a/b" +' + test_done
test-path-utils.c +25 -0
@@ -28,6 +28,19 @@ static int normalize_ceiling_entry(struct string_list_item *item, void *unused)return 1 ; } +static void normalize_argv_string (const char **var,const char *input) +{ +if (!strcmp (input,"<null>" )) + *var =NULL ; +else if (!strcmp (input,"<empty>" )) + *var ="" ; +else + *var = input; + +if (*var && (**var =='<' || **var =='(' )) +die ("Bad value: %s\n" , input); +} +int main (int argc,char **argv) {if (argc ==3 && !strcmp (argv[1 ],"normalize_path_copy" )) {
@@ -103,6 +116,18 @@ int main(int argc, char **argv)return 0 ; } +if (argc ==4 && !strcmp (argv[1 ],"relative_path" )) { +const char *in, *prefix, *rel; +normalize_argv_string (&in, argv[2 ]); +normalize_argv_string (&prefix, argv[3 ]); + rel =relative_path (in, prefix); +if (!rel) +puts ("(null)" ); +else +puts (strlen (rel) >0 ? rel :"(empty)" ); +return 0 ; + } +fprintf (stderr,"%s: unknown function name: %s\n" , argv[0 ], argv[1 ] ? argv[1 ] :"(there was none)" );return 1 ;
Signature · 1 line
1.8.3.1.756.g2e9b71f
Re: [PATCH v15 01/16] test: add test cases for relative_path
Quoted 4 lines · Jiang Xin
Add subcommand "
relative_path" in test-path-utils, and add test cases in t0060.Johannes tested this commit on Windows, and found that some
relative_path
"this commit", or "an earlier version of this patch"? I am guessing it is the latter (if so, I can easily amend locally without a need for rerolling).
Quoted 12 lines
tests should be skipped on Windows. This is because the bash on Windows rewrites arguments of regular Windows programs, such as git and the test helpers, if the arguments look like absolute POSIX paths. As a consequence, the actual tests performed are not what the tests scripts expect.
The tests that need *not* be skipped are those where the two paths passed to 'test-path-utils
relative_path' have the same prefix and the result is expected to be a relative path. This is because the rewriting changes "/a/b" to "D:/Src/MSysGit/a/b", and when both inputs are extended the same way, this just cancels out in the relative path computation.
Quoted 3 lines
Signed-off-by Jiang Xin <[email protected]>Signed-off-by Johannes Sixt <[email protected]>Signed-off-by Junio C Hamano <[email protected]>
I somehow lost track, but does the above list of sign-offs reflect the origins of the changes contained in this patch, or is the second one meant to be helped-by or something (if so, I can easily amend locally without a need for rerolling)?
t/t0060-path-utils.sh test_expect_success SYMLINKS 'real path works on symlinks' ' · line 199
Quoted 3 lines
t/t0060-path-utils.sh +3
-0+relative_path / /a/b/ / POSIX +relative_path /a/c /a/b/ /a/c POSIX +relative_path /a/c /a/b /a/c POSIX
(mental note, not a complaint): These are notable, as some may expect to see "..", "../.." and "../c" for these cases, but the rule is "ignore base and return it if it is absolute", so they are understandable.
t/t0060-path-utils.sh test_expect_success SYMLINKS 'real path works on symlinks' ' · line 210
Quoted 3 lines
t/t0060-path-utils.sh +3
-0+relative_path a a/b a # TODO: should be: .. +relative_path x/y a/b x/y # TODO: should be: ../../x/y +relative_path a/c a/b a/c # TODO: should be: ../c
(mental note): OK. Let's see how they evolve in later patches.
Thanks.
Re: [PATCH v15 01/16] test: add test cases for relative_path
2013/6/27 Junio C Hamano <[email protected]>
Quoted 11 lines
Quoted 4 lines · Jiang Xin
Add subcommand "
relative_path" in test-path-utils, and add test cases in t0060.Johannes tested this commit on Windows, and found that some
relative_path"this commit", or "an earlier version of this patch"? I am guessing it is the latter (if so, I can easily amend locally without a need for rerolling).
Sorry, my English. I should say: Johannes helped to test these test cases on Windows, and found that ...
Quoted 13 lines
Quoted 13 lines
tests should be skipped on Windows. This is because the bash on Windows rewrites arguments of regular Windows programs, such as git and the test helpers, if the arguments look like absolute POSIX paths. As a consequence, the actual tests performed are not what the tests scripts expect.
The tests that need *not* be skipped are those where the two paths passed to 'test-path-utils
relative_path' have the same prefix and the result is expected to be a relative path. This is because the rewriting changes "/a/b" to "D:/Src/MSysGit/a/b", and when both inputs are extended the same way, this just cancels out in the relative path computation.
Quoted 8 lines
Quoted 3 lines
Signed-off-by Jiang Xin <[email protected]>Signed-off-by Johannes Sixt <[email protected]>Signed-off-by Junio C Hamano <[email protected]>I somehow lost track, but does the above list of sign-offs reflect the origins of the changes contained in this patch, or is the second one meant to be helped-by or something (if so, I can easily amend locally without a need for rerolling)?
Johannes offered a nice patch based on the last one of this patch series. I move his patch right after the first patch (patch 01: test: add test cases for relative_path). But I think as a cooking topic, it should not has a commit to fix another. So I squash Johannes' commit to the previous commit, and add his signed-off-by.
--
Jiang Xin
PATCH v15 2/16 path.c: refactor relative_path(), not only strip prefix
In reply to Jiang XinOriginal design of relative_path() is simple, just strip the prefix (*base) from the absolute path (*abs). In most cases, we need a real relative path, such as: ../foo, ../../bar. That's why there is another reimplementation (path_relative()) in quote.c.
Borrowed some codes from path_relative() in quote.c to refactor relative_path() in path.c, so that it could return real relative path, and user can reuse this function without reimplement his/her own. The function path_relative() in quote.c will be substituted, and I would use the new relative_path() function when implement the interactive git-clean later.
Different results for relative_path() before and after this refactor:
abs path base path relative (original) relative (refactor)
======== ========= =================== ===================
/a/b/c/ /a/b c/ c/
/a/b//c/ //a///b/ c/ c/
/a/b /a/b . ./
/a/b/ /a/b . ./
/a /a/b/ /a ../
/ /a/b/ / ../../
/a/c /a/b/ /a/c ../c
/x/y /a/b/ /x/y ../../x/y
/a/b (empty) /a/b /a/b
/a/b (null) /a/b /a/b a/b/c/ a/b/ c/ c/
a/b/c/ a/b c/ c/
a/b//c a//b c c
a/b/ a/b/ . ./
a/b/ a/b . ./
a a/b a ../
x/y a/b/ x/y ../../x/y
a/c a/b a/c ../c
a/b (empty) a/b a/b
a/b (null) a/b a/b (empty) (null) (empty) ./
(empty) (empty) (empty) ./
(empty) /a/b (empty) ./
(null) (null) (null) ./
(null) (empty) (null) ./
(null) /a/b (segfault) ./You may notice that return value "." has been changed to "./". It is because:
* Function quote_path_relative() in quote.c will show the relative path as "./" if abs(in) and base(prefix) are the same.
* Function relative_path() is called only once (in setup.c), and it will be OK for the return value as "./" instead of ".".
--- cache.h | 2 +- path.c | 116 +++++++++++++++++++++++++++++++++++++------------- setup.c | 5 ++- t/t0060-path-utils.sh | 39 ++++++++--------- test-path-utils.c | 4 +- 5 files changed, 113 insertions(+), 53 deletions(-)
cache.h +1 -1
@@ -758,7 +758,7 @@ int is_directory(const char *);const char *real_path (const char *path);const char *real_path_if_valid (const char *path);const char *absolute_path (const char *path); -const char *relative_path (const char *abs,const char *base); +const char *relative_path (const char *in,const char *prefix,struct strbuf *sb);int normalize_path_copy (char *dst,const char *src);int longest_ancestor_length (const char *path,struct string_list *prefixes);char *strip_path_suffix (const char *path,const char *suffix);
path.c +87 -29
129 lines not on this page · raw message
setup.c +4 -1
@@ -360,6 +360,7 @@ int is_inside_work_tree(void)void setup_work_tree (void ) { +struct strbuf sb =STRBUF_INIT ;const char *work_tree, *git_dir;static int initialized =0 ;
@@ -379,8 +380,10 @@ void setup_work_tree(void)if (getenv (GIT_WORK_TREE_ENVIRONMENT ))setenv (GIT_WORK_TREE_ENVIRONMENT ,"." ,1 ); -set_git_dir (relative_path (git_dir, work_tree)); +set_git_dir (relative_path (git_dir, work_tree, &sb)); initialized =1 ; + +strbuf_release (&sb); }static int check_repository_format_gently (const char *gitdir,int *nongit_ok)
t/t0060-path-utils.sh +18 -21
@@ -191,33 +191,30 @@ test_expect_success SYMLINKS 'real path works on symlinks' ' relative_path /a/b/c/ /a/b/ c/ relative_path /a/b/c/ /a/b c/ relative_path /a//b//c/ //a/b// c/ POSIX -relative_path /a/b /a/b . -relative_path /a/b/ /a/b . -relative_path /a /a/b /a POSIX -relative_path / /a/b/ / POSIX -relative_path /a/c /a/b/ /a/c POSIX -relative_path /a/c /a/b /a/c POSIX -relative_path /x/y /a/b/ /x/y POSIX +relative_path /a/b /a/b ./ +relative_path /a/b/ /a/b ./ +relative_path /a /a/b ../ +relative_path / /a/b/ ../../ +relative_path /a/c /a/b/ ../c +relative_path /a/c /a/b ../c +relative_path /x/y /a/b/ ../../x/y relative_path /a/b "<empty>" /a/b POSIX relative_path /a/b "<null>" /a/b POSIX relative_path a/b/c/ a/b/ c/ relative_path a/b/c/ a/b c/ relative_path a/b//c a//b c -relative_path a/b/ a/b/ . -relative_path a/b/ a/b . -relative_path a a/b a # TODO: should be: .. -relative_path x/y a/b x/y # TODO: should be: ../../x/y -relative_path a/c a/b a/c # TODO: should be: ../c +relative_path a/b/ a/b/ ./ +relative_path a/b/ a/b ./ +relative_path a a/b ../ +relative_path x/y a/b ../../x/y +relative_path a/c a/b ../c relative_path a/b "<empty>" a/b relative_path a/b "<null>" a/b -relative_path "<empty>" /a/b "(empty)" -relative_path "<empty>" "<empty>" "(empty)" -relative_path "<empty>" "<null>" "(empty)" -relative_path "<null>" "<empty>" "(null)" -relative_path "<null>" "<null>" "(null)" - -test_expect_failure 'relative path: <null> /a/b => segfault' ' - test-path-utils relative_path "<null>" "/a/b" -' +relative_path "<empty>" /a/b ./ +relative_path "<empty>" "<empty>" ./ +relative_path "<empty>" "<null>" ./ +relative_path "<null>" "<empty>" ./ +relative_path "<null>" "<null>" ./ +relative_path "<null>" /a/b ./ test_done
test-path-utils.c +3 -1
@@ -117,14 +117,16 @@ int main(int argc, char **argv) }if (argc ==4 && !strcmp (argv[1 ],"relative_path" )) { +struct strbuf sb =STRBUF_INIT ;const char *in, *prefix, *rel;normalize_argv_string (&in, argv[2 ]);normalize_argv_string (&prefix, argv[3 ]); - rel =relative_path (in, prefix); + rel =relative_path (in, prefix, &sb);if (!rel)puts ("(null)" );else puts (strlen (rel) >0 ? rel :"(empty)" ); +strbuf_release (&sb);return 0 ; }
Signature · 1 line
1.8.3.1.756.g2e9b71f
Re: [PATCH v15 02/16] path.c: refactor relative_path(), not only strip prefix
Quoted 6 lines · Jiang Xin
Original design of
relative_path()is simple, just strip the prefix (*base) from the absolute path (*abs). In most cases, we need a real relative path, such as: ../foo, ../../bar. That's why there is another reimplementation (path_relative()) inquote.c.Borrowed some codes from
path_relative()inquote.cto refactor
s/Borrowed/Borrow/; will locally amend.
Quoted 2 lines
relative_path()inpath.c, so that it could return real relative path, and user can reuse this function without reimplement his/her own.
s/reimplement/&ing/; will locally amend.
Quoted 2 lines
The function
path_relative()inquote.cwill be substituted, and I would use the newrelative_path()function when implement the
s/implement/&ing/; will locally amend.
Quoted 3 lines
interactive git-clean later.
Different results for
relative_path()before and after this refactor:
I'd remove the rows that show the same result in the latter two columns (will locally amend, if you do not object).
Quoted 22 lines
abs path base path relative (original) relative (refactor) ======== ========= =================== =================== /a/b /a/b . ./ /a/b/ /a/b . ./ /a /a/b/ /a ../ / /a/b/ / ../../ /a/c /a/b/ /a/c ../c /x/y /a/b/ /x/y ../../x/ya/b/ a/b/ . ./ a/b/ a/b . ./ a a/b a ../ x/y a/b/ x/y ../../x/y a/c a/b a/c ../c(empty) (null) (empty) ./ (empty) (empty) (empty) ./ (empty) /a/b (empty) ./ (null) (null) (null) ./ (null) (empty) (null) ./ (null) /a/b (segfault) ./
Quoted 8 lines
You may notice that return value "." has been changed to "./". It is because:
* Function
quote_path_relative()inquote.cwill show the relative path as "./" if abs(in) and base(prefix) are the same.* Function
relative_path()is called only once (insetup.c), and it will be OK for the return value as "./" instead of ".".
Good explanation. Thanks.
Quoted 35 lines
Signed-off-by Jiang Xin <[email protected]>Signed-off-by Junio C Hamano <[email protected]>--- cache.h | 2 +- path.c | 116 +++++++++++++++++++++++++++++++++++++------------- setup.c | 5 ++- t/t0060-path-utils.sh | 39 ++++++++--------- test-path-utils.c | 4 +- 5 files changed, 113 insertions(+), 53 deletions(-)cache.h +1
-1@@ -758,7 +758,7 @@ int is_directory(const char *);const char *real_path (const char *path);const char *real_path_if_valid (const char *path);const char *absolute_path (const char *path); -const char *relative_path (const char *abs,const char *base); +const char *relative_path (const char *in,const char *prefix,struct strbuf *sb);int normalize_path_copy (char *dst,const char *src);int longest_ancestor_length (const char *path,struct string_list *prefixes);char *strip_path_suffix (const char *path,const char *suffix);path.c +4
-0@@ -441,42 +441,100 @@ int adjust_shared_perm(const char *path)return 0 ; } +/* +* Give path as relative to prefix. +* +* The strbuf may or may not be used, so do not assume it contains the
path.c int adjust_shared_perm(const char *path) · line 457
Quoted 10 lines
path.c +9
-0+* returned path. +*/ +const char *relative_path (const char *in,const char *prefix, +struct strbuf *sb) { +int in_len = in ?strlen (in) :0 ; +int prefix_len = prefix ?strlen (prefix) :0 ; +int in_off =0 ; +int prefix_off =0 ; +int i =0 ,j =0 ;
s/0,j/0, j/; will locally amend.
path.c int adjust_shared_perm(const char *path) · line 469
Quoted 12 lines
path.c +10
-0+ +if (!in_len) +return "./" ; +else if (!prefix_len) +return in; + +while (i < prefix_len && j < in_len && prefix[i] == in[j]) { +if (is_dir_sep (prefix[i])) { +while (is_dir_sep (prefix[i])) i++; +while (is_dir_sep (in[j])) j++;
These i++/j++ are not checked for lengths of strings, but it is OK because is_dir_sep() will never return true for NUL.
path.c int adjust_shared_perm(const char *path) · line 471
Quoted 2 lines
path.c +2
-0+ prefix_off = i; + in_off = j;
(mental note) *_off keeps track of the last directory separator of the common part, i.e. where the difference begins.
path.c int adjust_shared_perm(const char *path) · line 480
Quoted 9 lines
path.c +9
-0+ }else { + i++; + j++; + } + } + + if ( + /* "prefix" seems like prefix of "in" */ + i >= prefix_len &&
So shouldn't this be "i == prefix_len"?
path.c int adjust_shared_perm(const char *path) · line 486
Quoted 6 lines
path.c +6
-0+/* +* but "/foo" is not a prefix of "/foobar" +* (i.e. prefix not end with '/') +*/ + prefix_off < prefix_len) { +if (j >= in_len) {
Again, "j == in_len", isn't it? Or can i and j overrun in_len and prefix_len?
Quoted 15 lines
path.c +15
-0+/* in="/a/b", prefix="/a/b" */ + in_off = in_len; + }else if (is_dir_sep (in[j])) { +/* in="/a/b/c", prefix="/a/b" */ +while (is_dir_sep (in[j])) + j++; + in_off = j; + }else { +/* in="/a/bbb/c", prefix="/a/b" */ + i = prefix_off; + } + } else if ( + /* "in" is short than "prefix" */ + j >= in_len && +/* "in" not end with '/' */
path.c int adjust_shared_perm(const char *path) · line 511
Quoted 10 lines
path.c +10
-0+ in_off < in_len) { +if (is_dir_sep (prefix[i])) { +/* in="/a/b", prefix="/a/b/c/" */ +while (is_dir_sep (prefix[i])) + i++; + in_off = in_len; + } + } + in += in_off; + in_len -= in_off;
(mental note) Now in points at the part after stripping common leading directories and in_len is adjusted accordingly.
path.c int adjust_shared_perm(const char *path) · line 513
Quoted 1 line
path.c +1
-0+if (i >= prefix_len) {
(mental note) it turns out that "in" covered the entire prefix, so there is no need for "../" in this case.
Quoted 8 lines
path.c +8
-0+if (!in_len) +return "./" ; +else +return in; + } + +strbuf_reset (sb); +strbuf_grow (sb, in_len);
path.c int adjust_shared_perm(const char *path) · line 531
Quoted 10 lines
path.c +6
-0+ +while (i < prefix_len) { +if (is_dir_sep (prefix[i])) { +strbuf_addstr (sb,"../" ); +while (is_dir_sep (prefix[i])) + i++;continue ; } i++; }
(mental note) otherwise count '/' in the remainder of the prefix and prepend as many "../" as necessary.
path.c int adjust_shared_perm(const char *path) · line 533
Quoted 2 lines
path.c +2
-0+if (!is_dir_sep (prefix[prefix_len -1 ])) +strbuf_addstr (sb,"../" );
(mental note) ... and one more? E.g. for prefix="/a/b/c" in="/a/x", we stripped the common "/a/" and the above loop started counting from 'b' in the prefix, which counted one slash between b and c, but we need to go two levels up. If prefix were "/a/b/c/", we would already have counted the slash after c, so we do not need to do so.
OK.
Re: [PATCH v15 02/16] path.c: refactor relative_path(), not only strip prefix
2013/6/27 Junio C Hamano <[email protected]>:
Quoted 19 lines
path.c int adjust_shared_perm(const char *path) · line 480
Quoted 9 lines
path.c +9
-0+ }else { + i++; + j++; + } + } + + if ( + /* "prefix" seems like prefix of "in" */ + i >= prefix_len &&So shouldn't this be "i ==
prefix_len"?path.c int adjust_shared_perm(const char *path) · line 486
Quoted 6 lines
path.c +6
-0+/* +* but "/foo" is not a prefix of "/foobar" +* (i.e. prefix not end with '/') +*/ + prefix_off < prefix_len) { +if (j >= in_len) {
Quoted 2 lines
Again, "j ==
in_len", isn't it? Or can i and j overrunin_lenandprefix_len?
Yes, better write as ==. But both will pass the test cases. Since this commit has been merged to next, so let it be?
Signature · 1 line
Jiang Xin
PATCH v15 3/16 quote.c: substitute path_relative with relative_path
In reply to Jiang XinSubstitute the function path_relative in quote.c with the function relative_path. Function relative_path can be treated as an enhanced and robust version of path_relative.
Outputs of path_relative and it's replacement (relative_path) are the same for the following cases:
path prefix output of path_relative output of relative_path
======== ========= ======================= =======================
/a/b/c/ /a/b/ c/ c/
/a/b/c /a/b/ c c
/a/ /a/b/ ../ ../
/ /a/b/ ../../ ../../
/a/c /a/b/ ../c ../c
/x/y /a/b/ ../../x/y ../../x/y
a/b/c/ a/b/ c/ c/
a/ a/b/ ../ ../
x/y a/b/ ../../x/y ../../x/y
/a/b (empty) /a/b /a/b
/a/b (null) /a/b /a/b
a/b (empty) a/b a/b
a/b (null) a/b a/bBut if both of the path and the prefix are the same, or the returned relative path should be the current directory, the outputs of both functions are different. Function relative_path returns "./", while function path_relative returns empty string.
path prefix output of path_relative output of relative_path
======== ========= ======================= =======================
/a/b/ /a/b/ (empty) ./
a/b/ a/b/ (empty) ./
(empty) (null) (empty) ./
(empty) (empty) (empty) ./But not panic, the callers of path_relative can handle such cases, or never encounter this issue at all. E.g.
* In function quote_path_relative, if the output of path_relative is empty, append "./" to it, like:
if (!out->len)
strbuf_addstr(out, "./"); * Another caller is write_name_quoted_relative, which is only used by builtin/ls-files.c. git-ls-files only show files, so path of files will never be identical with the prefix of a directory.
The following differences show that path_relative can not handle extra slashes properly.
path prefix output of path_relative output of relative_path
======== ========= ======================= =======================
/a//b//c/ //a/b// ../../../../a//b//c/ c/
a/b//c a//b ../b//c cAnd if prefix has no trailing slash, path_relative can not work properly either. But since prefix always has a trailing slash, so it's not a problem.
path prefix output of path_relative output of relative_path
======== ========= ======================= =======================
/a/b/c/ /a/b b/c/ c/
/a/b /a/b b ./
/a/b/ /a/b b/ ./
/a /a/b/ ../../a ../
a/b/c/ a/b b/c/ c/
a/b/ a/b b/ ./
a a/b ../a ../
x/y a/b/ ../x/y ../../x/y
a/c a/b c ../c
/a/ /a/b (empty) ../
(empty) /a/b ../../ ./--- builtin/ls-files.c | 7 +++++-- quote.c | 55 ++---------------------------------------------------- 2 files changed, 7 insertions(+), 55 deletions(-)
builtin/ls-files.c +5 -2
@@ -48,8 +48,11 @@ static const char *tag_resolve_undo = "";static void write_name (const char * name,size_t len) { -write_name_quoted_relative (name, len, prefix, prefix_len, stdout, - line_terminator); +/* Since prefix_len is ignored in write_name_quoted_relative, we +* should turn off prefix here in case of running "git ls-files" +* with "--full-name" option */ +write_name_quoted_relative (name, len, prefix_len ? prefix :NULL , + prefix_len, stdout, line_terminator); }static void show_dir_entry (const char *tag,struct dir_entry *ent)
quote.c +2 -53
77 lines not on this page · raw message
Signature · 1 line
1.8.3.1.756.g2e9b71f
Re: [PATCH v15 03/16] quote.c: substitute path_relative with relative_path
Quoted 7 lines · Jiang Xin
Substitute the function
path_relativeinquote.cwith the functionrelative_path. Functionrelative_pathcan be treated as an enhanced and robust version ofpath_relative.
...
And if prefix has no trailing slash,path_relativecan not work properly either. But since prefix always has a trailing slash, so it's not a problem.
Nicely explained.
Review
Quoted 10 lines
static void
write_name(const char* name, size_t len){(quoted diff) +5
-2- write_name_quoted_relative(name, len, prefix, prefix_len, stdout, - line_terminator); + /* Since prefix_len is ignored in write_name_quoted_relative, we + * should turn off prefix here in case of running "git ls-files" + * with "--full-name" option */ + write_name_quoted_relative(name, len, prefix_len ? prefix : NULL, + prefix_len, stdout, line_terminator); }
I'd tweak this function and write_naem_quoted_relative(), and explain the reason for doing so in the log message. Please check what I'll push out on 'pu' later today.
-- >8 --
Subject: [PATCH] fix write_name() and write_name_quoted_relative() signature
The write_name_quoted_relative() function used to accept its two parameters as counted strings. Since it now uses relative_path(), which requires both input strings to be NUL-terminated, the API of this function need to be audited carefully.
Luckily, the only one caller is write_name() in builtin/ls-files.c, and it in turn has only three callers. They pass the string to be made relative at this function and all of these strings happen to be NUL terminated. We can safely lose "len" parameter of write_name(), and write_name_quoted_relative() can safely lose the length of its name parameter as well.
The "prefix_len" parameter of write_name_quoted_relative() is either 0 (when "ls-files --full-name" is used), or the length of the prefix string (i.e. the path to the current subdirectory). By checking the "--full-name" case in the caller, i.e. write_name(), we can make write_name_quoted_relative() not to require the prefix as a counted string.
--- builtin/ls-files.c | 17 ++++++++--------- quote.c | 3 +-- quote.h | 5 ++--- 3 files changed, 11 insertions(+), 14 deletions(-)
builtin/ls-files.c +8 -9
@@ -46,13 +46,12 @@ static const char *tag_modified = "";static const char *tag_skip_worktree ="" ;static const char *tag_resolve_undo ="" ; -static void write_name (const char * name,size_t len) +static void write_name (const char *name) { -/* Since prefix_len is ignored in write_name_quoted_relative, we -* should turn off prefix here in case of running "git ls-files" -* with "--full-name" option */ -write_name_quoted_relative (name, len, prefix_len ? prefix :NULL , - prefix_len, stdout, line_terminator); +/* (prefix_len == 0) is for "--full-name" output */ +write_name_quoted_relative (name, + prefix_len ? prefix :NULL , + stdout, line_terminator); }static void show_dir_entry (const char *tag,struct dir_entry *ent)
@@ -66,7 +65,7 @@ static void show_dir_entry(const char *tag, struct dir_entry *ent)return ;fputs (tag, stdout); -write_name (ent->name, ent->len); +write_name (ent->name); }static void show_other_files (struct dir_struct *dir)
@@ -166,7 +165,7 @@ static void show_ce_entry(const char *tag, struct cache_entry *ce)find_unique_abbrev (ce->sha1,abbrev), ce_stage(ce)); } -write_name (ce->name,ce_namelen (ce)); +write_name (ce->name);if (debug_mode) {printf (" ctime: %d:%d\n" , ce->ce_ctime.sec, ce->ce_ctime.nsec);printf (" mtime: %d:%d\n" , ce->ce_mtime.sec, ce->ce_mtime.nsec);
@@ -199,7 +198,7 @@ static void show_ru_info(void)printf ("%s%06o %s %d\t" , tag_resolve_undo, ui->mode[i],find_unique_abbrev (ui->sha1[i], abbrev), i +1 ); -write_name (path, len); +write_name (path); } } }
quote.c +1 -2
@@ -312,8 +312,7 @@ void write_name_quotedpfx(const char *pfx, size_t pfxlen,fputc (terminator, fp); } -void write_name_quoted_relative (const char *name,size_t len, -const char *prefix,size_t prefix_len, +void write_name_quoted_relative (const char *name,const char *prefix,FILE *fp,int terminator) {struct strbuf sb =STRBUF_INIT ;
quote.h +2 -3
@@ -60,9 +60,8 @@ extern void quote_two_c_style(struct strbuf *, const char *, const char *, int);extern void write_name_quoted (const char *name,FILE *,int terminator);extern void write_name_quotedpfx (const char *pfx,size_t pfxlen,const char *name,FILE *,int terminator); -extern void write_name_quoted_relative (const char *name,size_t len, -const char *prefix,size_t prefix_len, -FILE *fp,int terminator); +extern void write_name_quoted_relative (const char *name,const char *prefix, +FILE *fp,int terminator);/* quote path as relative to the given prefix */ extern char *quote_path_relative(const char *in, int len,
Signature · 1 line
1.8.3.1-773-g7e1bb7d
PATCH v15 4/16 Refactor quote_path_relative, remove unused params
In reply to Jiang XinAfter substitute path_relative() in quote.c with relative_path() from path.c, parameters (such as len and prefix_len) are obsolete in function quote_path_relative(). Remove unused parameters and change the order of parameters for quote_path_relative() function.
--- builtin/clean.c | 18 +++++++++--------- builtin/grep.c | 5 ++--- builtin/ls-files.c | 2 +- quote.c | 7 ++----- quote.h | 4 ++-- wt-status.c | 17 ++++++++--------- 6 files changed, 24 insertions(+), 29 deletions(-)
builtin/clean.c +9 -9
@@ -56,7 +56,7 @@ static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,if ((force_flag &REMOVE_DIR_KEEP_NESTED_GIT ) && !resolve_gitlink_ref (path->buf,"HEAD" , submodule_head)) {if (!quiet) { -quote_path_relative (path->buf,strlen (path->buf), "ed, prefix); +quote_path_relative (path->buf, prefix, "ed);printf (dry_run ?_ (msg_would_skip_git_dir) :_ (msg_skip_git_dir), quoted.buf); }
@@ -70,7 +70,7 @@ static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,/* an empty dir could be removed even if it is unreadble */ res = dry_run ?0 :rmdir (path->buf);if (res) { -quote_path_relative (path->buf,strlen (path->buf), "ed, prefix); +quote_path_relative (path->buf, prefix, "ed);warning (_ (msg_warn_remove_failed), quoted.buf); *dir_gone =0 ; }
@@ -94,7 +94,7 @@ static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,if (remove_dirs (path, prefix, force_flag, dry_run, quiet, &gone)) ret =1 ;if (gone) { -quote_path_relative (path->buf,strlen (path->buf), "ed, prefix); +quote_path_relative (path->buf, prefix, "ed);string_list_append (&dels, quoted.buf); }else *dir_gone =0 ;
@@ -102,10 +102,10 @@ static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag, }else { res = dry_run ?0 :unlink (path->buf);if (!res) { -quote_path_relative (path->buf,strlen (path->buf), "ed, prefix); +quote_path_relative (path->buf, prefix, "ed);string_list_append (&dels, quoted.buf); }else { -quote_path_relative (path->buf,strlen (path->buf), "ed, prefix); +quote_path_relative (path->buf, prefix, "ed);warning (_ (msg_warn_remove_failed), quoted.buf); *dir_gone =0 ; ret =1 ;
@@ -127,7 +127,7 @@ static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,if (!res) *dir_gone =1 ;else { -quote_path_relative (path->buf,strlen (path->buf), "ed, prefix); +quote_path_relative (path->buf, prefix, "ed);warning (_ (msg_warn_remove_failed), quoted.buf); *dir_gone =0 ; ret =1 ;
@@ -262,7 +262,7 @@ int cmd_clean(int argc, const char **argv, const char *prefix)if (remove_dirs (&directory, prefix, rm_flags, dry_run, quiet, &gone)) errors++;if (gone && !quiet) { - qname =quote_path_relative (directory.buf, directory.len, &buf, prefix); + qname =quote_path_relative (directory.buf, prefix, &buf);printf (dry_run ?_ (msg_would_remove) :_ (msg_remove), qname); } }
@@ -272,11 +272,11 @@ int cmd_clean(int argc, const char **argv, const char *prefix)continue ; res = dry_run ?0 :unlink (ent->name);if (res) { - qname =quote_path_relative (ent->name,-1 , &buf, prefix); + qname =quote_path_relative (ent->name, prefix, &buf);warning (_ (msg_warn_remove_failed), qname); errors++; }else if (!quiet) { - qname =quote_path_relative (ent->name,-1 , &buf, prefix); + qname =quote_path_relative (ent->name, prefix, &buf);printf (dry_run ?_ (msg_would_remove) :_ (msg_remove), qname); } }
builtin/grep.c +2 -3
@@ -286,8 +286,7 @@ static int grep_sha1(struct grep_opt *opt, const unsigned char *sha1,struct strbuf pathbuf =STRBUF_INIT ;if (opt->relative && opt->prefix_length) { -quote_path_relative (filename + tree_name_len,-1 , &pathbuf, - opt->prefix); +quote_path_relative (filename + tree_name_len, opt->prefix, &pathbuf);strbuf_insert (&pathbuf,0 , filename, tree_name_len); }else {strbuf_addstr (&pathbuf, filename);
@@ -318,7 +317,7 @@ static int grep_file(struct grep_opt *opt, const char *filename)struct strbuf buf =STRBUF_INIT ;if (opt->relative && opt->prefix_length) -quote_path_relative (filename,-1 , &buf, opt->prefix); +quote_path_relative (filename, opt->prefix, &buf);else strbuf_addstr (&buf, filename);
builtin/ls-files.c +1 -1
@@ -394,7 +394,7 @@ int report_path_error(const char *ps_matched, const char **pathspec, const charif (found_dup)continue ; - name =quote_path_relative (pathspec[num],-1 , &sb, prefix); + name =quote_path_relative (pathspec[num], prefix, &sb);error ("pathspec '%s' did not match any file(s) known to git." , name); errors++;
quote.c +2 -5
@@ -325,8 +325,8 @@ void write_name_quoted_relative(const char *name, size_t len, }/* quote path as relative to the given prefix */ -char *quote_path_relative (const char *in,int len, -struct strbuf *out,const char *prefix) +char *quote_path_relative (const char *in,const char *prefix, +struct strbuf *out) {struct strbuf sb =STRBUF_INIT ;const char *rel =relative_path (in, prefix, &sb);
@@ -334,9 +334,6 @@ char *quote_path_relative(const char *in, int len,quote_c_style_counted (rel,strlen (rel), out,NULL ,0 );strbuf_release (&sb); -if (!out->len) -strbuf_addstr (out,"./" ); -return out->buf; }
quote.h +2 -2
@@ -65,8 +65,8 @@ extern void write_name_quoted_relative(const char *name, size_t len, FILE *fp, int terminator);/* quote path as relative to the given prefix */ -extern char *quote_path_relative (const char *in,int len, -struct strbuf *out,const char *prefix); +extern char *quote_path_relative (const char *in,const char *prefix, +struct strbuf *out);/* quoting as a string literal for other languages */ extern void perl_quote_print (FILE *stream,const char *src);
wt-status.c +8 -9
@@ -243,7 +243,7 @@ static void wt_status_print_unmerged_data(struct wt_status *s,struct strbuf onebuf =STRBUF_INIT ;const char *one, *how =_ ("bug" ); - one =quote_path (it->string,-1 , &onebuf, s->prefix); + one =quote_path (it->string, s->prefix, &onebuf);status_printf (s,color (WT_STATUS_HEADER , s),"\t" );switch (d->stagemask) {case 1 : how =_ ("both deleted:" );break ;
@@ -297,8 +297,8 @@ static void wt_status_print_change_data(struct wt_status *s, change_type); } - one =quote_path (one_name,-1 , &onebuf, s->prefix); - two =quote_path (two_name,-1 , &twobuf, s->prefix); + one =quote_path (one_name, s->prefix, &onebuf); + two =quote_path (two_name, s->prefix, &twobuf);status_printf (s,color (WT_STATUS_HEADER , s),"\t" );switch (status) {
@@ -706,8 +706,7 @@ static void wt_status_print_other(struct wt_status *s,struct string_list_item *it;const char *path; it = &(l->items[i]); - path =quote_path (it->string,strlen (it->string), - &buf, s->prefix); + path =quote_path (it->string, s->prefix, &buf);if (column_active (s->colopts)) {string_list_append (&output, path);continue ;
@@ -1291,7 +1290,7 @@ static void wt_shortstatus_unmerged(struct string_list_item *it, }else {struct strbuf onebuf =STRBUF_INIT ;const char *one; - one =quote_path (it->string,-1 , &onebuf, s->prefix); + one =quote_path (it->string, s->prefix, &onebuf);printf (" %s\n" , one);strbuf_release (&onebuf); }
@@ -1319,7 +1318,7 @@ static void wt_shortstatus_status(struct string_list_item *it,struct strbuf onebuf =STRBUF_INIT ;const char *one;if (d->head_path) { - one =quote_path (d->head_path,-1 , &onebuf, s->prefix); + one =quote_path (d->head_path, s->prefix, &onebuf);if (*one !='"' &&strchr (one,' ' ) !=NULL ) {putchar ('"' );strbuf_addch (&onebuf,'"' );
@@ -1328,7 +1327,7 @@ static void wt_shortstatus_status(struct string_list_item *it,printf ("%s -> " , one);strbuf_release (&onebuf); } - one =quote_path (it->string,-1 , &onebuf, s->prefix); + one =quote_path (it->string, s->prefix, &onebuf);if (*one !='"' &&strchr (one,' ' ) !=NULL ) {putchar ('"' );strbuf_addch (&onebuf,'"' );
@@ -1347,7 +1346,7 @@ static void wt_shortstatus_other(struct string_list_item *it, }else {struct strbuf onebuf =STRBUF_INIT ;const char *one; - one =quote_path (it->string,-1 , &onebuf, s->prefix); + one =quote_path (it->string, s->prefix, &onebuf);color_fprintf (s->fp,color (WT_STATUS_UNTRACKED , s),"%s" , sign);printf (" %s\n" , one);strbuf_release (&onebuf);
Signature · 1 line
1.8.3.1.756.g2e9b71f
Re: [PATCH v15 04/16] Refactor quote_path_relative, remove unused params
Quoted 8 lines · Jiang Xin
After substitute
path_relative()inquote.cwithrelative_path()frompath.c, parameters (such as len andprefix_len) are obsolete in functionquote_path_relative(). Remove unused parameters and change the order of parameters forquote_path_relative()function.Signed-off-by Jiang Xin <[email protected]>Signed-off-by Junio C Hamano <[email protected]>---
OK. I'll amend the log message a bit to say that we verified that this conversion is safe.
quote.c
Quoted 2 lines
quote.c +0
-0
You seem to be using unusually short abbrev length.
Please don't, at least in format-patch output.
"ebb8" may be unique within your repository, but may not be unique in repositories of other people who attempt to apply your patches.
Offtopic. Fixing this, without forcing you to use the default abbrev length everywhere, _might_ require a bit of changes to the configuration mechanism, or "git format-patch", or both. I've also seen in some other thread that --numstat was used in addition to the usual --stat, which should not be added to format-patch output only because the user configured it for other "diff/log" uses, which may also need to be fixed in the same way.
Re: [PATCH v15 04/16] Refactor quote_path_relative, remove unused params
2013/6/27 Junio C Hamano <[email protected]>:
Quoted 10 lines
quote.c
Quoted 2 lines
quote.c +0
-0You seem to be using unusually short abbrev length.
Please don't, at least in format-patch output.
"ebb8" may be unique within your repository, but may not be unique in repositories of other people who attempt to apply your patches.
Quoted 7 lines
Offtopic. Fixing this, without forcing you to use the default abbrev length everywhere, _might_ require a bit of changes to the configuration mechanism, or "git format-patch", or both. I've also seen in some other thread that --numstat was used in addition to the usual --stat, which should not be added to format-patch output only because the user configured it for other "diff/log" uses, which may also need to be fixed in the same way.
Thank you for your notice. I find that I have a setting: core.abbrev=4, which overrides the default. Maybe I set it two years ago, when I wrote my book on Git in Chinese.
Signature · 1 line
Jiang Xin
PATCH v15 5/16 Refactor write_name_quoted_relative, remove unused params
In reply to Jiang XinAfter substitute path_relative() in quote.c with relative_path() from path.c, parameters (such as len and prefix_len) are obsolete in function write_name_quoted_relative(). Remove unused parameters from write_name_quoted_relative() and related functions.
--- builtin/ls-files.c | 14 +++++++------- quote.c | 3 +-- quote.h | 3 +-- 3 files changed, 9 insertions(+), 11 deletions(-)
builtin/ls-files.c +7 -7
@@ -46,13 +46,13 @@ static const char *tag_modified = "";static const char *tag_skip_worktree ="" ;static const char *tag_resolve_undo ="" ; -static void write_name (const char * name,size_t len) +static void write_name (const char *name) { -/* Since prefix_len is ignored in write_name_quoted_relative, we +/* Since prefix_len won't pass to write_name_quoted_relative, we * should turn off prefix here in case of running "git ls-files" * with "--full-name" option */ -write_name_quoted_relative (name, len, prefix_len ? prefix :NULL , - prefix_len, stdout, line_terminator); +write_name_quoted_relative (name, prefix_len ? prefix :NULL , + stdout, line_terminator); }static void show_dir_entry (const char *tag,struct dir_entry *ent)
@@ -66,7 +66,7 @@ static void show_dir_entry(const char *tag, struct dir_entry *ent)return ;fputs (tag, stdout); -write_name (ent->name, ent->len); +write_name (ent->name); }static void show_other_files (struct dir_struct *dir)
@@ -166,7 +166,7 @@ static void show_ce_entry(const char *tag, struct cache_entry *ce)find_unique_abbrev (ce->sha1,abbrev), ce_stage(ce)); } -write_name (ce->name,ce_namelen (ce)); +write_name (ce->name);if (debug_mode) {struct stat_data *sd = &ce->ce_stat_data;
@@ -201,7 +201,7 @@ static void show_ru_info(void)printf ("%s%06o %s %d\t" , tag_resolve_undo, ui->mode[i],find_unique_abbrev (ui->sha1[i], abbrev), i +1 ); -write_name (path, len); +write_name (path); } } }
quote.c +1 -2
@@ -312,8 +312,7 @@ void write_name_quotedpfx(const char *pfx, size_t pfxlen,fputc (terminator, fp); } -void write_name_quoted_relative (const char *name,size_t len, -const char *prefix,size_t prefix_len, +void write_name_quoted_relative (const char *name,const char *prefix,FILE *fp,int terminator) {struct strbuf sb =STRBUF_INIT ;
quote.h +1 -2
@@ -60,8 +60,7 @@ extern void quote_two_c_style(struct strbuf *, const char *, const char *, int);extern void write_name_quoted (const char *name,FILE *,int terminator);extern void write_name_quotedpfx (const char *pfx,size_t pfxlen,const char *name,FILE *,int terminator); -extern void write_name_quoted_relative (const char *name,size_t len, -const char *prefix,size_t prefix_len, +extern void write_name_quoted_relative (const char *name,const char *prefix,FILE *fp,int terminator);/* quote path as relative to the given prefix */
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 6/16 git-clean: refactor git-clean into two phases
In reply to Jiang XinBefore introducing interactive git-clean, refactor git-clean operations into two phases:
* hold cleaning items in del_list,
* and remove them in a separate loop at the end.
We will introduce interactive git-clean between the two phases. The interactive git-clean will show what would be done and must confirm before do real cleaning.
--- builtin/clean.c | 64 ++++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 45 insertions(+), 19 deletions(-)
builtin/clean.c +45 -19
@@ -15,6 +15,7 @@#include "quote.h" static int force =-1 ;/* unset */ +static struct string_list del_list =STRING_LIST_INIT_DUP ;static const char *const builtin_clean_usage[] = {N_ ("git clean [-d] [-f] [-n] [-q] [-e <pattern>] [-x | -X] [--] <paths>..." ),
@@ -148,12 +149,13 @@ int cmd_clean(int argc, const char **argv, const char *prefix)int dry_run =0 , remove_directories =0 , quiet =0 , ignored =0 ;int ignored_only =0 , config_set =0 , errors =0 , gone =1 ;int rm_flags =REMOVE_DIR_KEEP_NESTED_GIT ; -struct strbuf directory =STRBUF_INIT ; +struct strbuf abs_path =STRBUF_INIT ;struct dir_struct dir;static const char **pathspec;struct strbuf buf =STRBUF_INIT ;struct string_list exclude_list =STRING_LIST_INIT_NODUP ;struct exclude_list *el; +struct string_list_item *item;const char *qname;char *seen =NULL ;struct option options[] = {
@@ -223,6 +225,7 @@ int cmd_clean(int argc, const char **argv, const char *prefix)int matches =0 ;struct cache_entry *ce;struct stat st; +const char *rel;/* * Remove the '/' at the end that directory
@@ -242,13 +245,8 @@ int cmd_clean(int argc, const char **argv, const char *prefix)continue ;/* Yup, this one exists unmerged */ } -/* -* we might have removed this as part of earlier -* recursive directory removal, so lstat() here could -* fail with ENOENT. -*/ if (lstat (ent->name, &st)) -continue ; +die_errno ("Cannot lstat '%s'" , ent->name);if (pathspec) {memset (seen,0 , argc >0 ? argc :1 );
@@ -257,33 +255,61 @@ int cmd_clean(int argc, const char **argv, const char *prefix) }if (S_ISDIR (st.st_mode)) { -strbuf_addstr (&directory, ent->name);if (remove_directories || (matches ==MATCHED_EXACTLY )) { -if (remove_dirs (&directory, prefix, rm_flags, dry_run, quiet, &gone)) - errors++; -if (gone && !quiet) { - qname =quote_path_relative (directory.buf, prefix, &buf); -printf (dry_run ?_ (msg_would_remove) :_ (msg_remove), qname); - } + rel =relative_path (ent->name, prefix, &buf); +string_list_append (&del_list, rel); } -strbuf_reset (&directory); }else {if (pathspec && !matches)continue ; - res = dry_run ?0 :unlink (ent->name); + rel =relative_path (ent->name, prefix, &buf); +string_list_append (&del_list, rel); + } + } + +/* TODO: do interactive git-clean here, which will modify del_list */ + +for_each_string_list_item (item, &del_list) { +struct stat st; + +if (prefix) +strbuf_addstr (&abs_path, prefix); + +strbuf_addstr (&abs_path, item->string); + +/* +* we might have removed this as part of earlier +* recursive directory removal, so lstat() here could +* fail with ENOENT. +*/ +if (lstat (abs_path.buf, &st)) +continue ; + +if (S_ISDIR (st.st_mode)) { +if (remove_dirs (&abs_path, prefix, rm_flags, dry_run, quiet, &gone)) + errors++; +if (gone && !quiet) { + qname =quote_path_relative (item->string,NULL , &buf); +printf (dry_run ?_ (msg_would_remove) :_ (msg_remove), qname); + } + }else { + res = dry_run ?0 :unlink (abs_path.buf);if (res) { - qname =quote_path_relative (ent->name, prefix, &buf); + qname =quote_path_relative (item->string,NULL , &buf);warning (_ (msg_warn_remove_failed), qname); errors++; }else if (!quiet) { - qname =quote_path_relative (ent->name, prefix, &buf); + qname =quote_path_relative (item->string,NULL , &buf);printf (dry_run ?_ (msg_would_remove) :_ (msg_remove), qname); } } +strbuf_reset (&abs_path); }free (seen); -strbuf_release (&directory); +strbuf_release (&abs_path); +strbuf_release (&buf); +string_list_clear (&del_list,0 );string_list_clear (&exclude_list,0 );return (errors !=0 ); }
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 7/16 git-clean: add support for -i/--interactive
In reply to Jiang XinShow what would be done and the user must confirm before actually cleaning.
Would remove ...
Would remove ...
Would remove ...
Remove [y/n]?
Press "y" to start cleaning, and press "n" if you want to abort.
--- Documentation/git-clean.txt | 10 ++++++-- builtin/clean.c | 57 +++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 60 insertions(+), 7 deletions(-)
Documentation/git-clean.txt +8 -2
@@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree SYNOPSIS -------- [verse] -'git clean' [-d] [-f] [-n] [-q] [-e <pattern>] [-x | -X] [--] <path>... +'git clean' [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <path>... DESCRIPTION -----------
@@ -34,7 +34,13 @@ OPTIONS -f:: --force:: If the Git configuration variable clean.requireForce is not set - to false, 'git clean' will refuse to run unless given -f or -n. + to false, 'git clean' will refuse to run unless given -f, -n or + -i. + +-i:: +--interactive:: + Show what would be done and the user must confirm before actually + cleaning. -n:: --dry-run::
builtin/clean.c +52 -5
93 lines not on this page · raw message
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 8/16 git-clean: show items of del_list in columns
In reply to Jiang XinWhen there are lots of items to be cleaned, it is hard to see them all in one screen. Show them in columns will solve this problem.
--- Documentation/config.txt | 4 ++++ builtin/clean.c | 49 +++++++++++++++++++++++++++++++++++++++--------- 2 files changed, 44 insertions(+), 9 deletions(-)
Documentation/config.txt +4 -0
@@ -959,6 +959,10 @@ column.branch:: Specify whether to output branch listing in `git branch` in columns. See `column.ui` for details. +column.clean:: + Specify the layout when list items in `git clean -i`, which always + shows files and directories in columns. See `column.ui` for details. + column.status:: Specify whether to output untracked files in `git status` in columns. See `column.ui` for details.
builtin/clean.c +40 -9
86 lines not on this page · raw message
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 9/16 git-clean: add colors to interactive git-clean
In reply to Jiang XinShow header, help, error messages, and prompt in colors for interactive git-clean. Re-use config variables, such as "color.interactive" and "color.interactive.<slot>" for command git-add--interactive.
--- Documentation/config.txt | 17 +++++------ builtin/clean.c | 73 +++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 81 insertions(+), 9 deletions(-)
Documentation/config.txt +9 -8
@@ -879,16 +879,17 @@ The values of these variables may be specified as in color.branch.<slot>. color.interactive:: When set to `always`, always use colors for interactive prompts - and displays (such as those used by "git-add --interactive"). - When false (or `never`), never. When set to `true` or `auto`, use - colors only when the output is to the terminal. Defaults to false. + and displays (such as those used by "git-add --interactive" and + "git-clean --interactive"). When false (or `never`), never. + When set to `true` or `auto`, use colors only when the output is + to the terminal. Defaults to false. color.interactive.<slot>:: - Use customized color for 'git add --interactive' - output. `<slot>` may be `prompt`, `header`, `help` or `error`, for - four distinct types of normal output from interactive - commands. The values of these variables may be specified as - in color.branch.<slot>. + Use customized color for 'git add --interactive' and 'git clean + --interactive' output. `<slot>` may be `prompt`, `header`, `help` + or `error`, for four distinct types of normal output from + interactive commands. The values of these variables may be + specified as in color.branch.<slot>. color.pager:: A boolean to enable/disable colored output when the pager is in
builtin/clean.c +72 -1
108 lines not on this page · raw message
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 10/16 git-clean: use a git-add-interactive compatible UI
In reply to Jiang XinRewrite menu using a new method list_and_choose, which is borrowed from git-add--interactive.perl. We will use this framework to add new actions for interactive git-clean later.
Please NOTE:
* Method list_and_choose return an array of integers, and
* it is up to you to free the allocated memory of the array.
* The array ends with EOF.
* If user pressed CTRL-D (i.e. EOF), no selection returned.
--- builtin/clean.c | 456 ++++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 427 insertions(+), 29 deletions(-)
builtin/clean.c +427 -29
@@ -50,6 +50,36 @@ enum color_clean { CLEAN_COLOR_ERROR = 5, }; +#define MENU_OPTS_SINGLETON 01 +#define MENU_OPTS_IMMEDIATE 02 +#define MENU_OPTS_LIST_ONLY 04 + +struct menu_opts { +const char *header; +const char *prompt; +int flags; +}; + +#define MENU_RETURN_NO_LOOP 10 + +struct menu_item { +char hotkey; +const char *title; +int selected; +int (*fn)(); +}; + +enum menu_stuff_type { +MENU_STUFF_TYPE_STRING_LIST =1 , +MENU_STUFF_TYPE_MENU_ITEM +}; + +struct menu_stuff { +enum menu_stuff_type type; +int nr; +void *stuff; +}; +static int parse_clean_color_slot (const char *var) {if (!strcasecmp (var,"reset" ))
@@ -240,54 +270,422 @@ static void pretty_print_dels(void) copts.indent =" " ; copts.padding =2 ;print_columns (&list, colopts, &copts); -putchar ('\n' );strbuf_release (&buf);string_list_clear (&list,0 ); } -static void interactive_main_loop (void ) +static void pretty_print_menus (struct string_list *menu_list) +{ +unsigned int local_colopts =0 ; +struct column_options copts; + + local_colopts =COL_ENABLED |COL_ROW ; +memset (&copts,0 ,sizeof (copts)); + copts.indent =" " ; + copts.padding =2 ; +print_columns (menu_list, local_colopts, &copts); +} + +static void prompt_help_cmd (int singleton) +{ +clean_print_color (CLEAN_COLOR_HELP ); +printf_ln (singleton ? +_ ("Prompt help:\n" +"1 - select a numbered item\n" +"foo - select item based on unique prefix\n" +" - (empty) select nothing" ) : +_ ("Prompt help:\n" +"1 - select a single item\n" +"3-5 - select a range of items\n" +"2-3,6-9 - select multiple ranges\n" +"foo - select item based on unique prefix\n" +"-... - unselect specified items\n" +"* - choose all items\n" +" - (empty) finish selecting" )); +clean_print_color (CLEAN_COLOR_RESET ); +} + +/* +* display menu stuff with number prefix and hotkey highlight +*/ +static void print_highlight_menu_stuff (struct menu_stuff *stuff,int **chosen) +{ +struct string_list menu_list =STRING_LIST_INIT_DUP ; +struct strbuf menu =STRBUF_INIT ; +struct strbuf buf =STRBUF_INIT ; +struct menu_item *menu_item; +struct string_list_item *string_list_item; +int i; + +switch (stuff->type) { +default : +die ("Bad type of menu_staff when print menu" ); +case MENU_STUFF_TYPE_MENU_ITEM : + menu_item = (struct menu_item *)stuff->stuff; +for (i =0 ; i < stuff->nr; i++, menu_item++) { +const char *p; +int highlighted =0 ; + + p = menu_item->title; +if ((*chosen)[i] <0 ) + (*chosen)[i] = menu_item->selected ?1 :0 ; +strbuf_addf (&menu,"%s%2d: " , (*chosen)[i] ?"*" :" " , i+1 ); +for (; *p; p++) { +if (!highlighted && *p == menu_item->hotkey) { +strbuf_addstr (&menu,clean_get_color (CLEAN_COLOR_PROMPT )); +strbuf_addch (&menu, *p); +strbuf_addstr (&menu,clean_get_color (CLEAN_COLOR_RESET )); + highlighted =1 ; + }else { +strbuf_addch (&menu, *p); + } + } +string_list_append (&menu_list, menu.buf); +strbuf_reset (&menu); + } +break ; +case MENU_STUFF_TYPE_STRING_LIST : + i =0 ; +for_each_string_list_item (string_list_item, (struct string_list *)stuff->stuff) { +if ((*chosen)[i] <0 ) + (*chosen)[i] =0 ; +strbuf_addf (&menu,"%s%2d: %s" , + (*chosen)[i] ?"*" :" " , i+1 , string_list_item->string); +string_list_append (&menu_list, menu.buf); +strbuf_reset (&menu); + i++; + } +break ; + } + +pretty_print_menus (&menu_list); + +strbuf_release (&menu); +strbuf_release (&buf); +string_list_clear (&menu_list,0 ); +} + +/* +* Parse user input, and return choice(s) for menu (menu_stuff). +* +* Input +* (for single choice) +* 1 - select a numbered item +* foo - select item based on menu title +* - (empty) select nothing +* +* (for multiple choice) +* 1 - select a single item +* 3-5 - select a range of items +* 2-3,6-9 - select multiple ranges +* foo - select item based on menu title +* -... - unselect specified items +* * - choose all items +* - (empty) finish selecting +* +* The parse result will be saved in array **chosen, and +* return number of total selections. +*/ +static int parse_choice (struct menu_stuff *menu_stuff, +int is_single, +struct strbuf input, +int **chosen) +{ +struct strbuf **choice_list, **ptr; +struct menu_item *menu_item; +struct string_list_item *string_list_item; +int nr =0 ; +int i; + +if (is_single) { + choice_list =strbuf_split_max (&input,'\n' ,0 ); + }else { +char *p = input.buf; +do { +if (*p ==',' ) + *p =' ' ; + }while (*p++); + choice_list =strbuf_split_max (&input,' ' ,0 ); + } + +for (ptr = choice_list; *ptr; ptr++) { +char *p; +int choose =1 ; +int bottom =0 , top =0 ; +int is_range, is_number; + +strbuf_trim (*ptr); +if (!(*ptr)->len) +continue ; + +/* Input that begins with '-'; unchoose */ +if (*(*ptr)->buf =='-' ) { + choose =0 ; +strbuf_remove ((*ptr),0 ,1 ); + } + + is_range =0 ; + is_number =1 ; +for (p = (*ptr)->buf; *p; p++) { +if ('-' == *p) { +if (!is_range) { + is_range =1 ; + is_number =0 ; + }else { + is_number =0 ; + is_range =0 ; +break ; + } + }else if (!isdigit (*p)) { + is_number =0 ; + is_range =0 ; +break ; + } + } + +if (is_number) { + bottom =atoi ((*ptr)->buf); + top = bottom; + }else if (is_range) { + bottom =atoi ((*ptr)->buf); +/* a range can be specified like 5-7 or 5- */ +if (!*(strchr ((*ptr)->buf,'-' ) +1 )) + top = menu_stuff->nr; +else + top =atoi (strchr ((*ptr)->buf,'-' ) +1 ); + }else if (!strcmp ((*ptr)->buf,"*" )) { + bottom =1 ; + top = menu_stuff->nr; + }else { +switch (menu_stuff->type) { +default : +die ("Bad type of menu_stuff when parse choice" ); +case MENU_STUFF_TYPE_MENU_ITEM : + menu_item = (struct menu_item *)menu_stuff->stuff; +for (i =0 ; i < menu_stuff->nr; i++, menu_item++) { +if (((*ptr)->len ==1 && + *(*ptr)->buf == menu_item->hotkey) || + !strcasecmp ((*ptr)->buf, menu_item->title)) { + bottom = i +1 ; + top = bottom; +break ; + } + } +break ; +case MENU_STUFF_TYPE_STRING_LIST : + string_list_item = ((struct string_list *)menu_stuff->stuff)->items; +for (i =0 ; i < menu_stuff->nr; i++, string_list_item++) { +if (!strcasecmp ((*ptr)->buf, string_list_item->string)) { + bottom = i +1 ; + top = bottom; +break ; + } + } +break ; + } + } + +if (top <=0 || bottom <=0 || top > menu_stuff->nr || bottom > top || + (is_single && bottom != top)) { +clean_print_color (CLEAN_COLOR_ERROR ); +printf_ln (_ ("Huh (%s)?" ), (*ptr)->buf); +clean_print_color (CLEAN_COLOR_RESET ); +continue ; + } + +for (i = bottom; i <= top; i++) + (*chosen)[i-1 ] = choose; + } + +strbuf_list_free (choice_list); + +for (i =0 ; i < menu_stuff->nr; i++) + nr += (*chosen)[i]; +return nr; +} + +/* +* Implement a git-add-interactive compatible UI, which is borrowed +* from git-add--interactive.perl. +* +* Return value: +* +* - Return an array of integers +* - , and it is up to you to free the allocated memory. +* - The array ends with EOF. +* - If user pressed CTRL-D (i.e. EOF), no selection returned. +*/ +static int *list_and_choose (struct menu_opts *opts,struct menu_stuff *stuff) +{ +struct strbuf choice =STRBUF_INIT ; +int *chosen, *result; +int nr =0 ; +int eof =0 ; +int i; + + chosen =xmalloc (sizeof (int ) * stuff->nr); +/* set chosen as uninitialized */ +for (i =0 ; i < stuff->nr; i++) + chosen[i] =-1 ; + +for (;;) { +if (opts->header) { +printf_ln ("%s%s%s" , +clean_get_color (CLEAN_COLOR_HEADER ), +_ (opts->header), +clean_get_color (CLEAN_COLOR_RESET )); + } + +/* chosen will be initialized by print_highlight_menu_stuff */ +print_highlight_menu_stuff (stuff, &chosen); + +if (opts->flags &MENU_OPTS_LIST_ONLY ) +break ; + +if (opts->prompt) { +printf ("%s%s%s%s" , +clean_get_color (CLEAN_COLOR_PROMPT ), +_ (opts->prompt), + opts->flags &MENU_OPTS_SINGLETON ?"> " :">> " , +clean_get_color (CLEAN_COLOR_RESET )); + } + +if (strbuf_getline (&choice, stdin,'\n' ) !=EOF ) { +strbuf_trim (&choice); + }else { + eof =1 ; +break ; + } + +/* help for prompt */ +if (!strcmp (choice.buf,"?" )) { +prompt_help_cmd (opts->flags &MENU_OPTS_SINGLETON ); +continue ; + } + +/* for a multiple-choice menu, press ENTER (empty) will return back */ +if (!(opts->flags &MENU_OPTS_SINGLETON ) && !choice.len) +break ; + + nr =parse_choice (stuff, + opts->flags &MENU_OPTS_SINGLETON , + choice, + &chosen); + +if (opts->flags &MENU_OPTS_SINGLETON ) { +if (nr) +break ; + }else if (opts->flags &MENU_OPTS_IMMEDIATE ) { +break ; + } + } + +if (eof) { + result =xmalloc (sizeof (int )); + *result =EOF ; + }else { +int j =0 ; + +/* +* recalculate nr, if return back from menu directly with +* default selections. +*/ +if (!nr) { +for (i =0 ; i < stuff->nr; i++) + nr += chosen[i]; + } + + result =xmalloc (sizeof (int ) * (nr +1 )); +memset (result,0 ,sizeof (int ) * (nr +1 )); +for (i =0 ; i < stuff->nr && j < nr; i++) { +if (chosen[i]) + result[j++] = i; + } + result[j] =EOF ; + } + +free (chosen); +strbuf_release (&choice); +return result; +} + +static int clean_cmd (void ) { -struct strbuf confirm =STRBUF_INIT ; +return MENU_RETURN_NO_LOOP ; +} + +static int quit_cmd (void ) +{ +string_list_clear (&del_list,0 ); +printf_ln (_ ("Bye." )); +return MENU_RETURN_NO_LOOP ; +} + +static int help_cmd (void ) +{ +clean_print_color (CLEAN_COLOR_HELP ); +printf_ln (_ ( +"clean - start cleaning\n" +"quit - stop cleaning\n" +"help - this screen\n" +"? - help for prompt selection" + )); +clean_print_color (CLEAN_COLOR_RESET ); +return 0 ; +} +static void interactive_main_loop (void ) +{while (del_list.nr) { -putchar ('\n' ); +struct menu_opts menu_opts; +struct menu_stuff menu_stuff; +struct menu_item menus[] = { + {'c' ,"clean" ,0 , clean_cmd}, + {'q' ,"quit" ,0 , quit_cmd}, + {'h' ,"help" ,0 , help_cmd}, + }; +int *chosen; + + menu_opts.header =N_ ("*** Commands ***" ); + menu_opts.prompt =N_ ("What now" ); + menu_opts.flags =MENU_OPTS_SINGLETON ; + + menu_stuff.type =MENU_STUFF_TYPE_MENU_ITEM ; + menu_stuff.stuff = menus; + menu_stuff.nr =sizeof (menus) /sizeof (struct menu_item ); +clean_print_color (CLEAN_COLOR_HEADER );printf_ln (Q_ ("Would remove the following item:" ,"Would remove the following items:" , del_list.nr));clean_print_color (CLEAN_COLOR_RESET ); -putchar ('\n' );pretty_print_dels (); -clean_print_color (CLEAN_COLOR_PROMPT ); -printf (_ ("Remove [y/n]? " )); -clean_print_color (CLEAN_COLOR_RESET ); -if (strbuf_getline (&confirm, stdin,'\n' ) !=EOF ) { -strbuf_trim (&confirm); - }else { -/* Ctrl-D is the same as "quit" */ -string_list_clear (&del_list,0 ); -putchar ('\n' ); -printf_ln ("Bye." ); -break ; - } - -if (confirm.len) { -if (!strncasecmp (confirm.buf,"yes" , confirm.len)) { -break ; - }else if (!strncasecmp (confirm.buf,"no" , confirm.len) || - !strncasecmp (confirm.buf,"quit" , confirm.len)) { -string_list_clear (&del_list,0 ); -printf_ln ("Bye." ); -break ; - }else { + chosen =list_and_choose (&menu_opts, &menu_stuff); + +if (*chosen !=EOF ) { +int ret; + ret = menus[*chosen].fn (); +if (ret !=MENU_RETURN_NO_LOOP ) { +free (chosen); + chosen =NULL ; +if (!del_list.nr) { +clean_print_color (CLEAN_COLOR_ERROR ); +printf_ln (_ ("No more files to clean, exiting." )); +clean_print_color (CLEAN_COLOR_RESET ); +break ; + }continue ; } + }else { +quit_cmd (); } - } -strbuf_release (&confirm); +free (chosen); + chosen =NULL ; +break ; + } }int cmd_clean (int argc,const char **argv,const char *prefix)
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 11/16 git-clean: add filter by pattern interactive action
In reply to Jiang XinAdd a new action for interactive git-clean: filter by pattern. When the user chooses this action, user can input space-separated patterns (the same syntax as gitignore), and each clean candidate that matches with one of the patterns will be excluded from cleaning. When the user feels it's OK, presses ENTER and backs to the confirmation dialog.
--- builtin/clean.c | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+)
builtin/clean.c +68 -0
@@ -614,6 +614,72 @@ static int clean_cmd(void)return MENU_RETURN_NO_LOOP ; } +static int filter_by_patterns_cmd (void ) +{ +struct dir_struct dir; +struct strbuf confirm =STRBUF_INIT ; +struct strbuf **ignore_list; +struct string_list_item *item; +struct exclude_list *el; +int changed =-1 , i; + +for (;;) { +if (!del_list.nr) +break ; + +if (changed) +pretty_print_dels (); + +clean_print_color (CLEAN_COLOR_PROMPT ); +printf (_ ("Input ignore patterns>> " )); +clean_print_color (CLEAN_COLOR_RESET ); +if (strbuf_getline (&confirm, stdin,'\n' ) !=EOF ) +strbuf_trim (&confirm); +else +putchar ('\n' ); + +/* quit filter_by_pattern mode if press ENTER or Ctrl-D */ +if (!confirm.len) +break ; + +memset (&dir,0 ,sizeof (dir)); + el =add_exclude_list (&dir,EXC_CMDL ,"manual exclude" ); + ignore_list =strbuf_split_max (&confirm,' ' ,0 ); + +for (i =0 ; ignore_list[i]; i++) { +strbuf_trim (ignore_list[i]); +if (!ignore_list[i]->len) +continue ; + +add_exclude (ignore_list[i]->buf,"" ,0 , el, -(i+1 )); + } + + changed =0 ; +for_each_string_list_item (item, &del_list) { +int dtype =DT_UNKNOWN ; + +if (is_excluded (&dir, item->string, &dtype)) { + *item->string ='\0' ; + changed++; + } + } + +if (changed) { +string_list_remove_empty_items (&del_list,0 ); + }else { +clean_print_color (CLEAN_COLOR_ERROR ); +printf_ln (_ ("WARNING: Cannot find items matched by: %s" ), confirm.buf); +clean_print_color (CLEAN_COLOR_RESET ); + } + +strbuf_list_free (ignore_list); +clear_directory (&dir); + } + +strbuf_release (&confirm); +return 0 ; +} +static int quit_cmd (void ) {string_list_clear (&del_list,0 );
@@ -626,6 +692,7 @@ static int help_cmd(void)clean_print_color (CLEAN_COLOR_HELP ); printf_ln(_( "clean - start cleaning\n" + "filter by pattern - exclude items from deletion\n" "quit - stop cleaning\n" "help - this screen\n" "? - help for prompt selection"
@@ -641,6 +708,7 @@ static void interactive_main_loop(void)struct menu_stuff menu_stuff;struct menu_item menus[] = { {'c' ,"clean" ,0 , clean_cmd}, + {'f' ,"filter by pattern" ,0 , filter_by_patterns_cmd}, {'q' ,"quit" ,0 , quit_cmd}, {'h' ,"help" ,0 , help_cmd}, };
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 12/16 git-clean: add select by numbers interactive action
In reply to Jiang XinDraw a multiple choice menu using list_and_choose to select items to be deleted by numbers.
User can input:
* 1,5-7 : select 1,5,6,7 items to be deleted * * : select all items to be deleted * -* : unselect all, nothing will be deleted
* : (empty) finish selecting, and return back to main menu
--- builtin/clean.c | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+)
builtin/clean.c +39 -0
@@ -680,6 +680,43 @@ static int filter_by_patterns_cmd(void)return 0 ; } +static int select_by_numbers_cmd (void ) +{ +struct menu_opts menu_opts; +struct menu_stuff menu_stuff; +struct string_list_item *items; +int *chosen; +int i, j; + + menu_opts.header =NULL ; + menu_opts.prompt =N_ ("Select items to delete" ); + menu_opts.flags =0 ; + + menu_stuff.type =MENU_STUFF_TYPE_STRING_LIST ; + menu_stuff.stuff = &del_list; + menu_stuff.nr = del_list.nr; + + chosen =list_and_choose (&menu_opts, &menu_stuff); + items = del_list.items; +for (i =0 , j =0 ; i < del_list.nr; i++) { +if (i < chosen[j]) { + *(items[i].string) ='\0' ; + }else if (i == chosen[j]) { +/* delete selected item */ + j++; +continue ; + }else { +/* end of chosen (chosen[j] == EOF), won't delete */ + *(items[i].string) ='\0' ; + } + } + +string_list_remove_empty_items (&del_list,0 ); + +free (chosen); +return 0 ; +} +static int quit_cmd (void ) {string_list_clear (&del_list,0 );
@@ -693,6 +730,7 @@ static int help_cmd(void) printf_ln(_( "clean - start cleaning\n" "filter by pattern - exclude items from deletion\n" + "select by numbers - select items to be deleted by numbers\n" "quit - stop cleaning\n" "help - this screen\n" "? - help for prompt selection"
@@ -709,6 +747,7 @@ static void interactive_main_loop(void)struct menu_item menus[] = { {'c' ,"clean" ,0 , clean_cmd}, {'f' ,"filter by pattern" ,0 , filter_by_patterns_cmd}, + {'s' ,"select by numbers" ,0 , select_by_numbers_cmd}, {'q' ,"quit" ,0 , quit_cmd}, {'h' ,"help" ,0 , help_cmd}, };
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 13/16 git-clean: add ask each interactive action
In reply to Jiang XinAdd a new action for interactive git-clean: ask each. It's just like the "rm -i" command, that the user must confirm one by one for each file or directory to be cleaned.
--- builtin/clean.c | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+)
builtin/clean.c +36 -0
@@ -717,6 +717,40 @@ static int select_by_numbers_cmd(void)return 0 ; } +static int ask_each_cmd (void ) +{ +struct strbuf confirm =STRBUF_INIT ; +struct strbuf buf =STRBUF_INIT ; +struct string_list_item *item; +const char *qname; +int changed =0 , eof =0 ; + +for_each_string_list_item (item, &del_list) { +/* Ctrl-D should stop removing files */ +if (!eof) { + qname =quote_path_relative (item->string,NULL , &buf); +printf (_ ("remove %s? " ), qname); +if (strbuf_getline (&confirm, stdin,'\n' ) !=EOF ) { +strbuf_trim (&confirm); + }else { +putchar ('\n' ); + eof =1 ; + } + } +if (!confirm.len ||strncasecmp (confirm.buf,"yes" , confirm.len)) { + *item->string ='\0' ; + changed++; + } + } + +if (changed) +string_list_remove_empty_items (&del_list,0 ); + +strbuf_release (&buf); +strbuf_release (&confirm); +return MENU_RETURN_NO_LOOP ; +} +static int quit_cmd (void ) {string_list_clear (&del_list,0 );
@@ -731,6 +765,7 @@ static int help_cmd(void)"clean - start cleaning\n" "filter by pattern - exclude items from deletion\n" "select by numbers - select items to be deleted by numbers\n" +"ask each - confirm each deletion (like \"rm -i\")\n" "quit - stop cleaning\n" "help - this screen\n" "? - help for prompt selection"
@@ -748,6 +783,7 @@ static void interactive_main_loop(void) {'c', "clean", 0, clean_cmd}, {'f', "filter by pattern", 0, filter_by_patterns_cmd}, {'s', "select by numbers", 0, select_by_numbers_cmd}, + {'a', "ask each", 0, ask_each_cmd}, {'q', "quit", 0, quit_cmd}, {'h', "help", 0, help_cmd}, };
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 14/16 git-clean: add documentation for interactive git-clean
In reply to Jiang XinAdd new section "Interactive mode" for documentation of interactive git-clean.
--- Documentation/git-clean.txt | 65 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 63 insertions(+), 2 deletions(-)
Documentation/git-clean.txt +63 -2
@@ -39,8 +39,8 @@ OPTIONS -i:: --interactive:: - Show what would be done and the user must confirm before actually - cleaning. + Show what would be done and clean files interactively. See + ``Interactive mode'' for details. -n:: --dry-run::
@@ -69,6 +69,67 @@ OPTIONS Remove only files ignored by Git. This may be useful to rebuild everything from scratch, but keep manually created files. +Interactive mode +---------------- +When the command enters the interactive mode, it shows the +files and directories to be cleaned, and goes into its +interactive command loop. + +The command loop shows the list of subcommands available, and +gives a prompt "What now> ". In general, when the prompt ends +with a single '>', you can pick only one of the choices given +and type return, like this: + +------------ + *** Commands *** + 1: clean 2: filter by pattern 3: select by numbers + 4: ask each 5: quit 6: help + What now> 1 +------------ + +You also could say `c` or `clean` above as long as the choice is unique. + +The main command loop has 6 subcommands. + +clean:: + + Start cleaning files and directories, and then quit. + +filter by pattern:: + + This shows the files and directories to be deleted and issues an + "Input ignore patterns>>" prompt. You can input space-seperated + patterns to exclude files and directories from deletion. + E.g. "*.c *.h" will excludes files end with ".c" and ".h" from + deletion. When you are satisfied with the filtered result, press + ENTER (empty) back to the main menu. + +select by numbers:: + + This shows the files and directories to be deleted and issues an + "Select items to delete>>" prompt. When the prompt ends with double + '>>' like this, you can make more than one selection, concatenated + with whitespace or comma. Also you can say ranges. E.g. "2-5 7,9" + to choose 2,3,4,5,7,9 from the list. If the second number in a + range is omitted, all remaining patches are taken. E.g. "7-" to + choose 7,8,9 from the list. You can say '*' to choose everything. + Also when you are satisfied with the filtered result, press ENTER + (empty) back to the main menu. + +ask each:: + + This will start to clean, and you must confirm one by one in order + to delete items. Please note that this action is not as efficient + as the above two actions. + +quit:: + + This lets you quit without do cleaning. + +help:: + + Show brief usage of interactive git-clean. + SEE ALSO -------- linkgit:gitignore[5]
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 15/16 test: add t7301 for git-clean--interactive
In reply to Jiang XinAdd test cases for git-clean--interactive.
--- t/t7301-clean-interactive.sh | 439 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 439 insertions(+) create mode 100755 t/t7301-clean-interactive.sh
t/t7301-clean-interactive.sh new file +439 -0
@@ -0,0 +1,439 @@ +#!/bin/sh + +test_description='git clean -i basic tests' + +. ./test-lib.sh + +test_expect_success 'setup' ' + + mkdir -p src && + touch src/part1.c Makefile && + echo build >.gitignore && + echo \*.o >>.gitignore && + git add . && + git commit -m setup && + touch src/part2.c README && + git add . + +' + +test_expect_success 'git clean -i (clean)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + echo c | git clean -i && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test ! -f a.out && + test -f docs/manual.txt && + test ! -f src/part3.c && + test ! -f src/part3.h && + test ! -f src/part4.c && + test ! -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -i (quit)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + echo q | git clean -i && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test -f a.out && + test -f docs/manual.txt && + test -f src/part3.c && + test -f src/part3.h && + test -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -i (Ctrl+D)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + echo "\04" | git clean -i && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test -f a.out && + test -f docs/manual.txt && + test -f src/part3.c && + test -f src/part3.h && + test -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (filter all)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo f; echo "*"; echo; echo c) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test -f a.out && + test -f docs/manual.txt && + test -f src/part3.c && + test -f src/part3.h && + test -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (filter patterns)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo f; echo "part3.* *.out"; echo; echo c) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test -f a.out && + test ! -f docs/manual.txt && + test -f src/part3.c && + test -f src/part3.h && + test ! -f src/part4.c && + test ! -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (filter patterns 2)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo f; echo "* !*.out"; echo; echo c) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test ! -f a.out && + test -f docs/manual.txt && + test -f src/part3.c && + test -f src/part3.h && + test -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (select - all)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo s; echo "*"; echo; echo c) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test ! -f a.out && + test ! -f docs/manual.txt && + test ! -f src/part3.c && + test ! -f src/part3.h && + test ! -f src/part4.c && + test ! -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (select - none)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo s; echo; echo c) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test -f a.out && + test -f docs/manual.txt && + test -f src/part3.c && + test -f src/part3.h && + test -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (select - number)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo s; echo 3; echo; echo c) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test -f a.out && + test -f docs/manual.txt && + test ! -f src/part3.c && + test -f src/part3.h && + test -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (select - number 2)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo s; echo 2 3; echo 5; echo; echo c) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test -f a.out && + test ! -f docs/manual.txt && + test ! -f src/part3.c && + test -f src/part3.h && + test ! -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (select - number 3)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo s; echo 3,4 5; echo; echo c) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test -f a.out && + test -f docs/manual.txt && + test ! -f src/part3.c && + test ! -f src/part3.h && + test ! -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (select - range)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo s; echo 1,3-4; echo 2; echo; echo c) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test ! -f a.out && + test ! -f src/part3.c && + test ! -f src/part3.h && + test -f src/part4.c && + test -f src/part4.h && + test ! -f docs/manual.txt && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (select - range 2)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo s; echo 4- 1; echo; echo c) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test ! -f a.out && + test -f docs/manual.txt && + test -f src/part3.c && + test ! -f src/part3.h && + test ! -f src/part4.c && + test ! -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (inverse select)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo s; echo "*"; echo -5- 1 -2; echo; echo c) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test ! -f a.out && + test -f docs/manual.txt && + test ! -f src/part3.c && + test ! -f src/part3.h && + test -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (ask)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo a; echo Y; echo y; echo no; echo yes; echo bad; echo) | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test ! -f a.out && + test ! -f docs/manual.txt && + test -f src/part3.c && + test ! -f src/part3.h && + test -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id (ask - Ctrl+D)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (echo a; echo Y; echo no; echo yes; echo "\04") | \ + git clean -id && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test ! -f a.out && + test -f docs/manual.txt && + test ! -f src/part3.c && + test -f src/part3.h && + test -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id with prefix and path (filter)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (cd build/ && \ + (echo f; echo "docs"; echo "*.h"; echo ; echo c) | \ + git clean -id ..) && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test ! -f a.out && + test -f docs/manual.txt && + test ! -f src/part3.c && + test -f src/part3.h && + test ! -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id with prefix and path (select by name)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (cd build/ && \ + (echo s; echo "../docs/"; echo "../src/part3.c"; \ + echo "../src/part4.c"; echo; echo c) | \ + git clean -id ..) && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test -f a.out && + test ! -f docs/manual.txt && + test ! -f src/part3.c && + test -f src/part3.h && + test ! -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_expect_success 'git clean -id with prefix and path (ask)' ' + + mkdir -p build docs && + touch a.out src/part3.c src/part3.h src/part4.c src/part4.h \ + docs/manual.txt obj.o build/lib.so && + (cd build/ && \ + (echo a; echo Y; echo y; echo no; echo yes; echo bad; echo) | \ + git clean -id ..) && + test -f Makefile && + test -f README && + test -f src/part1.c && + test -f src/part2.c && + test ! -f a.out && + test ! -f docs/manual.txt && + test -f src/part3.c && + test ! -f src/part3.h && + test -f src/part4.c && + test -f src/part4.h && + test -f obj.o && + test -f build/lib.so + +' + +test_done
Signature · 1 line
1.8.3.1.756.g2e9b71f
PATCH v15 16/16 test: run testcases with POSIX absolute paths on Windows
In reply to Jiang XinSome test cases are skipped on Windows by marking with POSIX prereq. This is because arguments look like absolute paths (such as /a/b) for regular Windows programs (*.exe executables, no bash scripts) are changed to Windows paths (like C:/msysgit/a/b).
There is no cygpath nor equivalent on msysGit, but it is easy to write one. New subcommand "mingw_path" is added in test-path-utils, so that we can get the expected absolute paths on Windows. E.g.
COMMAND LINE Linux output Windows output
================================== ============ ===============
test-path-utils mingw_path / / C:/msysgit
test-path-utils mingw_path /a/b/ /a/b/ C:/msysgit/a/b/With this utility, most skipped test cases in t0060 can be turned on to be tested correctly on Windows.
--- t/t0060-path-utils.sh | 44 +++++++++++++++++++++++--------------------- test-path-utils.c | 5 +++++ 2 files changed, 28 insertions(+), 21 deletions(-)
t/t0060-path-utils.sh +23 -21
@@ -8,13 +8,15 @@ test_description='Test various path utilities' . ./test-lib.sh norm_path() { + expected=$(test-path-utils mingw_path "$2") test_expect_success $3 "normalize path: $1 => $2" \ - "test \"\$(test-path-utils normalize_path_copy '$1')\" = '$2'" + "test \"\$(test-path-utils normalize_path_copy '$1')\" = '$expected'" } relative_path() { + expected=$(test-path-utils mingw_path "$3") test_expect_success $4 "relative path: $1 $2 => $3" \ - "test \"\$(test-path-utils relative_path '$1' '$2')\" = '$3'" + "test \"\$(test-path-utils relative_path '$1' '$2')\" = '$expected'" } # On Windows, we are using MSYS's bash, which mangles the paths.
@@ -39,8 +41,8 @@ ancestor() { test \"\$actual\" = '$expected'" } -# Absolute path tests must be skipped on Windows because due to path mangling -# the test program never sees a POSIX-style absolute path +# Some absolute path tests should be skipped on Windows due to path mangling +# on POSIX-style absolute paths case $(uname -s) in *MINGW*) ;;
@@ -73,30 +75,30 @@ norm_path d1/s1//../s2/../../d2 d2 norm_path d1/.../d2 d1/.../d2 norm_path d1/..././../d2 d1/d2 -norm_path / / POSIX +norm_path / / norm_path // / POSIX norm_path /// / POSIX -norm_path /. / POSIX +norm_path /. / norm_path /./ / POSIX norm_path /./.. ++failed++ POSIX -norm_path /../. ++failed++ POSIX +norm_path /../. ++failed++ norm_path /./../.// ++failed++ POSIX norm_path /dir/.. / POSIX norm_path /dir/sub/../.. / POSIX norm_path /dir/sub/../../.. ++failed++ POSIX -norm_path /dir /dir POSIX -norm_path /dir// /dir/ POSIX -norm_path /./dir /dir POSIX -norm_path /dir/. /dir/ POSIX -norm_path /dir///./ /dir/ POSIX -norm_path /dir//sub/.. /dir/ POSIX -norm_path /dir/sub/../ /dir/ POSIX +norm_path /dir /dir +norm_path /dir// /dir/ +norm_path /./dir /dir +norm_path /dir/. /dir/ +norm_path /dir///./ /dir/ +norm_path /dir//sub/.. /dir/ +norm_path /dir/sub/../ /dir/ norm_path //dir/sub/../. /dir/ POSIX -norm_path /dir/s1/../s2/ /dir/s2/ POSIX -norm_path /d1/s1///s2/..//../s3/ /d1/s3/ POSIX -norm_path /d1/s1//../s2/../../d2 /d2 POSIX -norm_path /d1/.../d2 /d1/.../d2 POSIX -norm_path /d1/..././../d2 /d1/d2 POSIX +norm_path /dir/s1/../s2/ /dir/s2/ +norm_path /d1/s1///s2/..//../s3/ /d1/s3/ +norm_path /d1/s1//../s2/../../d2 /d2 +norm_path /d1/.../d2 /d1/.../d2 +norm_path /d1/..././../d2 /d1/d2 ancestor / / -1 ancestor /foo / 0
@@ -198,8 +200,8 @@ relative_path / /a/b/ ../../ relative_path /a/c /a/b/ ../c relative_path /a/c /a/b ../c relative_path /x/y /a/b/ ../../x/y -relative_path /a/b "<empty>" /a/b POSIX -relative_path /a/b "<null>" /a/b POSIX +relative_path /a/b "<empty>" /a/b +relative_path /a/b "<null>" /a/b relative_path a/b/c/ a/b/ c/ relative_path a/b/c/ a/b c/ relative_path a/b//c a//b c
test-path-utils.c +5 -0
@@ -116,6 +116,11 @@ int main(int argc, char **argv)return 0 ; } +if (argc ==3 && !strcmp (argv[1 ],"mingw_path" )) { +puts (argv[2 ]); +return 0 ; + } +if (argc ==4 && !strcmp (argv[1 ],"relative_path" )) {struct strbuf sb =STRBUF_INIT ;const char *in, *prefix, *rel;
Signature · 1 line
1.8.3.1.756.g2e9b71f
People may have comments and improvements on the actual "interactive" UI part, but I think the earlier parts up to "into two phases" is ready for 'next'. Let's queue them and have them advance.
Thanks.