From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 5992 invoked by alias); 11 Jul 2019 13:12:21 -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 5981 invoked by uid 89); 11 Jul 2019 13:12:20 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-6.9 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_NONE,SPF_HELO_PASS autolearn=ham version=3.3.1 spammy=party, HX-Languages-Length:1397 X-HELO: gateway20.websitewelcome.com Received: from gateway20.websitewelcome.com (HELO gateway20.websitewelcome.com) (192.185.44.20) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 11 Jul 2019 13:12:15 +0000 Received: from cm13.websitewelcome.com (cm13.websitewelcome.com [100.42.49.6]) by gateway20.websitewelcome.com (Postfix) with ESMTP id 57B62400CCA35 for ; Thu, 11 Jul 2019 07:09:41 -0500 (CDT) Received: from box5379.bluehost.com ([162.241.216.53]) by cmsmtp with SMTP id lYrthxCjsYTGMlYrthoffY; Thu, 11 Jul 2019 08:12:13 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=tromey.com; s=default; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date: References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=D0xFw9dIM49ckuoTFL5B0SDNSME84EBBLSngby7Go0Q=; b=O3v9Jql2yE86pqfH43qrrcltE/ QldmMDwX6SEGKA+MGUFFe88Xxrb6Oa58VMsJbO4OnZeL25j1HeP6WbAV9XyZXy0G4DHwb10VKAijn VRuNv9WbLjg2EspiEIUJ2tI9l; Received: from 97-122-178-82.hlrn.qwest.net ([97.122.178.82]:53208 helo=murgatroyd) by box5379.bluehost.com with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92) (envelope-from ) id 1hlYrt-0048BH-FI; Thu, 11 Jul 2019 08:12:13 -0500 From: Tom Tromey To: Pedro Alves Cc: Tom Tromey , Philippe Waroquiers , gdb-patches@sourceware.org Subject: Re: [RFA] Make first and last lines of 'command help documentation' consistent. References: <20190616195804.9427-1-philippe.waroquiers@skynet.be> <874l3tg6vh.fsf@tromey.com> <1562797898.1521.10.camel@skynet.be> <87y314bw0x.fsf@tromey.com> Date: Thu, 11 Jul 2019 13:12:00 -0000 In-Reply-To: (Pedro Alves's message of "Thu, 11 Jul 2019 13:53:31 +0100") Message-ID: <87tvbsbtqr.fsf@tromey.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.1 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-SW-Source: 2019-07/txt/msg00294.txt.bz2 >>>>> "Pedro" == Pedro Alves writes: Pedro> 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. Pedro> Could this be a warning at command-registration-time instead? That Pedro> way you would see if as soon as the command is registered. And it'd Pedro> be hard to introduce a regression with build-in commands since Pedro> everyone would start seeing a warning. Where I was coming from is that this is a pretty minor cosmetic issue; and while it makes sense for gdb to follow this rule, it isn't worth it for 3rd party commands. So, we should test gdb itself to avoid problems here, but ignore problems coming from elsewhere. I don't feel super strongly about it. Tom