From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id xSXtJw4eAWLXMQAAWB0awg (envelope-from ) for ; Mon, 07 Feb 2022 08:26:38 -0500 Received: by simark.ca (Postfix, from userid 112) id 90BE41F3C6; Mon, 7 Feb 2022 08:26:38 -0500 (EST) 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=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,RDNS_DYNAMIC,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.2 Received: from sourceware.org (ip-8-43-85-97.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 2205E1EE1A for ; Mon, 7 Feb 2022 08:26:38 -0500 (EST) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 627513858412 for ; Mon, 7 Feb 2022 13:26:37 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 627513858412 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1644240397; bh=FaKGmiHvbBUImpVttGd3GUaMc3YolCPevmVpfwkZO84=; h=Date:To:In-Reply-To:Subject:References:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=K95q9WK+PqPzm4CgYKWB7yT6lZW7fDXRVTJ9CF3dwZmZxCJJUt3nmal1EWgtHrDsv ThhFMgfu+T0/itTAdNtm10oueETPYMxkWsaHGip6z7R6fyMce/AuSCxD8be4wPyaQB 836ekgUXYnRGLOTwzMJkEo2zaCL04vkU4/+EfOZo= Received: from eggs.gnu.org (eggs.gnu.org [209.51.188.92]) by sourceware.org (Postfix) with ESMTPS id DBF7A3858D20 for ; Mon, 7 Feb 2022 13:26:18 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org DBF7A3858D20 Received: from [2001:470:142:3::e] (port=50328 helo=fencepost.gnu.org) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nH41c-00036u-7r; Mon, 07 Feb 2022 08:25:48 -0500 Received: from [87.69.77.57] (port=3007 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nH41F-0002RQ-NX; Mon, 07 Feb 2022 08:25:27 -0500 Date: Mon, 07 Feb 2022 15:25:12 +0200 Message-Id: <83iltqyfk7.fsf@gnu.org> To: Andrew Burgess In-Reply-To: <20220207100533.GE2706@redhat.com> (message from Andrew Burgess on Mon, 7 Feb 2022 10:05:33 +0000) Subject: Re: [PATCH] gdb/python: allow Value.format_string to return styled output References: <20220125105005.333575-1-aburgess@redhat.com> <20220125160730.GA425591@redhat.com> <20220125172733.GB425591@redhat.com> <20220207100533.GE2706@redhat.com> 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: Eli Zaretskii via Gdb-patches Reply-To: Eli Zaretskii Cc: gdb-patches@sourceware.org Errors-To: gdb-patches-bounces+public-inbox=simark.ca@sourceware.org Sender: "Gdb-patches" > Date: Mon, 7 Feb 2022 10:05:33 +0000 > From: Andrew Burgess > Cc: gdb-patches@sourceware.org > > Hi Eli, > > Didn't know if you wanted to give this patch a docs review or not. Sorry I missed that. > > +@item styling > > +@code{True} if @value{GDBN} should apply styling to the returned > > +string. When styling is applied, the returned string might contain > > +ANSI terminal escape sequences. Escape sequences will only be > > +included if styling is turned on, @xref{Output Styling}. ^^^^^ Please use "@pxref" or "see @ref" here. @xref produces a capitalized "Note", which is not appropriate in the middle of a sentence. The documentation parts are OK with that nit fixed.