From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 113510 invoked by alias); 11 Jul 2019 12:53:36 -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 113502 invoked by uid 89); 11 Jul 2019 12:53:36 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-1.9 required=5.0 tests=BAYES_00,RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 spammy= X-HELO: mail-wm1-f41.google.com Received: from mail-wm1-f41.google.com (HELO mail-wm1-f41.google.com) (209.85.128.41) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 11 Jul 2019 12:53:34 +0000 Received: by mail-wm1-f41.google.com with SMTP id 207so5589839wma.1 for ; Thu, 11 Jul 2019 05:53:34 -0700 (PDT) Return-Path: Received: from ?IPv6:2001:8a0:f913:f700:56ee:75ff:fe8d:232b? ([2001:8a0:f913:f700:56ee:75ff:fe8d:232b]) by smtp.gmail.com with ESMTPSA id x18sm5222151wmi.12.2019.07.11.05.53.31 (version=TLS1_3 cipher=AEAD-AES128-GCM-SHA256 bits=128/128); Thu, 11 Jul 2019 05:53:32 -0700 (PDT) Subject: Re: [RFA] Make first and last lines of 'command help documentation' consistent. To: Tom Tromey , Philippe Waroquiers References: <20190616195804.9427-1-philippe.waroquiers@skynet.be> <874l3tg6vh.fsf@tromey.com> <1562797898.1521.10.camel@skynet.be> <87y314bw0x.fsf@tromey.com> Cc: gdb-patches@sourceware.org From: Pedro Alves Message-ID: Date: Thu, 11 Jul 2019 12:53:00 -0000 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.2.1 MIME-Version: 1.0 In-Reply-To: <87y314bw0x.fsf@tromey.com> Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-SW-Source: 2019-07/txt/msg00293.txt.bz2 On 7/11/19 1:22 PM, Tom Tromey wrote: >>>>>> "Philippe" == Philippe Waroquiers writes: > >>> I think this can't be an assertion, because user commands could hit it, >>> and that seems too harsh; but could it be a unit test? That might be >>> better than printing something magic, especially since IIUC the user can >>> end up seeing this stuff. > > Philippe> Effectively, the user can end up seeing this, but only if the GDB test > Philippe> was not run and/or was not fixed. > > Or if there is any command written in Python or Guile that has a newline > at the end of its help text. These commands can be supplied any number > of ways. Could this be a warning at command-registration-time instead? That way you would see if as soon as the command is registered. And it'd be hard to introduce a regression with build-in commands since everyone would start seeing a warning. Thanks, Pedro Alves