From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS3215 2.6.0.0/16 X-Spam-Status: No, score=-3.4 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE, SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from out1.vger.email (out1.vger.email [IPv6:2620:137:e000::1:20]) by dcvr.yhbt.net (Postfix) with ESMTP id 5B8ED1F51F for ; Fri, 30 Sep 2022 18:09:39 +0000 (UTC) Authentication-Results: dcvr.yhbt.net; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="kKCLXfqH"; dkim-atps=neutral Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231767AbiI3SIQ (ORCPT ); Fri, 30 Sep 2022 14:08:16 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60990 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231808AbiI3SIO (ORCPT ); Fri, 30 Sep 2022 14:08:14 -0400 Received: from mail-wr1-x435.google.com (mail-wr1-x435.google.com [IPv6:2a00:1450:4864:20::435]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 27B1C1E2FF2 for ; Fri, 30 Sep 2022 11:08:09 -0700 (PDT) Received: by mail-wr1-x435.google.com with SMTP id h7so7976617wru.10 for ; Fri, 30 Sep 2022 11:08:09 -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=DuMOpHooTuYNQ5Cz0ZA9yyN1+mhYkif/IXAazSinc/g=; b=kKCLXfqHVSAdI/3Wbs3eUTLOsc+aTvCgFazWNWAz3fE48Heybkx/zT2bqEdOqdjSyL uBjnR/FK+24WwxcEA6/JzbWhV98jjllolMLQY28VJXq8Atco8qsRNBl5cxao7aCwlOn/ EXTXeKkhXjPK9QHPHENqeKU3v3Ehm01xZtoTtCWVjgihj33JB8my1To2v7BTGSaHTCb4 zW4g4FEBDBC2EW4vJ3bvKU++Nmr4vpoPs2sMc/q6BRNKsHudc25wlMo3pyz8SIjVblOz hkaOgV2FtrYfELp4m/mhFCZ9iEG+NpZlTqaWCstrn0kdkyIfR33H6dgVoZNQ7HnsYR8M us2w== 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=DuMOpHooTuYNQ5Cz0ZA9yyN1+mhYkif/IXAazSinc/g=; b=WgYBcDD8jVYV0TQ4dsgaYeUUBdfTXZ19CDMSr71NqOdOJ2QAhgYMG4yEc6GYiUTXLL hi08PwCpuTGN3VZEjGovPIkVME4aWlgdXk3aGhKPD45rY5OrCoJklKnxe13h3yjfY/b4 8bLNnvramCAoHhhRsjYfEYlEdTmszGpjnRyzFjRzaOLT8ckK/YLrfku5J9e3zc0N05Sb 5/UOhFU7PL7Zv6xJWUoZ/bpXZdcgzVyYYWOzFvwSB66qkzP9wSyYwI5itv5EDO9qSN5f dzOWVAo7L9e4T84rtl7TRgQofqksjB5C8SHwGGlChw4r7nPtV34SVraPfP8Rg98btEf9 2nQw== X-Gm-Message-State: ACrzQf3VCahrTD46ra23s8U75T9UzoySm577jK4Ut7e7vQH7UcJ7FRi1 dx7DOaoRPDKxSyUhb62PUyhWq0P9nnzYpw== X-Google-Smtp-Source: AMsMyM7a7MiiiGNAROcMGHKFm418R9vvvN0EOw+bXR/Lph5cmoDor46jCEaM80sCEK5gEvXTqdd17g== X-Received: by 2002:a5d:4a01:0:b0:21d:8ce1:8b6d with SMTP id m1-20020a5d4a01000000b0021d8ce18b6dmr6595054wrq.718.1664561286921; Fri, 30 Sep 2022 11:08:06 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id h9-20020a1c2109000000b003b4fac020c8sm7102703wmh.16.2022.09.30.11.08.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 30 Sep 2022 11:08:02 -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 , Eric Sunshine , =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= Subject: [PATCH v3 00/36] doc/UX: make txt & -h output more consistent Date: Fri, 30 Sep 2022 20:07:23 +0200 Message-Id: X-Mailer: git-send-email 2.38.0.rc2.935.g6b421ae1592 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 We are currently wildly inconsistent in whether the SYNOPSIS in the manual page matches the first line of the -h output, and as we add new options we routinely forget to add them to one or the other (or both). Without a more complex approach it's hard to do something about the "or both" case. But we can rather easily test whether the -h output matches the *.txt version, and report differences. As this series shows that allows us to fix a lot of issues we've effectively already "fixed", we just fixed them in one version, but not the other. For the rest of the general overview (the first paragraphs are copy/pasted) see the v1 at: https://lore.kernel.org/git/cover-00.34-00000000000-20220902T092734Z-avarab@gmail.com/; For v2 see: https://lore.kernel.org/git/cover-v2-00.35-00000000000-20220928T082458Z-avarab@gmail.com/ Changes since v2: * Numerous issues raised by Eric Sunshine, thanks a lot! I believe this re-roll addresses all of them. * The 1/36 commit message attempts to explain the --foo=(x|y) v.s. (--foo | --bar) whitespace inconsistency. * The list of command mismatches is now a file at t/t0450/txt-help-mismatches, instead of being embedded in the test (per Junio's request). Ævar Arnfjörð Bjarmason (36): CodingGuidelines: update and clarify command-line conventions builtin/bundle.c: indent with tabs bundle: define subcommand -h in terms of command -h blame: use a more detailed usage_msg_optf() error on bad -L doc SYNOPSIS: don't use ' for subcommands doc SYNOPSIS: consistently use ' for commands doc SYNOPSIS & -h: fix incorrect alternates syntax built-ins: consistently add "\n" between "usage" and options doc SYNOPSIS & -h: word-wrap doc txt & -h consistency: word-wrap doc txt & -h consistency: fix incorrect alternates syntax doc txt & -h consistency: add "-z" to cat-file "-h" doc txt & -h consistency: balance unbalanced "[" and "]" doc txt & -h consistency: correct padding around "[]()" stash doc SYNOPSIS & -h: correct padding around "[]()" doc txt & -h consistency: use "", not "..." t/helper/test-proc-receive.c: use "", not "..." doc txt & -h consistency: fix mismatching labels doc txt & -h consistency: add or fix optional "--" syntax doc txt & -h consistency: make output order consistent doc txt & -h consistency: add missing options and labels doc txt & -h consistency: make "rerere" consistent doc txt & -h consistency: make "read-tree" consistent doc txt & -h consistency: make "bundle" consistent doc txt & -h consistency: use "git foo" form, not "git-foo" doc txt & -h consistency: add missing options doc txt & -h consistency: make "stash" consistent doc txt & -h consistency: make "annotate" consistent doc txt & -h consistency: use "[