From mboxrd@z Thu Jan 1 00:00:00 1970 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 305A4C32771 for ; Wed, 28 Sep 2022 08:42:53 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233605AbiI1Ims (ORCPT ); Wed, 28 Sep 2022 04:42:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57780 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233349AbiI1Ikn (ORCPT ); Wed, 28 Sep 2022 04:40:43 -0400 Received: from mail-wm1-x335.google.com (mail-wm1-x335.google.com [IPv6:2a00:1450:4864:20::335]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2D08AA6AED for ; Wed, 28 Sep 2022 01:40:14 -0700 (PDT) Received: by mail-wm1-x335.google.com with SMTP id i203-20020a1c3bd4000000b003b3df9a5ecbso721678wma.1 for ; Wed, 28 Sep 2022 01:40:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date; bh=KCC6cs+b2XAgvvY+55tJ5u+kTRzBAEoEey6zMqqAl9I=; b=TAfiestO4p8i9qK6CSk/Ce9vR9wMZpxIn1nOu8f+0TTlXeKT60n9m5s6gwpF8T+UsK dGb/NUm68hd9JuSNrMfEqQ3CRvkdpG6RNDRwklZbWvmCRNRt/IZAFrKlgIdLyNYZZSFq WyVrNnPYDAOEndyqRjnHoqAT4H+rkphp8vbx/mSMj0+9m7CrHG5vjDhZXRaV2Xme4U0g PI7+0Ivpv2+RhmvZ6zlwqgANzZmi+kFzii+ADhHs+yEUFrtwefXljH1+Ah24B89n6bVB YSr3wMAlAg6HM7d4zWfbvMcMCy/ItjobZ/6h2F7++avt50a5zvGII0OrpAo/S/7Ele6J fJbA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date; bh=KCC6cs+b2XAgvvY+55tJ5u+kTRzBAEoEey6zMqqAl9I=; b=cBsUgvhnI35uyidqiiisMidvN/LSOj2L/3NExYqvuYe+6xvANPuLuYI8GVDrsC8kh/ VuTWbRHZfOqVWL3g1t4PXDNiVWKGKJJCgrUZb08IHGjzZA9p9nU6gX9rAXCp0Bp9SPpN Kq4MlbTv7fE9pvM3mL3k6vJ4aY67MDHMQTBOGrQy767fX5qS9YKaSmNIZN//6if8XrXt hq8oNe7LnYiWDo6fCE0ALEmJ5/JeKf0doJ90+kA9lHNaSP77SzGCYjto4NR/vItLeROY JyH3PCHQm9SSVrCnHiH3TpsxBeQvICGcZYGnNjaj5OJduLVwihlauWCVO9kkQK5XTgjK e7oQ== X-Gm-Message-State: ACrzQf2OrscYdVagFPMxma0B3f8Bb0oDCPwfsYd37UHu0RLQ9TJDVcJO W0CsSNMZPx4DTq/KtJHTqC8oM0hYCISs+g== X-Google-Smtp-Source: AMsMyM6lvjeMrvu3DDOfrDZbYtdiWYbjOBkUcsnLION9weO/JoMy9++kLqxjnosKKlGV9FKF7a1r7Q== X-Received: by 2002:a05:600c:3511:b0:3b4:bb85:f1dd with SMTP id h17-20020a05600c351100b003b4bb85f1ddmr5986963wmq.42.1664354412308; Wed, 28 Sep 2022 01:40:12 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id 26-20020a05600c229a00b003b31fc77407sm1075026wmf.30.2022.09.28.01.40.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 28 Sep 2022 01:40:11 -0700 (PDT) From: =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= To: git@vger.kernel.org Cc: Junio C Hamano , Victoria Dye , Taylor Blau , Emily Shaffer , Jonathan Nieder , John Cai , =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= Subject: [PATCH v2 34/35] tests: start asserting that *.txt SYNOPSIS matches -h output Date: Wed, 28 Sep 2022 10:39:29 +0200 Message-Id: X-Mailer: git-send-email 2.38.0.rc1.925.gb61c5ccd7da In-Reply-To: References: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org There's been a lot of incremental effort to make the SYNOPSIS output in our documentation consistent with the -h output, e.g. cbe485298bf (git reflog [expire|delete]: make -h output consistent with SYNOPSIS, 2022-03-17) is one recent example, but that effort has been an uphill battle due to the lack of regression testing. This adds such regression testing, we can parse out the SYNOPSIS output with "sed", and is turns out it's relatively easy to normalize it and the "-h" output to match on another. We now ensure that we won't have regressions when it comes to the list of commands in "expect_help_to_match_txt" below, and in subsequent commits we'll make more of them consistent. The naïve parser here gets quite a few things wrong, but it doesn't need to be perfect, just good enough that we can compare /some/ of this help output. There's no cases where the output would match except for the parser's stupidity, it's all cases of e.g. comparing the *.txt to non-parse_options() output. Since that output is wildly different than the *.txt anyway let's leave this for now, we can fix the parser some other time, or it won't become necessary as we'll e.g. convert more things to using parse_options(). Having a special-case for "merge-tree"'s 1f0c3a29da3 (merge-tree: implement real merges, 2022-06-18) is a bit ugly, but preferred to blessing that " (deprecated)" pattern for other commands. We'd probably want to add some other way of marking deprecated commands in the SYNOPSIS syntax. Syntactically 1f0c3a29da3's way of doing it is indistinguishable from the command taking an optional literal "deprecated" string as an argument. Some of the issues that are left: * "git show -h", "git whatchanged -h" and "git reflog --oneline -h" all showing "git log" and "git show" usage output. I.e. the "builtin_log_usage" in builtin/log.c doesn't take into account what command we're running. * Likewise "git stage -h" shows "git add" usage, but should be aware of what command it's running. The same for "annotate" and "blame". * Commands which implement subcommands such as like "multi-pack-index", "notes", "remote" etc. having their subcommands in a very different order in the *.txt and *.c. Fixing it would require some verbose diffs, so it's been left alone for onw. * Commands such as "format-patch" have a very long argument list in the *.txt, but just "[]" in the *.c. What to do about these has been left out of this series, except to the extent that preceding commits changed "[]" (or equivalent) to the list of options in cases where that list of options was tiny, or we clearly meant to exhaustively list the options in both *.txt and *.c. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/CodingGuidelines | 3 +- t/t0450-txt-doc-vs-help.sh | 184 +++++++++++++++++++++++++++++++++ 2 files changed, 186 insertions(+), 1 deletion(-) create mode 100755 t/t0450-txt-doc-vs-help.sh diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 3d3bdeba9e4..4b10e832752 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -634,7 +634,8 @@ Writing Documentation: A few commented examples follow to provide reference when writing or modifying command usage strings and synopsis sections in the manual - pages: + pages. The two should match, see t/t0450-txt-doc-vs-help.sh for + (partial) regression testing. Placeholders are spelled in lowercase and enclosed in angle brackets: diff --git a/t/t0450-txt-doc-vs-help.sh b/t/t0450-txt-doc-vs-help.sh new file mode 100755 index 00000000000..9b1c70ef40c --- /dev/null +++ b/t/t0450-txt-doc-vs-help.sh @@ -0,0 +1,184 @@ +#!/bin/sh + +test_description='compare (unbuilt) Documentation/*.txt to -h output + +Run this with --debug to see a summary of where we still fail to make +the two versions consistent with one another.' + +. ./test-lib.sh + +test_expect_success 'setup: list of builtins' ' + git --list-cmds=builtins >builtins +' + +test_expect_success 'setup: list of txt v.s. help' ' + cat >list <<-\EOF + add + am + apply + archive + bisect + blame + branch + check-ref-format + checkout + checkout-index + clone + column + config + credential + credential-cache + credential-store + fast-export + fast-import + fetch-pack + fmt-merge-msg + for-each-ref + format-patch + fsck-objects + fsmonitor--daemon + gc + grep + index-pack + init-db + log + ls-files + ls-tree + mailinfo + mailsplit + maintenance + merge + merge-file + merge-index + merge-one-file + multi-pack-index + name-rev + notes + pack-objects + push + range-diff + rebase + remote + remote-ext + remote-fd + repack + reset + restore + rev-parse + show + stage + switch + update-index + update-ref + whatchanged + EOF +' + +test_expect_success 'setup: list of txt v.s. help is sorted' ' + sort -u list >list.sorted && + if ! test_cmp list list.sorted + then + BUG "please keep the command list sorted" + fi +' + +builtin_to_synopsis () { + builtin="$1" && + test_when_finished "rm -f out" && + test_expect_code 129 git $builtin -h >out 2>&1 && + sed -n \ + -e '1,/^$/ { + /^$/d; + s/^usage: //; + s/^ *or: //; + p; + }' failing' +while read builtin +do + test_expect_success "$builtin -h output has no \t" ' + builtin_to_synopsis "$builtin" >help.raw && + ! grep "$HT" help.raw + ' + + txt="$(builtin_to_txt "$builtin")" && + preq="$(echo BUILTIN_TXT_$builtin | tr '[:lower:]-' '[:upper:]_')" && + + if test -f "$txt" + then + test_set_prereq "$preq" + fi && + + result= + if grep -q "^$builtin$" list + then + result=failure + else + result=success + fi && + + test_expect_$result "$preq" "$builtin -h output and SYNOPSIS agree" ' + txt_synopsis "$txt" >txt.raw && + if test "$builtin" = "merge-tree" + then + sed -e '\''s/ (deprecated)$//g'\'' txt.raw.new && + mv txt.raw.new txt.raw + fi && + builtin_to_synopsis "$builtin" >help.raw && + + # The *.txt and -h use different spacing for the + # alignment of continued usage output, normalize it. + align_after_nl "$builtin" txt && + align_after_nl "$builtin" help && + test_cmp txt help + ' + + if test_have_prereq "$preq" && test -e txt && test -e help + then + test_debug ' + if test_cmp txt help >cmp 2>/dev/null + then + echo "=== DONE: $builtin ===" + else + echo "=== TODO: $builtin ===" && + cat cmp + fi >>failing + ' + + # Not in test_expect_success in case --run is being + # used with --debug + rm -f txt help tmp 2>/dev/null + fi +done