Subject: Re: [PATCH 3/3] notes remove: --stdin reads from the standard input

From: Michael J Gruber <[email-masked]>
Date: Thu, 19 May 2011 08:50:00 +0200

Junio C Hamano venit, vidit, dixit 19.05.2011 02:14:
> Teach the command to read object names to remove from the standard
> input, in addition to the object names given from the command line.
> 
> Signed-off-by: Junio C Hamano <[email-masked]>
> ---
> 
>  * The logical conclusion of the series.

So that makes 4/3 to be... ;)

I'm torn between asking for a rev-list interface and being happy with
--stdin. I guess we have other places where we allow lists of objects in
argv and stdin (instead of rev-list), and since this targets all kinds
of objects, it's more natural as is (than with with the rev-list interface).

> ---
>  Documentation/git-notes.txt |    7 ++++++-
>  builtin/notes.c             |   14 +++++++++++++-
>  t/t3301-notes.sh            |   33 +++++++++++++++++++++++++++++++++
>  3 files changed, 52 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
> index 6b92060..42e4823 100644
> --- a/Documentation/git-notes.txt
> +++ b/Documentation/git-notes.txt
> @@ -17,7 +17,7 @@ SYNOPSIS
>  'git notes' merge [-v | -q] [-s <strategy> ] <notes_ref>
>  'git notes' merge --commit [-v | -q]
>  'git notes' merge --abort [-v | -q]
> -'git notes' remove [--missing-ok] [<object>...]
> +'git notes' remove [--missing-ok] [--stdin] [<object>...]
>  'git notes' prune [-n | -v]
>  'git notes' get-ref
>  
> @@ -159,6 +159,11 @@ OPTIONS
>  	Do not consider it an error to request removing notes from an
>  	object that does not have notes attached to it.
>  
> +--stdin::
> +	Also read the object names to remove notes from from the standard
> +	input (there is no reason you cannot combine this with object
> +	names from the command line).
> +
>  -n::
>  --dry-run::
>  	Do not remove anything; just report the object names whose notes
> diff --git a/builtin/notes.c b/builtin/notes.c
> index ca045f8..23954e0 100644
> --- a/builtin/notes.c
> +++ b/builtin/notes.c
> @@ -972,10 +972,13 @@ static int remove_one_note(struct notes_tree *t, const char *name, unsigned flag
>  static int remove_cmd(int argc, const char **argv, const char *prefix)
>  {
>  	unsigned flag = 0;
> +	int from_stdin = 0;
>  	struct option options[] = {
>  		OPT_BIT(0, "missing-ok", &flag,
>  			"attempt to remove non-existent note is not an error",
>  			MISSING_OK),
> +		OPT_BOOLEAN(0, "stdin", &from_stdin,
> +			    "read object names from the standard input"),
>  		OPT_END()
>  	};
>  	struct notes_tree *t;
> @@ -986,7 +989,7 @@ static int remove_cmd(int argc, const char **argv, const char *prefix)
>  
>  	t = init_notes_check("remove");
>  
> -	if (!argc) {
> +	if (!argc && !from_stdin) {
>  		retval = remove_one_note(t, "HEAD", flag);
>  	} else {
>  		while (*argv) {
> @@ -994,6 +997,15 @@ static int remove_cmd(int argc, const char **argv, const char *prefix)
>  			argv++;
>  		}
>  	}
> +	if (from_stdin) {
> +		struct strbuf sb = STRBUF_INIT;
> +		while (strbuf_getwholeline(&sb, stdin, '\n') != EOF) {
> +			int len = sb.len;
> +			if (len && sb.buf[len - 1] == '\n')
> +				sb.buf[--len] = '\0';
> +			retval |= remove_one_note(t, sb.buf, flag);
> +		}
> +	}
>  	if (!retval)
>  		commit_notes(t, "Notes removed by 'git notes remove'");
>  	free_notes(t);
> diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
> index bdd4036..2c52f21 100755
> --- a/t/t3301-notes.sh
> +++ b/t/t3301-notes.sh
> @@ -473,6 +473,39 @@ test_expect_success 'removing with --missing-ok but bogus ref' '
>  	test "$before" = "$after"
>  '
>  
> +test_expect_success 'remove reads from --stdin' '
> +	before=$(git rev-parse --verify refs/notes/commits) &&
> +	test_when_finished "git update-ref refs/notes/commits $before" &&
> +	git rev-parse HEAD^^ HEAD^^^ >input &&
> +	git notes remove --stdin <input &&
> +	git diff --name-only refs/notes/commits^ refs/notes/commits >actual &&
> +	test 2 = $(wc -l <actual) &&
> +	git ls-tree -r --name-only refs/notes/commits >actual &&
> +	>empty &&
> +	test_cmp empty actual
> +'

Same comment as for 1/3 applies here.

> +
> +test_expect_success 'remove --stdin is also atomic' '
> +	before=$(git rev-parse --verify refs/notes/commits) &&
> +	test_when_finished "git update-ref refs/notes/commits $before" &&
> +	git rev-parse HEAD^^ HEAD^^^ HEAD^ >input &&
> +	test_must_fail git notes remove --stdin <input &&
> +	after=$(git rev-parse --verify refs/notes/commits) &&
> +	test "$before" = "$after"
> +'
> +
> +test_expect_success 'removing with --stdin --missing-ok' '
> +	before=$(git rev-parse --verify refs/notes/commits) &&
> +	test_when_finished "git update-ref refs/notes/commits $before" &&
> +	git rev-parse HEAD^^ HEAD^^^ HEAD^ >input &&
> +	git notes remove --missing-ok --stdin <input &&
> +	git diff --name-only refs/notes/commits^ refs/notes/commits >actual &&
> +	test 2 = $(wc -l <actual) &&
> +	git ls-tree -r --name-only refs/notes/commits >actual &&
> +	>empty &&
> +	test_cmp empty actual
> +'
> +
>  test_expect_success 'list notes with "git notes list"' '
>  	git notes list > output &&
>  	test_cmp expect output