From patchwork Wed Feb 23 14:27:34 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Abhradeep Chakraborty X-Patchwork-Id: 12756988 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id B6EEBC433F5 for ; Wed, 23 Feb 2022 14:27:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241562AbiBWO2I (ORCPT ); Wed, 23 Feb 2022 09:28:08 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46044 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S241557AbiBWO2G (ORCPT ); Wed, 23 Feb 2022 09:28:06 -0500 Received: from mail-wm1-x32a.google.com (mail-wm1-x32a.google.com [IPv6:2a00:1450:4864:20::32a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B453FB0D0D for ; Wed, 23 Feb 2022 06:27:38 -0800 (PST) Received: by mail-wm1-x32a.google.com with SMTP id n25-20020a05600c3b9900b00380f41e51e6so1466617wms.2 for ; Wed, 23 Feb 2022 06:27:38 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=w8iGpfrC4gln9yfbTzzdR/UkF31WZul5d8WLQDRWN4o=; b=BbDZcRrRoE/4oULozTIxviADKxo6A/6HiW4e1nvEEy2Xrjt0Hh172i34WpRA18Mkxc xZmQTSnn3zsBcG0JhN8L6p1qflajEZn73vB26vi/hlyNLj4KTs6JvDvYhti2JboJHhk0 eMsq64jAUwmXbQVfT+OlkCzzGX1xIfC9RVKvZ/YcvbSjsSlgufMfwvl8rT8Kne6dKZ1Y S0DvWw14yRo3NsI7yCPlTiFDWgZSelKIQ1EdRZkIG1qQrvaFaghlDxnqE+t2mJz3nic+ at9dwWtxuXAaYQSy697bTsu6aGo+kj9ag0oJylc5kY0+C/1CN0TlyXb2CLinz//mIz5O t/Xw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=w8iGpfrC4gln9yfbTzzdR/UkF31WZul5d8WLQDRWN4o=; b=TpJQ8hDb2az1O7mRhVBAav73dcmgcG9cR3To2T6cH+E+XSKQeip3U7V6fS/w6XFwu+ s2ZGI9/x1cFw7iy/U715wgkkQTIIuY8Qu9RL3ogWkl2WiTIxEQ2I9oj4oNLfeRnUvJhP W1ZJ3moUVJeT1IriXxOLeowK91+pYj9Z5iLbDf0B+4tYibCg3I9vNL4WZksjBiIJtu4H 03U/XwsMqtCUabMDPpEcnG3pGT1sJkSPCmHDdSEl/LVhV2Uj25/LXpN2F7rsbWYlKAeb kqGYDU0Sqzf81CTW+yIGVhJcEEekuGT+hiO6dHV7iWhyyqGruK3NKaR3/Kn0fJx5rjue 1R4w== X-Gm-Message-State: AOAM533sTkRwxKbjhZoXXvIsRsmDd/7BlGqFsCfjI54Cqq/F65qMsrRG IDGyKPiy4KBwwUYpYS7pdzKJImOmFV0= X-Google-Smtp-Source: ABdhPJy5fIPClWlmFBDg5F1ec7++ogTTjfq8+ygijY592Q6tZACotPLj1IWh4kBYy87TqHbP3SY70g== X-Received: by 2002:a05:600c:1c9a:b0:37b:bbbd:b8db with SMTP id k26-20020a05600c1c9a00b0037bbbbdb8dbmr7791396wms.185.1645626457141; Wed, 23 Feb 2022 06:27:37 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id f3sm23583453wri.6.2022.02.23.06.27.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 23 Feb 2022 06:27:36 -0800 (PST) Message-Id: In-Reply-To: References: Date: Wed, 23 Feb 2022 14:27:34 +0000 Subject: [PATCH v3 1/2] amend remaining usage strings according to style guide Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Johannes Schindelin , Julia Lawall , Eric Sunshine , Abhradeep Chakraborty , Abhra303 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Abhra303 From: Abhra303 Usage strings for git (sub)command flags has a style guide that suggests - first letter should not capitalized (unless required) and it should skip full-stop at the end of line. But there are some files where usage-strings do not follow the above mentioned guide. Amend the usage strings that don't follow the style convention/guide. Signed-off-by: Abhradeep Chakraborty --- builtin/bisect--helper.c | 2 +- builtin/reflog.c | 6 +++--- builtin/submodule--helper.c | 2 +- diff.c | 2 +- t/helper/test-run-command.c | 6 +++--- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c index 28a2e6a5750..614d95b022c 100644 --- a/builtin/bisect--helper.c +++ b/builtin/bisect--helper.c @@ -1209,7 +1209,7 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix) OPT_CMDMODE(0, "bisect-visualize", &cmdmode, N_("visualize the bisection"), BISECT_VISUALIZE), OPT_CMDMODE(0, "bisect-run", &cmdmode, - N_("use ... to automatically bisect."), BISECT_RUN), + N_("use ... to automatically bisect"), BISECT_RUN), OPT_BOOL(0, "no-log", &nolog, N_("no log for BISECT_WRITE")), OPT_END() diff --git a/builtin/reflog.c b/builtin/reflog.c index 85b838720c3..28372c5e2b5 100644 --- a/builtin/reflog.c +++ b/builtin/reflog.c @@ -600,7 +600,7 @@ static int cmd_reflog_expire(int argc, const char **argv, const char *prefix) OPT_BIT(0, "updateref", &flags, N_("update the reference to the value of the top reflog entry"), EXPIRE_REFLOGS_UPDATE_REF), - OPT_BOOL(0, "verbose", &verbose, N_("print extra information on screen.")), + OPT_BOOL(0, "verbose", &verbose, N_("print extra information on screen")), OPT_CALLBACK_F(0, "expire", &cmd, N_("timestamp"), N_("prune entries older than the specified time"), PARSE_OPT_NONEG, @@ -613,7 +613,7 @@ static int cmd_reflog_expire(int argc, const char **argv, const char *prefix) N_("prune any reflog entries that point to broken commits")), OPT_BOOL(0, "all", &do_all, N_("process the reflogs of all references")), OPT_BOOL(1, "single-worktree", &all_worktrees, - N_("limits processing to reflogs from the current worktree only.")), + N_("limits processing to reflogs from the current worktree only")), OPT_END() }; @@ -736,7 +736,7 @@ static int cmd_reflog_delete(int argc, const char **argv, const char *prefix) OPT_BIT(0, "updateref", &flags, N_("update the reference to the value of the top reflog entry"), EXPIRE_REFLOGS_UPDATE_REF), - OPT_BOOL(0, "verbose", &verbose, N_("print extra information on screen.")), + OPT_BOOL(0, "verbose", &verbose, N_("print extra information on screen")), OPT_END() }; diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c index 33c82c3ab91..6332d305983 100644 --- a/builtin/submodule--helper.c +++ b/builtin/submodule--helper.c @@ -1875,7 +1875,7 @@ static int module_clone(int argc, const char **argv, const char *prefix) OPT_STRING(0, "depth", &clone_data.depth, N_("string"), N_("depth for shallow clones")), - OPT__QUIET(&quiet, "Suppress output for cloning a submodule"), + OPT__QUIET(&quiet, "suppress output for cloning a submodule"), OPT_BOOL(0, "progress", &progress, N_("force cloning progress")), OPT_BOOL(0, "require-init", &require_init, diff --git a/diff.c b/diff.c index 7d5cfd325ea..387435a4a45 100644 --- a/diff.c +++ b/diff.c @@ -5630,7 +5630,7 @@ static void prep_parse_options(struct diff_options *options) N_("select files by diff type"), PARSE_OPT_NONEG, diff_opt_diff_filter), { OPTION_CALLBACK, 0, "output", options, N_(""), - N_("Output to a specific file"), + N_("output to a specific file"), PARSE_OPT_NONEG, NULL, 0, diff_opt_output }, OPT_END() diff --git a/t/helper/test-run-command.c b/t/helper/test-run-command.c index 913775a14b7..8f370cd89f1 100644 --- a/t/helper/test-run-command.c +++ b/t/helper/test-run-command.c @@ -221,9 +221,9 @@ static int quote_stress_test(int argc, const char **argv) struct strbuf out = STRBUF_INIT; struct strvec args = STRVEC_INIT; struct option options[] = { - OPT_INTEGER('n', "trials", &trials, "Number of trials"), - OPT_INTEGER('s', "skip", &skip, "Skip trials"), - OPT_BOOL('m', "msys2", &msys2, "Test quoting for MSYS2's sh"), + OPT_INTEGER('n', "trials", &trials, "number of trials"), + OPT_INTEGER('s', "skip", &skip, "skip trials"), + OPT_BOOL('m', "msys2", &msys2, "test quoting for MSYS2's sh"), OPT_END() }; const char * const usage[] = { From patchwork Wed Feb 23 14:27:35 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Abhradeep Chakraborty X-Patchwork-Id: 12756989 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8695BC433EF for ; Wed, 23 Feb 2022 14:27:46 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S241567AbiBWO2M (ORCPT ); Wed, 23 Feb 2022 09:28:12 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46050 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S241559AbiBWO2H (ORCPT ); Wed, 23 Feb 2022 09:28:07 -0500 Received: from mail-wr1-x42f.google.com (mail-wr1-x42f.google.com [IPv6:2a00:1450:4864:20::42f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8833F4B425 for ; Wed, 23 Feb 2022 06:27:39 -0800 (PST) Received: by mail-wr1-x42f.google.com with SMTP id v21so4661936wrv.5 for ; Wed, 23 Feb 2022 06:27:39 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=0+N5xsfqc55jf6KHiNqi60QCC/m3RfVQDLsjUaMjvhs=; b=ExZDB/5ZhkLmA8OGU8aantl4Y9i3ts40ADOIkBCB8ZwW9U2DI7f6+glofv+Y/VIGm9 /rMd6zDDbbXkDu/0XVUs2PCu9II+pPEDdBPlbu5LorJ7aboy4aRlx6Of1D54PSrOHide 9nwCQKyhIPK9HLRtzyr633y1xPzadVfFlgNUl99XMukWg6OKQlGUB4CrsmaDoKHKUqVv ShdICkp9Ng0dv6XRWWWL7tUzChB9QmljoWbAm9EXDvM5LGSPgE0pFgbaFW/4bsDmaeZx FElV+fdUPqUno4GAMwZt7siMRp6aMMX022TUdct22xg63TfoBIbE3vBgElnjQpZGCPll Hb9Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=0+N5xsfqc55jf6KHiNqi60QCC/m3RfVQDLsjUaMjvhs=; b=k+a6FgnvskujsKXmGI8tP9LKuY5BAcwHDDy+hXrD9vqlx/j2LcvbTYM/24mlzXhXZE nfT62MZqnqRCJNDFFhcqxTtm10fXGfivMyXFhfXv8BRzixcixBkeJknP50LAbNBJ7QQO k7MWtMHlT4HKSWUgl1GeCD00+V4NHYS7flr64No93OUO1HMvq9iRyw8Ux12supnPLFFn acUvXuGOX11MsA5q8mLKbdKUYlE4vMTq24RZ1dttiooIcqZjcIOBYPvR6yzwgHYgLwrk xzGLdEk7RmMDTXSHGKhtWN9GO8OwoFcPXbGIxXioJ5D2maTVsSgrZkO3+Z8vDZ7lkk/h FRLw== X-Gm-Message-State: AOAM533sJ/vadZQ0/ADqYD9TQNFAjqbSiMC+pf+4AZiTndEDSJlOSKZk qF764FWcxeCWr1ZXkwPCuZ4jDiBlhow= X-Google-Smtp-Source: ABdhPJw9rq3PIY7WDowO2QTPb7UnMOesaiCBYVnn6lrUTYQ5VaMoEqDUEOLyjlR1QhK9cDpUKlTldw== X-Received: by 2002:a5d:6da3:0:b0:1e3:2f74:f025 with SMTP id u3-20020a5d6da3000000b001e32f74f025mr23896971wrs.59.1645626457938; Wed, 23 Feb 2022 06:27:37 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id j5-20020a05600c410500b0037bc3e4b526sm5501911wmi.7.2022.02.23.06.27.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 23 Feb 2022 06:27:37 -0800 (PST) Message-Id: <9d42bdbff6ccaaf34952de9e6cc4ff2e7eef714d.1645626455.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Wed, 23 Feb 2022 14:27:35 +0000 Subject: [PATCH v3 2/2] parse-options.c: add style checks for usage-strings Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Johannes Schindelin , Julia Lawall , Eric Sunshine , Abhradeep Chakraborty , Abhradeep Chakraborty Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Abhradeep Chakraborty From: Abhradeep Chakraborty `parse-options.c` doesn't check if the usage strings for option flags are following the style guide or not. Style convention says, usage strings should not start with capital letter (unless needed) and it should not end with `.`. Add checks to the `parse_options_check()` function to check usage strings against the style convention. Signed-off-by: Abhradeep Chakraborty --- parse-options.c | 6 ++++++ t/t1502-rev-parse-parseopt.sh | 4 ++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/parse-options.c b/parse-options.c index 2437ad3bcdd..eb92290a63a 100644 --- a/parse-options.c +++ b/parse-options.c @@ -492,6 +492,12 @@ static void parse_options_check(const struct option *opts) default: ; /* ok. (usually accepts an argument) */ } + if (opts->type != OPTION_GROUP && opts->help && + opts->help[0] && isupper(opts->help[0]) && + !(opts->help[1] && isupper(opts->help[1]))) + err |= optbug(opts, xstrfmt("help should not start with capital letter unless needed: %s", opts->help)); + if (opts->help && !ends_with(opts->help, "...") && ends_with(opts->help, ".")) + err |= optbug(opts, xstrfmt("help should not end with a dot: %s", opts->help)); if (opts->argh && strcspn(opts->argh, " _") != strlen(opts->argh)) err |= optbug(opts, "multi-word argh should use dash to separate words"); diff --git a/t/t1502-rev-parse-parseopt.sh b/t/t1502-rev-parse-parseopt.sh index 284fe18e726..2a07e130b96 100755 --- a/t/t1502-rev-parse-parseopt.sh +++ b/t/t1502-rev-parse-parseopt.sh @@ -53,7 +53,7 @@ test_expect_success 'setup optionspec-only-hidden-switches' ' | |some-command does foo and bar! |-- -|hidden1* A hidden switch +|hidden1* a hidden switch EOF ' @@ -131,7 +131,7 @@ test_expect_success 'test --parseopt help-all output hidden switches' ' | | some-command does foo and bar! | -| --hidden1 A hidden switch +| --hidden1 a hidden switch | |EOF END_EXPECT