From aaec9bcf6d85a084725e8386bf314a6ef6842468 Mon Sep 17 00:00:00 2001 From: Johan Herland Date: Sat, 13 Feb 2010 22:28:34 +0100 Subject: [PATCH] builtin-notes: Deprecate the -m/-F options for "git notes edit" The semantics for "git notes edit -m/-F" overlap with those for "git notes add -f", and the behaviour (i.e. overwriting existing notes with the given message/file) is more intuitively captured by (and better documented with) "git notes add -f". Suggested-by: Junio C Hamano Signed-off-by: Johan Herland Signed-off-by: Junio C Hamano --- Documentation/git-notes.txt | 2 +- builtin-notes.c | 10 ++++++++-- t/t3304-notes-mixed.sh | 2 +- t/t3305-notes-fanout.sh | 2 +- t/t3306-notes-prune.sh | 6 +++--- 5 files changed, 14 insertions(+), 8 deletions(-) diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index 35dd8fa8a0..53c5d9014d 100644 --- a/Documentation/git-notes.txt +++ b/Documentation/git-notes.txt @@ -11,7 +11,7 @@ SYNOPSIS 'git notes' [list []] 'git notes' add [-f] [-F | -m ] [] 'git notes' append [-F | -m ] [] -'git notes' edit [-F | -m ] [] +'git notes' edit [] 'git notes' show [] 'git notes' remove [] 'git notes' prune diff --git a/builtin-notes.c b/builtin-notes.c index c88df00b3a..572b47746b 100644 --- a/builtin-notes.c +++ b/builtin-notes.c @@ -21,7 +21,7 @@ static const char * const git_notes_usage[] = { "git notes [list []]", "git notes add [-f] [-m | -F ] []", "git notes append [-m | -F ] []", - "git notes edit [-m | -F ] []", + "git notes edit []", "git notes show []", "git notes remove []", "git notes prune", @@ -233,7 +233,7 @@ int cmd_notes(int argc, const char **argv, const char *prefix) const char *msgfile = NULL; struct msg_arg msg = { 0, STRBUF_INIT }; struct option options[] = { - OPT_GROUP("Notes edit options"), + OPT_GROUP("Notes options"), OPT_CALLBACK('m', "message", &msg, "msg", "note contents as a string", parse_msg_arg), OPT_FILENAME('F', "file", &msgfile, "note contents in a file"), @@ -270,6 +270,12 @@ int cmd_notes(int argc, const char **argv, const char *prefix) usage_with_options(git_notes_usage, options); } + if ((msg.given || msgfile) && edit) { + fprintf(stderr, "The -m and -F options has been deprecated for" + " the 'edit' subcommand.\n" + "Please use 'git notes add -f -m/-F' instead.\n"); + } + if (msg.given && msgfile) { error("mixing -m and -F options is not allowed."); usage_with_options(git_notes_usage, options); diff --git a/t/t3304-notes-mixed.sh b/t/t3304-notes-mixed.sh index c975a6d3f7..1709e8c00b 100755 --- a/t/t3304-notes-mixed.sh +++ b/t/t3304-notes-mixed.sh @@ -188,7 +188,7 @@ test_expect_success "verify contents of non-notes" ' test_expect_success "git-notes preserves non-notes" ' test_tick && - git notes edit -m "foo bar" + git notes add -f -m "foo bar" ' test_expect_success "verify contents of non-notes after git-notes" ' diff --git a/t/t3305-notes-fanout.sh b/t/t3305-notes-fanout.sh index c6d263b236..b1ea64b213 100755 --- a/t/t3305-notes-fanout.sh +++ b/t/t3305-notes-fanout.sh @@ -14,7 +14,7 @@ test_expect_success 'creating many notes with git-notes' ' echo "file for commit #$i" > file && git add file && git commit -q -m "commit #$i" && - git notes edit -m "note #$i" || return 1 + git notes add -m "note #$i" || return 1 done ' diff --git a/t/t3306-notes-prune.sh b/t/t3306-notes-prune.sh index b0adc7e5bd..a0ed0353e6 100755 --- a/t/t3306-notes-prune.sh +++ b/t/t3306-notes-prune.sh @@ -10,17 +10,17 @@ test_expect_success 'setup: create a few commits with notes' ' git add file1 && test_tick && git commit -m 1st && - git notes edit -m "Note #1" && + git notes add -m "Note #1" && : > file2 && git add file2 && test_tick && git commit -m 2nd && - git notes edit -m "Note #2" && + git notes add -m "Note #2" && : > file3 && git add file3 && test_tick && git commit -m 3rd && - git notes edit -m "Note #3" + git notes add -m "Note #3" ' cat > expect <