From: Firmin Martin <firminmartin24@gmail.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>, git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
Eric Sunshine <sunshine@sunshineco.com>
Subject: Re: [PATCH v2 1/2] t/README: document test_config
Date: Mon, 17 May 2021 09:44:22 +0200 [thread overview]
Message-ID: <87cztpg5yh.fsf@Inspiron.i-did-not-set--mail-host-address--so-tickle-me> (raw)
In-Reply-To: <5faaa5a6-8ebf-b2ef-805f-551a36ab7e6c@gmail.com>
Hi Bagas,
Bagas Sanjaya <bagasdotme@gmail.com> writes:
> On 15/05/21 22.27, Firmin Martin wrote:
>>
>> + - test_config <config-option> [<value>]
>> +
>> + Set the configuration option <config-option> to <value>, and unset it at the
>> + end of the current test. For a similar purpose, test_config_global for
>> + global configuration is also available. Note, however, that test_config_*
>> + must not be used in a subshell.
>> +
> From the syntax above, when I omit <value>, default value for <config-option>
> will be set, right?
Good remark. I thought the same as you, but no, it will "git config
<config-option>" (query the value of <config-option>) and then "git
config --unset <config-option>" which is dangerous. Doing so is more
likely an error and should be forbidden, as in this case, it is
equivalent to test_unconfig <config-option>. Will reflect this in v3.
> You forgot to mention it.
I'll thus drop square brackets.
>> + Example:
>> +
>> + test_config format.coverLetter auto
>> +
>> + Is a concise way to write:
>> + test_when_finished "git config --unset format.coverLetter" &&
>> + git config format.coverLetter auto
>> +
>>
>
> The description said "set the config, then unset it". But the expanded version
> said "unsetting the config is deferred to the end of test and set the config".
>
> The documentation for test_when_finished said:
>
>> Prepend <script> to a list of commands to run to clean up
>> at the end of the current test. If some clean-up command
>> fails, the test will not pass.
>
> Is my interpretation above correct?
Yes.
> Oh yeah, maybe it's better to say:
> "For example: <blah> have the same effect as <blah>."
I agree, because the two lines have not exactly the same behaviour as
test_config. Will fix wording.
Thanks,
Firmin
next prev parent reply other threads:[~2021-05-17 7:44 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-14 6:55 [PATCH 1/2] t/README: document test_config Firmin Martin
2021-05-14 6:55 ` [PATCH 2/2] t: use test_config whenever possible Firmin Martin
2021-05-15 20:15 ` Felipe Contreras
2021-05-15 20:21 ` Felipe Contreras
2021-05-15 22:00 ` Firmin Martin
2021-05-14 7:02 ` [PATCH 1/2] t/README: document test_config Eric Sunshine
2021-05-15 14:43 ` Firmin Martin
2021-05-15 15:27 ` [PATCH v2 0/2] document test_config & use it whenever possible Firmin Martin
2021-05-15 15:27 ` [PATCH v2 1/2] t/README: document test_config Firmin Martin
2021-05-16 5:03 ` Bagas Sanjaya
2021-05-17 7:44 ` Firmin Martin [this message]
2021-05-15 15:27 ` [PATCH v2 2/2] t: use test_config whenever possible Firmin Martin
2021-05-16 5:02 ` Junio C Hamano
2021-05-17 6:08 ` Firmin Martin
2021-05-17 6:55 ` Junio C Hamano
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=87cztpg5yh.fsf@Inspiron.i-did-not-set--mail-host-address--so-tickle-me \
--to=firminmartin24@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
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;
as well as URLs for NNTP newsgroup(s).