Re: [PATCH 05/16] test-lib-functions: document test_commit --no-tag

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, Apr 12, 2021 at 7:09 AM Ævar Arnfjörð Bjarmason
<avarab@xxxxxxxxx> wrote:
> In 76b8b8d05c (test-lib functions: document arguments to test_commit,
> 2021-01-12) I added missing documentation to test_commit, but in less
> than a month later in 3803a3a099 (t: add --no-tag option to
> test_commit, 2021-02-09) we got another undocumented option. Let's fix
> that.
>
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@xxxxxxxxx>
> ---
> diff --git a/t/test-lib-functions.sh b/t/test-lib-functions.sh
> @@ -177,6 +177,9 @@ debug () {
> +#   --no-tag
> +#      Do not tag the resulting commit, if supplied giving the
> +#      optional "<tag>" argument is an error.

This is difficult to understand for a native English speaker/reader
due to the comma-splice[1]. A period or semicolon in place of the
comma would fix it.

[1]: https://lore.kernel.org/git/CAPx1GvfFPWvJsj+uJV7RZrv1rgEpio=pk6rKF2UrjHebVY=LPA@xxxxxxxxxxxxxx/



[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux