From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id j5lZOnzHbmFceAAAWB0awg (envelope-from ) for ; Tue, 19 Oct 2021 09:26:20 -0400 Received: by simark.ca (Postfix, from userid 112) id DB9891F0BD; Tue, 19 Oct 2021 09:26:20 -0400 (EDT) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on simark.ca X-Spam-Level: X-Spam-Status: No, score=-2.0 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,MAILING_LIST_MULTI,NICE_REPLY_A,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.2 Received: from sourceware.org (server2.sourceware.org [8.43.85.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by simark.ca (Postfix) with ESMTPS id F1D721E79C for ; Tue, 19 Oct 2021 09:26:19 -0400 (EDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 956AA385801A for ; Tue, 19 Oct 2021 13:26:19 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 956AA385801A DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1634649979; bh=rBUvPrJ53W00mb7FbE2vMQpV9jVVb9YShEFGOgf/yJE=; h=Date:Subject:To:References:In-Reply-To:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To: From; b=dlZgK3ZKfDll9qqI4my8h56LyKxNQDaKtGq0c74rrrHUMmmCEI/GWQ0i842roo3ac L0XucWvBCmPMlu4xI4OTf9VY3wv90HNktInSAfRcVBxHFP4vMvfmyY5UUcYRa2pCoE GglCyS71SMUZb8QrVgkXC2V1O2q28toq/Zc83CtA= Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id 4838F3858033 for ; Tue, 19 Oct 2021 13:24:49 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 4838F3858033 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-580-QwxUpPEON-KQdrncu7G65Q-1; Tue, 19 Oct 2021 09:24:43 -0400 X-MC-Unique: QwxUpPEON-KQdrncu7G65Q-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id C5582DF8A0; Tue, 19 Oct 2021 13:24:41 +0000 (UTC) Received: from [10.97.116.118] (ovpn-116-118.gru2.redhat.com [10.97.116.118]) by smtp.corp.redhat.com (Postfix) with ESMTPS id DA97519730; Tue, 19 Oct 2021 13:24:38 +0000 (UTC) Message-ID: <9c0d3c63-e5d3-cb02-f952-578a4a1caa4e@redhat.com> Date: Tue, 19 Oct 2021 10:24:33 -0300 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.2.0 Subject: Re: [PATCH] [gdb/doc]: Updated manpages to be consistent with help To: Philippe Waroquiers , Sergio Durigan Junior , Bruno Larsen via Gdb-patches References: <20211013130409.10711-1-blarsen@redhat.com> <87czo96iyv.fsf@paluero> <8cd51cc0-3ca2-b1ae-e608-82a7cac10bcc@redhat.com> <97db0ebc9dedf0dd9a75ac32be57d1f689a21083.camel@skynet.be> <68a1c4c5-e399-3f45-dee6-c1f239815354@redhat.com> In-Reply-To: X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: Bruno Larsen via Gdb-patches Reply-To: Bruno Larsen Errors-To: gdb-patches-bounces+public-inbox=simark.ca@sourceware.org Sender: "Gdb-patches" On 10/16/21 08:44, Philippe Waroquiers wrote: > On Fri, 2021-10-15 at 10:27 -0300, Bruno Larsen wrote: >> On 10/14/21 15:56, Philippe Waroquiers wrote: >>> Note that I started a patch to have the options consistently using -- >>> >>> But as GDB accepts various layout for options (such as -thisone or --thisone), >>> it was not very clear it that was a good thing to do. >>> Pedro e.g. commented that GDB does not use the concept of 'short' and 'long' options. >>> >>> Finally, as I understand, the decision was rather to use as cannnical form >>>    -thisone >>>   (in the doc and on line help) >>> and so the manual should then also be aligned. >>> >>> Sadly, I had no time to finalize the patch (i.e. to rather systematically use >>> the single dash convention). >>> But this patch seems then not to go into what I think is the last agreed direction. >>> >>> See the initial RFC in >>> https://sourceware.org/pipermail/gdb-patches/2021-June/179587.html >>> and RFA in >>> https://sourceware.org/pipermail/gdb-patches/2021-June/179834.html >>> >>> Thanks >>> Philippe >>> >> >> Hi! I didn't see this patch when writing my own, sorry. >> >> As for not going the agreed direction, it didn't sounds "agreed" to me, since Eli agreed with documenting '--' while Pedro preferred '-'. I agree with the argument that GDB doesn't accept short options, since you can't combine them, but the help page still shows the abbreviated versions with a single dash and longer versions with '--' and that causes confusion for users. What the patches are supposed to do is make those 2 pages consistent and avoid user confusion, keeping them as-is because the developers know it makes more sense doesn't fix confusion. >> >> My proposed solution is: Let's make them consistent with help, all longer options having '--', use your text explaining that GDB accepts all 8 versions of options despite how they are written, but change it to call "abbreviated" and "longer" options instead, to avoid the "short option" confusion that Pedro has brought up. Does that sound reasonable? >> > > See also the feedback of Joel. > https://sourceware.org/pipermail/gdb-patches/2021-August/181294.html > > Philippe > > Having looked at that e-mail, I think the new version is conforming to the agreed direction of documenting that GDB doesn't care about - or --, but still document it as traditional argument handling does: https://sourceware.org/pipermail/gdb-patches/2021-October/182632.html Thanks for the resources and for looking at the patch -- Cheers! Bruno Larsen