From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 64509 invoked by alias); 18 Apr 2016 20:32:12 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 64493 invoked by uid 89); 18 Apr 2016 20:32:11 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.9 required=5.0 tests=BAYES_00,RP_MATCHES_RCVD,SPF_HELO_PASS autolearn=ham version=3.3.2 spammy=Hx-languages-length:1311 X-HELO: mx1.redhat.com Received: from mx1.redhat.com (HELO mx1.redhat.com) (209.132.183.28) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES256-GCM-SHA384 encrypted) ESMTPS; Mon, 18 Apr 2016 20:32:01 +0000 Received: from int-mx10.intmail.prod.int.phx2.redhat.com (int-mx10.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 5E4FE85367; Mon, 18 Apr 2016 20:32:00 +0000 (UTC) Received: from [127.0.0.1] (ovpn01.gateway.prod.ext.phx2.redhat.com [10.5.9.1]) by int-mx10.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u3IKVwti015893; Mon, 18 Apr 2016 16:31:59 -0400 Subject: Re: [PATCH 2/3] deprecate "skip enable/etc.", doc string cleanup To: Doug Evans , Eli Zaretskii References: <047d7bdc05e2ada5ef0530c446d1@google.com> <83zisq923i.fsf@gnu.org> <83potm8zj2.fsf@gnu.org> Cc: gdb-patches From: Pedro Alves Message-ID: <5715443E.7010404@redhat.com> Date: Mon, 18 Apr 2016 20:32:00 -0000 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.7.1 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-SW-Source: 2016-04/txt/msg00425.txt.bz2 On 04/18/2016 09:01 PM, Doug Evans wrote: > On Mon, Apr 18, 2016 at 12:53 PM, Eli Zaretskii wrote: >>> From: Doug Evans >>> Date: Mon, 18 Apr 2016 12:42:04 -0700 >>> Cc: gdb-patches >>> >>> I certainly don't want to replicate all that text again >>> and again (hence the macros). >> >> I understand, but put yourself in the position of someone who needs to >> review a patch, and sees something like this: >> >> +Display the status of skips.\n" >> +EDDI_USAGE_DOC_STRING_WITH_ALL ("skip", "info skip", "displayed"))); >> >> How does that someone know if the resulting text is good English and >> will produce a clear help text, or needs to be fixed in some way? > > I'm open to suggestions. > > I really hope the solution is to not expand all those macro > invocations in place. > I think the answer is to include the before/after GDB output in the mail submission / git log. We actually already ask for that in the contribution checklist [1]: "If you're changing the output of some command, include a paste of the relevant parts of gdb session, before and after the change." [1] - https://sourceware.org/gdb/wiki/ContributionChecklist#General_requirements Thanks, Pedro Alves