From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS31976 209.132.180.0/23 X-Spam-Status: No, score=-2.8 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,RCVD_IN_DNSWL_HI,RCVD_IN_SORBS_SPAM, RP_MATCHES_RCVD shortcircuit=no autolearn=no autolearn_force=no version=3.4.0 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by dcvr.yhbt.net (Postfix) with ESMTP id 5900E1FC19 for ; Fri, 24 Mar 2017 18:42:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S965599AbdCXSmE (ORCPT ); Fri, 24 Mar 2017 14:42:04 -0400 Received: from mail-wr0-f194.google.com ([209.85.128.194]:35874 "EHLO mail-wr0-f194.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S965229AbdCXSl7 (ORCPT ); Fri, 24 Mar 2017 14:41:59 -0400 Received: by mail-wr0-f194.google.com with SMTP id u1so1658450wra.3 for ; Fri, 24 Mar 2017 11:41:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=xufKJAjxagEZnx1gzhvfc84scPKTWilkQPFYuiMWabg=; b=CL4dA64NN6/lDG0z15QIlStGYP6zL7K8lcDbJmhCOGaTxLVS9rgbmAoXM7zQPfXgqH SBiJDX5BLaYaLNG9Gp+VDNr/xJNYxDRKtJQQr+53LN0Fc6QF6qcfJhOhXnon2x0puF09 gMtJ695fV/wZUg45HRPT4LydVD5IKzFjdEZeibNd41M7XSaYXXvg3pvetlcbQzIXlIj0 isDlLy9WRxVL/crRTSAwQ+HDE0iz4BjpT84ymOJQT0igF75U1z2JMd8P0nWWiFOC9FzA bg/hIqQaKnKS3OJvrwotHONlGybMPPqKCpkSVcWKnLiL+PQPw+6E1vJjeF9akiiDFxRE L2SA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=xufKJAjxagEZnx1gzhvfc84scPKTWilkQPFYuiMWabg=; b=rIIr2NG02prLlLQGBwKCbHrO/vC6iCvkteu1KMdrmP7h1/7POrz5078EYPrDSxNdey ga2NnUegl2r+MzWVDVaProrYzDnLDy82Ob+Us8wWdKhtxOiFpCR+3y4B8Iwh34yJ6I8Y kLZDLgwJSiT5TApQ75K/SYbEXFRCt4+xoB664KXgYqKBFO2OU1sdPCwS1jYWGpW9dN/I 5NYnYQtO3igyOChNydyaZ12cUbYxELvAZZFcjL/OzfoIkvHNHf2UTISLcm8mc6KioN8r SfB31RvVSXWf6fx+3DjcFOkSU7Z/QAXvPnOBMe/4s+4qaM3L0OdivzZ8HLzpNzgbVD1F PD9g== X-Gm-Message-State: AFeK/H2+Pj6LJ6f8zuMrBdzysQ18D5+WpGlMSVTg0jKiEYBombcvjyknBQ9dF15I381Ccg== X-Received: by 10.223.164.140 with SMTP id g12mr9128880wrb.87.1490380907120; Fri, 24 Mar 2017 11:41:47 -0700 (PDT) Received: from u.nix.is ([2a01:4f8:190:5095::2]) by smtp.gmail.com with ESMTPSA id j77sm3440560wmj.3.2017.03.24.11.41.45 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 24 Mar 2017 11:41:46 -0700 (PDT) From: =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= To: git@vger.kernel.org Cc: Junio C Hamano , Lars Hjemli , Jeff King , Christian Couder , Carlos Rica , Samuel Tardieu , Tom Grennan , Karthik Nayak , =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= Subject: [PATCH v4 11/16] tag: change misleading --list documentation Date: Fri, 24 Mar 2017 18:40:54 +0000 Message-Id: <20170324184059.5374-12-avarab@gmail.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170324184059.5374-1-avarab@gmail.com> References: <20170324184059.5374-1-avarab@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Change the documentation for --list so that it's described as a toggle, not as an option that takes a as an argument. Junio initially documented this in b867c7c23a ("git-tag: -l to list tags (usability).", 2006-02-17), but later Jeff King changed "tag" to accept multiple patterns in 588d0e834b ("tag: accept multiple patterns for --list", 2011-06-20). However, documenting this as "-l " was never correct, as these both worked before Jeff's change: git tag -l 'v*' git tag 'v*' -l One would expect an option that was documented like that to only accept: git tag --list git tag --list 'v*rc*' And after Jeff's change, one that took multiple patterns: git tag --list 'v*rc*' --list '*2.8*' But since it's actually a toggle all of these work as well, and produce identical output to the last example above: git tag --list 'v*rc*' '*2.8*' git tag --list 'v*rc*' '*2.8*' --list --list --list git tag --list 'v*rc*' '*2.8*' --list -l --list -l --list Now the documentation is more in tune with how the "branch" command describes its --list option since commit cddd127b9a ("branch: introduce --list option", 2011-08-28). Change the test suite to assert that these invocations work for the cases that weren't already being tested for. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/git-tag.txt | 15 ++++++++------- t/t7004-tag.sh | 25 +++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 7 deletions(-) diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 448fdf3743..47d8733523 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -87,13 +87,14 @@ OPTIONS If no number is given to `-n`, only the first line is printed. If the tag is not annotated, the commit message is displayed instead. --l :: ---list :: - List tags with names that match the given pattern (or all if no - pattern is given). Running "git tag" without arguments also - lists all tags. The pattern is a shell wildcard (i.e., matched - using fnmatch(3)). Multiple patterns may be given; if any of - them matches, the tag is shown. +-l:: +--list:: + List tags. With optional `...`, e.g. `git tag --list + 'v-*'`, list only the tags that match the pattern(s). ++ +Running "git tag" without arguments also lists all tags. The pattern +is a shell wildcard (i.e., matched using fnmatch(3)). Multiple +patterns may be given; if any of them matches, the tag is shown. --sort=:: Sort based on the key given. Prefix `-` to sort in diff --git a/t/t7004-tag.sh b/t/t7004-tag.sh index 92af8bb7e6..75681b2cad 100755 --- a/t/t7004-tag.sh +++ b/t/t7004-tag.sh @@ -118,6 +118,18 @@ test_expect_success 'listing all tags if one exists should succeed' ' git tag ' +cat >expect <actual && + test_cmp expect actual && + git tag --list --list >actual && + test_cmp expect actual && + git tag --list -l --list >actual && + test_cmp expect actual +' + test_expect_success 'listing all tags if one exists should output that tag' ' test $(git tag -l) = mytag && test $(git tag) = mytag @@ -336,6 +348,19 @@ test_expect_success 'tag -l can accept multiple patterns' ' test_cmp expect actual ' +# Between v1.7.7 & v2.13.0 a fair reading of the git-tag documentation +# could leave you with the impression that "-l -l " +# was how we wanted to accept multiple patterns. +# +# This test should not imply that this is a sane thing to support. but +# since the documentation was worded like it was let's at least find +# out if we're going to break this long-documented form of taking +# multiple patterns. +test_expect_success 'tag -l -l works, as our buggy documentation previously suggested' ' + git tag -l "v1*" -l "v0*" >actual && + test_cmp expect actual +' + test_expect_success 'listing tags in column' ' COLUMNS=40 git tag -l --column=row >actual && cat >expected <<\EOF && -- 2.11.0