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.8 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,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 4A08C1F51E for ; Fri, 30 Sep 2022 17:09:20 +0000 (UTC) Authentication-Results: dcvr.yhbt.net; dkim=pass (1024-bit key; unprotected) header.d=pobox.com header.i=@pobox.com header.b="ZWMYbyof"; dkim-atps=neutral Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231579AbiI3RJP (ORCPT ); Fri, 30 Sep 2022 13:09:15 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50590 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229779AbiI3RJM (ORCPT ); Fri, 30 Sep 2022 13:09:12 -0400 Received: from pb-smtp2.pobox.com (pb-smtp2.pobox.com [64.147.108.71]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9110B114023 for ; Fri, 30 Sep 2022 10:09:11 -0700 (PDT) Received: from pb-smtp2.pobox.com (unknown [127.0.0.1]) by pb-smtp2.pobox.com (Postfix) with ESMTP id 3D86715BEF2; Fri, 30 Sep 2022 13:09:10 -0400 (EDT) (envelope-from junio@pobox.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed; d=pobox.com; h=from:to:cc :subject:references:date:message-id:mime-version:content-type :content-transfer-encoding; s=sasl; bh=OAIX/fvBCgUVtkNvkUZ2WzYiU zMs4/IxvD7gwNaLZf0=; b=ZWMYbyofbH1EDksAoMVMLaSeeKMMMvyQ5wzdW4WH1 KxknLlt3VVLTuxbkWswwdJF4C0rmaGJUql7sXYkbXN5iEqKfEBqlkhv8n4aCMeAW BdPUgsIneEzfEFN5AcYMUj9+r4ed1Eu2RZLwFmOYsakR636UpSfd+JdrBJTiZM7u +U= Received: from pb-smtp2.nyi.icgroup.com (unknown [127.0.0.1]) by pb-smtp2.pobox.com (Postfix) with ESMTP id 354C915BEF1; Fri, 30 Sep 2022 13:09:10 -0400 (EDT) (envelope-from junio@pobox.com) Received: from pobox.com (unknown [34.83.5.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by pb-smtp2.pobox.com (Postfix) with ESMTPSA id 9317415BEF0; Fri, 30 Sep 2022 13:09:09 -0400 (EDT) (envelope-from junio@pobox.com) From: Junio C Hamano To: =?utf-8?B?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason Cc: git@vger.kernel.org, Victoria Dye , Taylor Blau , Emily Shaffer , Jonathan Nieder , John Cai Subject: Re: [PATCH v2 01/35] CodingGuidelines: update and clarify command-line conventions References: Date: Fri, 30 Sep 2022 10:09:08 -0700 Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.1 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 X-Pobox-Relay-ID: 993F9886-40E2-11ED-BD98-307A8E0A682E-77302942!pb-smtp2.pobox.com Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Junio C Hamano writes: > =C3=86var Arnfj=C3=B6r=C3=B0 Bjarmason writes: > >> Optional parts are enclosed in square brackets: >> - [] >> - (Zero or one .) >> + [...] >> + (Zero or more of .) > > OK. > >> + Use spacing around "|" token(s), but not immediately after opening o= r >> + before closing a [] or () pair: >> + Do: [-q | --quiet] >> + Don't: [-q|--quiet] >> + >> + Don't use spacing around "|" tokens when they're used to seperate th= e >> + alternate arguments of an option: >> + Do: --track[=3D(direct|inherit)] >> + Don't: --track[=3D(direct | inherit)] >> + > > Hmph, that sounds inconsistent; I would have expected the same use > (or omission) of space around the vertical bar. But if that is the > prevailing style, I won't complain about writing it down. Perhaps in order to avoid "Huh? isn't that inconsistent?" knee-jerk reaction, it may be a good idea to explain the reason why? I am guessing that the difference between the two has something to do with the desire to make it compact when it appears as a "value" for something (signalled after a "=3D" sign), but (1) I am not sure if you share the reasoning, and more importantly (2) I am failing to come up with a concise way to phrase it. Thanks.