From: Junio C Hamano <gitster@pobox•com>
To: Michael Haggerty <mhagger@alum•mit.edu>
Cc: Brad King <brad.king@kitware•com>,
Johan Herland <johan@herland•net>, Jeff King <peff@peff•net>,
Vicent Marti <tanoku@gmail•com>,
git@vger•kernel.org
Subject: Re: [PATCH v2 15/27] update-ref --stdin -z: Deprecate interpreting the empty string as zeros
Date: Mon, 31 Mar 2014 14:49:42 -0700 [thread overview]
Message-ID: <xmqq7g7a3uo9.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <1395683820-17304-16-git-send-email-mhagger@alum.mit.edu> (Michael Haggerty's message of "Mon, 24 Mar 2014 18:56:48 +0100")
Michael Haggerty <mhagger@alum•mit.edu> writes:
> In the original version of this command, for the single case of the
> "update" command's <newvalue>, the empty string was interpreted as
> being equivalent to 40 "0"s. This shorthand is unnecessary (binary
> input will usually be generated programmatically anyway), and it
> complicates the parser and the documentation.
Nice.
>
> So gently deprecate this usage: remove its description from the
> documentation and emit a warning if it is found. But for reasons of
> backwards compatibility, continue to accept it.
>
> Helped-by: Brad King <brad.king@kitware•com>
> Signed-off-by: Michael Haggerty <mhagger@alum•mit.edu>
> ---
> Documentation/git-update-ref.txt | 18 ++++++++++++------
> builtin/update-ref.c | 2 ++
> t/t1400-update-ref.sh | 5 +++--
> 3 files changed, 17 insertions(+), 8 deletions(-)
>
> diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
> index 0a0a551..c8f5ae5 100644
> --- a/Documentation/git-update-ref.txt
> +++ b/Documentation/git-update-ref.txt
> @@ -68,7 +68,12 @@ performs all modifications together. Specify commands of the form:
> option SP <opt> LF
>
> Quote fields containing whitespace as if they were strings in C source
> -code. Alternatively, use `-z` to specify commands without quoting:
> +code; i.e., surrounded by double-quotes and with backslash escapes.
> +Use 40 "0" characters or the empty string to specify a zero value. To
> +specify a missing value, omit the value and its preceding SP entirely.
> +
> +Alternatively, use `-z` to specify in NUL-terminated format, without
> +quoting:
>
> update SP <ref> NUL <newvalue> NUL [<oldvalue>] NUL
> create SP <ref> NUL <newvalue> NUL
> @@ -76,8 +81,12 @@ code. Alternatively, use `-z` to specify commands without quoting:
> verify SP <ref> NUL [<oldvalue>] NUL
> option SP <opt> NUL
>
> -Lines of any other format or a repeated <ref> produce an error.
> -Command meanings are:
> +In this format, use 40 "0" to specify a zero value, and use the empty
> +string to specify a missing value.
> +
> +In either format, values can be specified in any form that Git
> +recognizes as an object name. Commands in any other format or a
> +repeated <ref> produce an error. Command meanings are:
>
> update::
> Set <ref> to <newvalue> after verifying <oldvalue>, if given.
> @@ -102,9 +111,6 @@ option::
> The only valid option is `no-deref` to avoid dereferencing
> a symbolic ref.
>
> -Use 40 "0" or the empty string to specify a zero value, except that
> -with `-z` an empty <oldvalue> is considered missing.
> -
> If all <ref>s can be locked with matching <oldvalue>s
> simultaneously, all modifications are performed. Otherwise, no
> modifications are performed. Note that while each individual
> diff --git a/builtin/update-ref.c b/builtin/update-ref.c
> index 6462b2f..eef7537 100644
> --- a/builtin/update-ref.c
> +++ b/builtin/update-ref.c
> @@ -154,6 +154,8 @@ static int parse_next_sha1(struct strbuf *input, const char **next,
> goto invalid;
> } else if (flags & PARSE_SHA1_ALLOW_EMPTY) {
> /* With -z, treat an empty value as all zeros: */
> + warning("%s %s: missing <newvalue>, treating as zero",
> + command, refname);
> hashclr(sha1);
> } else {
> /*
> diff --git a/t/t1400-update-ref.sh b/t/t1400-update-ref.sh
> index 15f5bfd..2d61cce 100755
> --- a/t/t1400-update-ref.sh
> +++ b/t/t1400-update-ref.sh
> @@ -730,10 +730,11 @@ test_expect_success 'stdin -z fails update with bad ref name' '
> grep "fatal: invalid ref format: ~a" err
> '
>
> -test_expect_success 'stdin -z treats empty new value as zeros' '
> +test_expect_success 'stdin -z emits warning with empty new value' '
> git update-ref $a $m &&
> printf $F "update $a" "" "" >stdin &&
> - git update-ref -z --stdin <stdin &&
> + git update-ref -z --stdin <stdin 2>err &&
> + grep "warning: update $a: missing <newvalue>, treating as zero" err &&
> test_must_fail git rev-parse --verify -q $a
> '
next prev parent reply other threads:[~2014-03-31 21:49 UTC|newest]
Thread overview: 65+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-03-24 17:56 [PATCH v2 00/27] Clean up update-refs --stdin and implement ref_transaction Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 01/27] t1400: Fix name and expected result of one test Michael Haggerty
2014-03-31 21:30 ` Junio C Hamano
2014-03-31 21:49 ` Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 02/27] t1400: Provide more usual input to the command Michael Haggerty
2014-03-31 21:28 ` Junio C Hamano
2014-03-24 17:56 ` [PATCH v2 03/27] parse_arg(): Really test that argument is properly terminated Michael Haggerty
2014-03-31 21:36 ` Junio C Hamano
2014-03-31 22:11 ` Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 04/27] t1400: Add some more tests involving quoted arguments Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 05/27] refs.h: Rename the action_on_err constants Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 06/27] update_refs(): Fix constness Michael Haggerty
2014-03-31 21:40 ` Junio C Hamano
2014-03-31 22:16 ` Michael Haggerty
2014-03-31 22:38 ` Junio C Hamano
2014-03-24 17:56 ` [PATCH v2 07/27] update-ref --stdin: Read the whole input at once Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 08/27] parse_cmd_verify(): Copy old_sha1 instead of evaluating <oldvalue> twice Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 09/27] update-ref.c: Extract a new function, parse_refname() Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 10/27] update-ref --stdin: Improve error messages for invalid values Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 11/27] update-ref --stdin: Make error messages more consistent Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 12/27] update-ref --stdin: Simplify error messages for missing oldvalues Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 13/27] t1400: Test that stdin -z update treats empty <newvalue> as zeros Michael Haggerty
2014-03-31 21:48 ` Junio C Hamano
2014-03-31 22:20 ` Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 14/27] update-ref.c: Extract a new function, parse_next_sha1() Michael Haggerty
2014-03-26 18:39 ` Brad King
2014-03-24 17:56 ` [PATCH v2 15/27] update-ref --stdin -z: Deprecate interpreting the empty string as zeros Michael Haggerty
2014-03-31 21:49 ` Junio C Hamano [this message]
2014-03-24 17:56 ` [PATCH v2 16/27] t1400: Test one mistake at a time Michael Haggerty
2014-03-26 18:39 ` Brad King
2014-03-31 21:50 ` Junio C Hamano
2014-03-31 22:32 ` Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 17/27] update-ref --stdin: Improve the error message for unexpected EOF Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 18/27] update-ref --stdin: Harmonize error messages Michael Haggerty
2014-03-31 21:51 ` Junio C Hamano
2014-03-31 22:37 ` Michael Haggerty
2014-04-01 9:29 ` Michael Haggerty
2014-04-02 16:38 ` Junio C Hamano
2014-03-24 17:56 ` [PATCH v2 19/27] refs: Add a concept of a reference transaction Michael Haggerty
2014-03-26 18:39 ` Brad King
2014-03-26 21:42 ` Michael Haggerty
2014-04-01 19:39 ` Junio C Hamano
2014-04-02 4:57 ` Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 20/27] update-ref --stdin: Reimplement using reference transactions Michael Haggerty
2014-04-01 19:46 ` Junio C Hamano
2014-04-02 5:03 ` Michael Haggerty
2014-04-03 15:57 ` Junio C Hamano
2014-04-04 5:02 ` Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 21/27] refs: Remove API function update_refs() Michael Haggerty
2014-04-01 19:46 ` Junio C Hamano
2014-03-24 17:56 ` [PATCH v2 22/27] struct ref_update: Rename field "ref_name" to "refname" Michael Haggerty
2014-04-01 19:53 ` Junio C Hamano
2014-04-02 5:11 ` Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 23/27] struct ref_update: Store refname as a FLEX_ARRAY Michael Haggerty
2014-04-01 19:54 ` Junio C Hamano
2014-03-24 17:56 ` [PATCH v2 24/27] ref_transaction_commit(): Introduce temporary variables Michael Haggerty
2014-04-01 19:26 ` Junio C Hamano
2014-03-24 17:56 ` [PATCH v2 25/27] struct ref_update: Add a lock member Michael Haggerty
2014-03-24 17:56 ` [PATCH v2 26/27] struct ref_update: Add type field Michael Haggerty
2014-04-01 20:03 ` Junio C Hamano
2014-04-02 10:13 ` Michael Haggerty
2014-04-02 17:44 ` Junio C Hamano
2014-03-24 17:57 ` [PATCH v2 27/27] ref_transaction_commit(): Work with transaction->updates in place Michael Haggerty
2014-03-26 18:39 ` [PATCH v2 00/27] Clean up update-refs --stdin and implement ref_transaction Brad King
2014-03-26 21:47 ` Michael Haggerty
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq7g7a3uo9.fsf@gitster.dls.corp.google.com \
--to=gitster@pobox$(echo .)com \
--cc=brad.king@kitware$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=johan@herland$(echo .)net \
--cc=mhagger@alum$(echo .)mit.edu \
--cc=peff@peff$(echo .)net \
--cc=tanoku@gmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox