From patchwork Tue Sep 21 13:30:08 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12507835 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 07879C433EF for ; Tue, 21 Sep 2021 13:30:46 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id E34056109E for ; Tue, 21 Sep 2021 13:30:45 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233001AbhIUNcH (ORCPT ); Tue, 21 Sep 2021 09:32:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50558 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233054AbhIUNb6 (ORCPT ); Tue, 21 Sep 2021 09:31:58 -0400 Received: from mail-wr1-x42e.google.com (mail-wr1-x42e.google.com [IPv6:2a00:1450:4864:20::42e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AFA44C061757 for ; Tue, 21 Sep 2021 06:30:29 -0700 (PDT) Received: by mail-wr1-x42e.google.com with SMTP id t7so5960626wrw.13 for ; Tue, 21 Sep 2021 06:30:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=jXFFp/4BRhJsSl2lPH0LGRPfODuF4czq9vf4Mlu0+B8=; b=I9kmO7LtfjzQkOvvn6DzGWqh3ol78YhXTYzLTfHN6QB1INDrrRYd61JQkT9+qyOmkD uFexp1fqrpCJTbmbw07XphpNFN5C9YITRcyxaVC08IiQxuCMzuplYfsq6EUtueb8LH4Q 5rDFq1ouejb62ptkngexETExryK2t+SBDhkUNFBq6QjyURF9/4g+XO2xkw5C6mbzz1P2 5jWce7tO5mRge1GFpQlmNjX9ij1xu0Ymn+4qZf7n1/VgF1B1g765Ng37yM7PzuI9tS+H D3zkHhkk41dmDJBj3vSyUDFlnMLxWlkblbVebMphyEbRR/pMoSmZxuR5CiBc0AnvVANG QBJg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=jXFFp/4BRhJsSl2lPH0LGRPfODuF4czq9vf4Mlu0+B8=; b=uJ4+Xyh9/aC7A3SX5FoXBkRMMErpToLuYCTW2+02EfHqWWjTVeLTFq122OGxXeniEJ eeVG6ZQA82xJH/fdoEIkhYU3uXm5jb4p1s8qyIIU2jTFQdr6QPLT5WugTsO/y4PNlSXX ToEqddh1XM7p8du3WjjzI9ZMNAI3e4GGZe/UKXBd4lBnofSUGAMN0H83+d4jxQFAaI4V LyeSwwpM9YPkR+x7P8jQPC0m5ff4+JAv1WMSmfLQxzwNqBW7w6IDBhb1ujPLvzQta0Yu bwRONSHNi8OZqNpiQL1vnd9VYu+JXXGxlPy0U+r+wybmvouGSd/HzHQdXuYzUYqL0ww+ dRlg== X-Gm-Message-State: AOAM532jutKSZ6X8JwudaMxkcCXClgDmGBbSgdZE1pMyBx+5UrZKb4N9 ptVQpyOMt1zydxZ/5rtB3YRJve0lDUU8Jg== X-Google-Smtp-Source: ABdhPJyvYHFxVq6IRDu5Ha4yBjPqlmoZfbIKcRrgIelNXUsuMtCvmDVMGggwros/B6umH/TvvaazGA== X-Received: by 2002:a05:6000:105:: with SMTP id o5mr34752215wrx.413.1632231017607; Tue, 21 Sep 2021 06:30:17 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id 135sm2926891wma.32.2021.09.21.06.30.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Sep 2021 06:30:16 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Jeff King , Carlo Arenas , Eric Sunshine , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= Subject: [PATCH v5 1/4] parse-options API users: align usage output in C-strings Date: Tue, 21 Sep 2021 15:30:08 +0200 Message-Id: X-Mailer: git-send-email 2.33.0.1098.gf02a64c1a2d In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org In preparation for having continued usage lines properly aligned in "git -h" output, let's have the "[" on the second such lines align with the "[" on the first line. In some cases this makes the output worse, because e.g. the "git ls-remote -h" output had been aligned to account for the extra whitespace that the usage_with_options_internal() function in parse-options.c would add. In other cases such as builtin/stash.c (not changed here), we were aligned in the C strings, but since that didn't account for the extra padding in usage_with_options_internal() it would come out looking misaligned, e.g. code like this: N_("git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n" " [-u|--include-untracked] [-a|--all] [-m|--message ]\n" Would emit: or: git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet] [-u|--include-untracked] [-a|--all] [-m|--message ] Let's change all the usage arrays which use such continued usage output via "\n"-embedding to be like builtin/stash.c. This makes the output worse temporarily, but in a subsequent change I'll improve the usage_with_options_internal() to take this into account, at which point all of the strings being changed here will emit prettier output. Signed-off-by: Ævar Arnfjörð Bjarmason --- builtin/ls-remote.c | 4 ++-- builtin/show-branch.c | 6 +++--- builtin/stash.c | 2 +- builtin/tag.c | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c index f4fd823af83..318949c3d75 100644 --- a/builtin/ls-remote.c +++ b/builtin/ls-remote.c @@ -7,8 +7,8 @@ static const char * const ls_remote_usage[] = { N_("git ls-remote [--heads] [--tags] [--refs] [--upload-pack=]\n" - " [-q | --quiet] [--exit-code] [--get-url]\n" - " [--symref] [ [...]]"), + " [-q | --quiet] [--exit-code] [--get-url]\n" + " [--symref] [ [...]]"), NULL }; diff --git a/builtin/show-branch.c b/builtin/show-branch.c index bea4bbf4680..082449293b5 100644 --- a/builtin/show-branch.c +++ b/builtin/show-branch.c @@ -11,9 +11,9 @@ static const char* show_branch_usage[] = { N_("git show-branch [-a | --all] [-r | --remotes] [--topo-order | --date-order]\n" - " [--current] [--color[=] | --no-color] [--sparse]\n" - " [--more= | --list | --independent | --merge-base]\n" - " [--no-name | --sha1-name] [--topics] [( | )...]"), + " [--current] [--color[=] | --no-color] [--sparse]\n" + " [--more= | --list | --independent | --merge-base]\n" + " [--no-name | --sha1-name] [--topics] [( | )...]"), N_("git show-branch (-g | --reflog)[=[,]] [--list] []"), NULL }; diff --git a/builtin/stash.c b/builtin/stash.c index 8f42360ca91..45b19007d7c 100644 --- a/builtin/stash.c +++ b/builtin/stash.c @@ -85,7 +85,7 @@ static const char * const git_stash_push_usage[] = { static const char * const git_stash_save_usage[] = { N_("git stash save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n" - " [-u|--include-untracked] [-a|--all] []"), + " [-u|--include-untracked] [-a|--all] []"), NULL }; diff --git a/builtin/tag.c b/builtin/tag.c index 065b6bf093e..6535ed27ee9 100644 --- a/builtin/tag.c +++ b/builtin/tag.c @@ -23,10 +23,10 @@ static const char * const git_tag_usage[] = { N_("git tag [-a | -s | -u ] [-f] [-m | -F ]\n" - "\t\t []"), + " []"), N_("git tag -d ..."), N_("git tag -l [-n[]] [--contains ] [--no-contains ] [--points-at ]\n" - "\t\t[--format=] [--merged ] [--no-merged ] [...]"), + " [--format=] [--merged ] [--no-merged ] [...]"), N_("git tag -v [--format=] ..."), NULL }; From patchwork Tue Sep 21 13:30:09 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12507829 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 12143C433F5 for ; Tue, 21 Sep 2021 13:30:25 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id F0D9F6115A for ; Tue, 21 Sep 2021 13:30:24 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232968AbhIUNbw (ORCPT ); Tue, 21 Sep 2021 09:31:52 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50510 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231247AbhIUNbt (ORCPT ); Tue, 21 Sep 2021 09:31:49 -0400 Received: from mail-wr1-x429.google.com (mail-wr1-x429.google.com [IPv6:2a00:1450:4864:20::429]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A3760C061574 for ; Tue, 21 Sep 2021 06:30:20 -0700 (PDT) Received: by mail-wr1-x429.google.com with SMTP id u15so39206618wru.6 for ; Tue, 21 Sep 2021 06:30:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=0lTujGClX5MD6i5VCQld4pCb+Gtw7PyT3DmtQXIneos=; b=Tud9bBKidMEXhNer1RlYlDskgiOxI25kfr67UjSP35LwBRxSsQBEF1zKrgQ87BIxNN RDh8Dco1ifPEXNfVayGQuUFkZmoAztw2FNhBDfHmI2x0OGui3FkGA1P+oy/g9QScXxgS Wn18I63NX4S7FYWC+JZreBOdXBniyUE/ic9Ev6CjJi8DWyu6TZKIsxQ1g8L9fVWePQe+ BCS/ojWAcx1KZ5g16tNYhitozPmdty83ocG2Zakcn0RLAlBkz5kUfl8asOx2ri3KZpSQ yNk96QeH8b4KNNurGEaJearn78QJlS/WoiECwvjQ0eY5ogBCbyT9s1qirzRgsffEu9dB RnwA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=0lTujGClX5MD6i5VCQld4pCb+Gtw7PyT3DmtQXIneos=; b=c1/C7S6Yilhl+5Fk1y+1mBUuLfTG4vwVb6plC4tsaDs4+UjfpdxqU+jDnlqhfh9vAO 0yasDBjOTS1kkdmMjDY7JORa602ObV5lVMBlLxFcxOc9xNjGVIcgYBYBvVTyLpLvV/Fn FiiC7wOB8snzkQEL91hySqzQ0io1OOZmGuLAFdJ6Hn+ZaIWGsAIX9VBqwO2IzZ13GPyP TNo8AjD69tFy+Bi2AuSqJElPko8cnGgyqcCA5R5UDqmvdEKIPzmYfLlgz9o+R9LUfOoC vAvy2Mmg7J0KjfCVgFtbEMIf84CDcVAI3A1UmIwm2G4ZWNkhLPztfwyxBvkJjoLphdTD hzJw== X-Gm-Message-State: AOAM530VruXnLTCZGis0l1S0maG19C9MaiBQHGA/BlcWKItSBV9a0Se4 GZ/P4QnDdylWDej67WiPyKI2x/Fo5kr6JA== X-Google-Smtp-Source: ABdhPJybgWIhSCqbSw6W8hJ2Il2wfAyLtUSGIEi2T5MDZnAWY6T3sHihfwYfrP+ZVtJTQD6KA3sSsQ== X-Received: by 2002:a7b:c242:: with SMTP id b2mr4685882wmj.182.1632231018530; Tue, 21 Sep 2021 06:30:18 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id 135sm2926891wma.32.2021.09.21.06.30.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Sep 2021 06:30:17 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Jeff King , Carlo Arenas , Eric Sunshine , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= Subject: [PATCH v5 2/4] send-pack: properly use parse_options() API for usage string Date: Tue, 21 Sep 2021 15:30:09 +0200 Message-Id: X-Mailer: git-send-email 2.33.0.1098.gf02a64c1a2d In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org When "send-pack" was changed to use the parse_options() API in 068c77a5189 (builtin/send-pack.c: use parse_options API, 2015-08-19) it was made to use one very long line, instead it should split them up with newlines. Furthermore we were including an inline explanation that you couldn't combine "--all" and "", but unlike in the "blame" case this was not preceded by an empty string. Let's instead show that --all and can't be combined in the the usual language of the usage syntax instead. We can make it clear that one of the two options "--foo" and "--bar" is mandatory, but that the two are mutually exclusive by referring to them as "( --foo | --bar )". Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/git-send-pack.txt | 4 ++-- builtin/send-pack.c | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt index 44fd146b912..be41f119740 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt @@ -9,10 +9,10 @@ git-send-pack - Push objects over Git protocol to another repository SYNOPSIS -------- [verse] -'git send-pack' [--all] [--dry-run] [--force] [--receive-pack=] +'git send-pack' [--dry-run] [--force] [--receive-pack=] [--verbose] [--thin] [--atomic] [--[no-]signed|--signed=(true|false|if-asked)] - [:] [...] + [:] (--all | ...) DESCRIPTION ----------- diff --git a/builtin/send-pack.c b/builtin/send-pack.c index 729dea1d255..89321423125 100644 --- a/builtin/send-pack.c +++ b/builtin/send-pack.c @@ -17,10 +17,10 @@ #include "protocol.h" static const char * const send_pack_usage[] = { - N_("git send-pack [--all | --mirror] [--dry-run] [--force] " - "[--receive-pack=] [--verbose] [--thin] [--atomic] " - "[:] [...]\n" - " --all and explicit specification are mutually exclusive."), + N_("git send-pack [--mirror] [--dry-run] [--force]\n" + " [--receive-pack=]\n" + " [--verbose] [--thin] [--atomic]\n" + " [:] (--all | ...)"), NULL, }; From patchwork Tue Sep 21 13:30:10 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12507831 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 46663C433F5 for ; Tue, 21 Sep 2021 13:30:28 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 1CE006109E for ; Tue, 21 Sep 2021 13:30:28 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233037AbhIUNbx (ORCPT ); Tue, 21 Sep 2021 09:31:53 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50514 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232919AbhIUNbt (ORCPT ); Tue, 21 Sep 2021 09:31:49 -0400 Received: from mail-wr1-x431.google.com (mail-wr1-x431.google.com [IPv6:2a00:1450:4864:20::431]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5E236C061575 for ; Tue, 21 Sep 2021 06:30:21 -0700 (PDT) Received: by mail-wr1-x431.google.com with SMTP id t8so39218801wrq.4 for ; Tue, 21 Sep 2021 06:30:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=l0yckHJIArVuiJ/szbOwUMYq9UWAkgGP3PdHtjmt8D8=; b=hQBGyiTzP1f8ErCZ03/dD28abvvw8nuH+X+irlpFcuFk6+Y/ppeSpOEuNaSUhOww+3 e8bO/UTJDwFPuJbCIKA8lg+Rqlxv0WHgcqNCQz2T5Mpfj51J9FunGhn7vJueh5a05dkC H61vwPBRGjF0CZ+8xV0Vr3RnT3nwbCwvfe5qvs5nrNJ+g4vFe/5VuEXlFYeCERg/wpr7 xleMrjfa824Iq/btATweuS+Zqvbg3nx7jaMLB3vuK1cMQFGT5PdZsjcNVfxUbjFhRvLS hawX6VJcFdCYjM6JiYOl49mpBaaKUNjD9ckzjwclY2XlQ6wIW10R0xKvs9RmMxN3s6Qo Qr9A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=l0yckHJIArVuiJ/szbOwUMYq9UWAkgGP3PdHtjmt8D8=; b=1wqey+jgIc2ru0C/QUdNkucNqNAhKprhqkPSQOwPjeNpb4K4AQpMXZsxKG03IPQIYv dKmFQu9s/gM7TONNndq3uhhIbL166Ux9Xy1h5q0X/EHkIQXw/KjHqWxkLCVfMJMcZlvt bgS8eOqwTc5H+dWCvuwWZGtSTbFBfb9RZxmn6KiFEQ0KO8Wjcjz/8wfuieCDprKe2skC SLqiPe+3AT/JCBye9Td1YLOuDND5rmep1u5jx2lmK2ceXGUJpNsAW8ClLYBz6bXMP3Nl X/rbe6+rpAFwZRt939Fsh2CECjR4OwEP50pVU+khr/lqncTaKyFttYGdV8y4LXXzO8jN Ahvw== X-Gm-Message-State: AOAM5325DFs750Vjg1A1EyLB3D+xORAAwfdUO4I7KVCqRlQvZLNrGnW1 JZHT8BZPUqkvWTUjNScPIlCGxYS9KV5dLw== X-Google-Smtp-Source: ABdhPJxV2NY3cwokLmcS089ypiJbV1ivBA46hkatFAT1OLYyvFwg3AfKQEabMAHlTmXBKBdpcNBecg== X-Received: by 2002:adf:d4cb:: with SMTP id w11mr35711827wrk.125.1632231019598; Tue, 21 Sep 2021 06:30:19 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id 135sm2926891wma.32.2021.09.21.06.30.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Sep 2021 06:30:18 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Jeff King , Carlo Arenas , Eric Sunshine , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= Subject: [PATCH v5 3/4] git rev-parse --parseopt tests: add more usagestr tests Date: Tue, 21 Sep 2021 15:30:10 +0200 Message-Id: X-Mailer: git-send-email 2.33.0.1098.gf02a64c1a2d In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Add tests for the "usagestr" passed to parse-options.c usage_with_options_internal() through cmd_parseopt(). These test for edge cases in the existing behavior related to the "--parseopt" interface doing its own line-splitting with strbuf_getline(), and the native C interface expecting and potentially needing to handle newlines within the strings in the array it accepts. The results are probably something that wasn't anticipated, but let's make sure we stay backwards compatible with it. Signed-off-by: Ævar Arnfjörð Bjarmason --- t/t1502-rev-parse-parseopt.sh | 54 +++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/t/t1502-rev-parse-parseopt.sh b/t/t1502-rev-parse-parseopt.sh index b29563fc997..284fe18e726 100755 --- a/t/t1502-rev-parse-parseopt.sh +++ b/t/t1502-rev-parse-parseopt.sh @@ -282,4 +282,58 @@ test_expect_success 'test --parseopt --stuck-long and short option with unset op test_cmp expect output ' +test_expect_success 'test --parseopt help output: "wrapped" options normal "or:" lines' ' + sed -e "s/^|//" >spec <<-\EOF && + |cmd [--some-option] + | [--another-option] + |cmd [--yet-another-option] + |-- + |h,help show the help + EOF + + sed -e "s/^|//" >expect <<-\END_EXPECT && + |cat <<\EOF + |usage: cmd [--some-option] + | or: [--another-option] + | or: cmd [--yet-another-option] + | + | -h, --help show the help + | + |EOF + END_EXPECT + + test_must_fail git rev-parse --parseopt -- -h >out actual && + test_cmp expect actual +' + +test_expect_success 'test --parseopt help output: multi-line blurb after empty line' ' + sed -e "s/^|//" >spec <<-\EOF && + |cmd [--some-option] + | [--another-option] + | + |multi + |line + |blurb + |-- + |h,help show the help + EOF + + sed -e "s/^|//" >expect <<-\END_EXPECT && + |cat <<\EOF + |usage: cmd [--some-option] + | or: [--another-option] + | + | multi + | line + | blurb + | + | -h, --help show the help + | + |EOF + END_EXPECT + + test_must_fail git rev-parse --parseopt -- -h >out actual && + test_cmp expect actual +' + test_done From patchwork Tue Sep 21 13:30:11 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12507833 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 506C0C433EF for ; Tue, 21 Sep 2021 13:30:36 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 2A1486115B for ; Tue, 21 Sep 2021 13:30:36 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233055AbhIUNb7 (ORCPT ); Tue, 21 Sep 2021 09:31:59 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50522 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232953AbhIUNbv (ORCPT ); Tue, 21 Sep 2021 09:31:51 -0400 Received: from mail-wr1-x42e.google.com (mail-wr1-x42e.google.com [IPv6:2a00:1450:4864:20::42e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A1B7FC061574 for ; Tue, 21 Sep 2021 06:30:22 -0700 (PDT) Received: by mail-wr1-x42e.google.com with SMTP id q26so39154829wrc.7 for ; Tue, 21 Sep 2021 06:30:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=IBd5PU15YHAHVdHf62x54aa16G3NCIhGQ2tbmtxgXqc=; b=Ydb3jiOwbo9+Brary8AmBCM1GLNhbmu+SrGFm9u/nxp800knqL9iJFvyEe/mcgepG0 2i5dc6KhZenH58OsDXGl0TecjR/h6T46MWmC7fRbx/QRelYLRdSqtWlpprn4XS9bqGup eTVeKJdUkt68RXq6AcvG/U8TrVne27/F0xFMyvb8omjKwH/r8SvNGMedOiT+t6FosK7F 80NFQ0RV0dBxvVIDK4gWutZVDA1coHBQXafUhjezbC6fkttKIDZcHdhx8DskModDyf+k fmbb2WKyBCeIukEtSxdPd3Gb6jYN2A/4z6QtSd3o0ChwSe7HfsT2mOfzWo/ma5BMyDH1 ILSA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=IBd5PU15YHAHVdHf62x54aa16G3NCIhGQ2tbmtxgXqc=; b=i6sYfgIXLXM7MxfsDDb6WXs1yPFaHQZA66zBoE6zvmoXJ+4cLvAh0h/dcRTKL6tfg1 NgnmcVQQGTb/li4z/o1ilpzeDfP8ZxTt2in9EZuROFtb56jEKvTGJKBZtbGj8Wl8mhmG 8kvT/64OadGx/aCxavWziVESaf9PtKJOfYJ8ObkexOArLQD2JfVIGOFZFPgjrx7GTFJw JRZEK+uZ7HkXuIymOfvi4xenxAWAKIhINrBIUoNV14e7m7hgxGZbbWQCtvDbBOUTE/ES T7yeOiUMvIQy61HwZGtmkHMcURfCGnYgcPwKptiDrJAjhWWnxSZx0VwBdcqZ983V/vic hZnA== X-Gm-Message-State: AOAM530cISpndjT/G8AmOpday21PQ0tBSr9urKAPCJ7fhd1jJexssQVM PcUTaJ/v7SjlbhzcRsolMUa3Z/cVNEpXYQ== X-Google-Smtp-Source: ABdhPJyM2Awnjfy9jfMBg6/0nqQuL+W318I5pvA/la9XvAsXtI6GCFMjyHpGoHe4tCYD/UjV1lZc8A== X-Received: by 2002:a7b:c142:: with SMTP id z2mr4859057wmi.10.1632231020693; Tue, 21 Sep 2021 06:30:20 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id 135sm2926891wma.32.2021.09.21.06.30.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Sep 2021 06:30:19 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Jeff King , Carlo Arenas , Eric Sunshine , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= Subject: [PATCH v5 4/4] parse-options: properly align continued usage output Date: Tue, 21 Sep 2021 15:30:11 +0200 Message-Id: X-Mailer: git-send-email 2.33.0.1098.gf02a64c1a2d In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Some commands such as "git stash" emit continued options output with e.g. "git stash -h", because usage_with_options_internal() prefixes with its own whitespace the resulting output wasn't properly aligned. Let's account for the added whitespace, which properly aligns the output. The "git stash" command has usage output with a N_() translation that legitimately stretches across multiple lines; N_("git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n" " [-u|--include-untracked] [-a|--all] [-m|--message ]\n" [...] We'd like to have that output aligned with the length of the initial "git stash " output, but since usage_with_options_internal() adds its own whitespace prefixing we fell short, before this change we'd emit: $ git stash -h usage: git stash list [] or: git stash show [] [] [...] or: git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet] [-u|--include-untracked] [-a|--all] [-m|--message ] [...] Now we'll properly emit aligned output. I.e. the last four lines above will instead be (a whitespace-only change to the above): [...] or: git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet] [-u|--include-untracked] [-a|--all] [-m|--message ] [...] We could also go for an approach where we have the caller support no padding of their own, i.e. (same as the first example, except for the padding on the second line): N_("git stash [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]\n" "[-u|--include-untracked] [-a|--all] [-m|--message ]\n" [...] But to do that we'll need to find the length of "git stash". We can discover that from the "cmd" in the "struct cmd_struct", but there might be cases with sub-commands or "git" itself taking arguments that would make that non-trivial. Even if it were I still think this approach is better, because this way we'll get the same legible alignment in the C code. The fact that usage_with_options_internal() is adding its own prefix padding is an implementation detail that callers shouldn't need to worry about. Implementation notes: We could skip the string_list_split() with a strchr(str, '\n') check, but we'd then need to duplicate our state machine for strings that do and don't contain a "\n". It's simpler to just always split into a "struct string_list", even though the common case is that that "struct string_list" will contain only one element. This is not performance-sensitive code. This change is relatively more complex since I've accounted for making it future-proof for RTL translation support. Later in usage_with_options_internal() we have some existing padding code dating back to d7a38c54a6c (parse-options: be able to generate usages automatically, 2007-10-15) which isn't RTL-safe, but that code would be easy to fix. Let's not introduce new RTL translation problems here. Signed-off-by: Ævar Arnfjörð Bjarmason --- parse-options.c | 76 +++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 64 insertions(+), 12 deletions(-) diff --git a/parse-options.c b/parse-options.c index 2abff136a17..75f0a6c81c5 100644 --- a/parse-options.c +++ b/parse-options.c @@ -917,25 +917,77 @@ static int usage_with_options_internal(struct parse_opt_ctx_t *ctx, FILE *outfile = err ? stderr : stdout; int need_newline; + const char *usage_prefix = _("usage: %s"); + /* + * The translation could be anything, but we can count on + * msgfmt(1)'s --check option to have asserted that "%s" is in + * the translation. So compute the length of the "usage: " + * part. We are assuming that the translator wasn't overly + * clever and used e.g. "%1$s" instead of "%s", there's only + * one "%s" in "usage_prefix" above, so there's no reason to + * do so even with a RTL language. + */ + size_t usage_len = strlen(usage_prefix) - strlen("%s"); + /* + * TRANSLATORS: the colon here should align with the + * one in "usage: %s" translation. + */ + const char *or_prefix = _(" or: %s"); + /* + * TRANSLATORS: You should only need to translate this format + * string if your language is a RTL language (e.g. Arabic, + * Hebrew etc.), not if it's a LTR language (e.g. German, + * Russian, Chinese etc.). + * + * When a translated usage string has an embedded "\n" it's + * because options have wrapped to the next line. The line + * after the "\n" will then be padded to align with the + * command name, such as N_("git cmd [opt]\n<8 + * spaces>[opt2]"), where the 8 spaces are the same length as + * "git cmd ". + * + * This format string prints out that already-translated + * line. The "%*s" is whitespace padding to account for the + * padding at the start of the line that we add in this + * function. The "%s" is a line in the (hopefully already + * translated) N_() usage string, which contained embedded + * newlines before we split it up. + */ + const char *usage_continued = _("%*s%s"); + const char *prefix = usage_prefix; + int saw_empty_line = 0; + if (!usagestr) return PARSE_OPT_HELP; if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL) fprintf(outfile, "cat <<\\EOF\n"); - fprintf_ln(outfile, _("usage: %s"), _(*usagestr++)); - while (*usagestr && **usagestr) - /* - * TRANSLATORS: the colon here should align with the - * one in "usage: %s" translation. - */ - fprintf_ln(outfile, _(" or: %s"), _(*usagestr++)); while (*usagestr) { - if (**usagestr) - fprintf_ln(outfile, _(" %s"), _(*usagestr)); - else - fputc('\n', outfile); - usagestr++; + const char *str = _(*usagestr++); + struct string_list list = STRING_LIST_INIT_DUP; + unsigned int j; + + if (!saw_empty_line && !*str) + saw_empty_line = 1; + + string_list_split(&list, str, '\n', -1); + for (j = 0; j < list.nr; j++) { + const char *line = list.items[j].string; + + if (saw_empty_line && *line) + fprintf_ln(outfile, _(" %s"), line); + else if (saw_empty_line) + fputc('\n', outfile); + else if (!j) + fprintf_ln(outfile, prefix, line); + else + fprintf_ln(outfile, usage_continued, + (int)usage_len, "", line); + } + string_list_clear(&list, 0); + + prefix = or_prefix; } need_newline = 1;