Message ID | BX1R9QPBILBP.3TZ1WKSD70F13@carl-T440p |
---|---|
State | New, archived |
Headers |
Received: (qmail 34393 invoked by alias); 16 Sep 2019 21:47:50 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: <gdb-patches.sourceware.org> List-Unsubscribe: <mailto:gdb-patches-unsubscribe-##L=##H@sourceware.org> List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org> List-Archive: <http://sourceware.org/ml/gdb-patches/> List-Post: <mailto:gdb-patches@sourceware.org> List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs> Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 34385 invoked by uid 89); 16 Sep 2019 21:47:50 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-26.9 required=5.0 tests=BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3, RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 spammy=H*r:sk:mailrel X-HELO: mailrelay1-2.pub.mailoutpod1-cph3.one.com Received: from mailrelay1-2.pub.mailoutpod1-cph3.one.com (HELO mailrelay1-2.pub.mailoutpod1-cph3.one.com) (46.30.212.0) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Mon, 16 Sep 2019 21:47:47 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bordum.dk; s=20140924; h=message-id:to:from:subject:date:content-type:content-transfer-encoding:from; bh=2LkxChZiFYg//nvSujsYNH++FRW9xB+daUHg72JuREE=; b=xDdpHp6pOLqqGZzRozwDvYYs79zc2aqU8Y8LQDRSyX9u4PC3/j3fQ3AoUWS2QHtpVdJBOQwWUcq+T rGexBt1fGGD6P+3D638nNlV5KISIWkLlNv+MCBnicUCbvbu0sFFx1ke5FEYhSt+Z6utvVQvsV2bBZZ x0SYSeT06o1xwKvI= X-HalOne-Cookie: b5d09dd0c34f9a75211365a6c73a4eed76aca368 X-HalOne-ID: 9d5d64f5-d8cb-11e9-aee4-d0431ea8a283 Received: from localhost (unknown [2.104.151.248]) by mailrelay1.pub.mailoutpod1-cph3.one.com (Halon) with ESMTPSA id 9d5d64f5-d8cb-11e9-aee4-d0431ea8a283; Mon, 16 Sep 2019 21:47:44 +0000 (UTC) Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=UTF-8 Date: Mon, 16 Sep 2019 23:47:44 +0200 Subject: [PATCH] gdb docs: do not format the ++ in C++ in man page From: "Carl Bordum Hansen" <carl@bordum.dk> To: <gdb-patches@sourceware.org> Message-Id: <BX1R9QPBILBP.3TZ1WKSD70F13@carl-T440p> |
Commit Message
Carl Bordum Hansen
Sept. 16, 2019, 9:47 p.m. UTC
This change means that the html version of the man page does not stylize the "++" in the third paragraph. (https://sourceware.org/gdb/current/onlinedocs/gdb/gdb-man.html). The tradeoff is, in my opinion, worth it as the man page reads better, since it is now formatted properly. Before this change, it read as: "... programs written in C, C@t{++}, ...". --- Hello, this is my first patch to a GNU project ever and also the first time I use an email-based git workflow, so please excuse my mistakes :-) gdb/doc/gdb.texinfo | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Comments
On 2019-09-16 5:47 p.m., Carl Bordum Hansen wrote: > This change means that the html version of the man page does not stylize > the "++" in the third paragraph. > (https://sourceware.org/gdb/current/onlinedocs/gdb/gdb-man.html). The > tradeoff is, in my opinion, worth it as the man page reads better, since > it is now formatted properly. Before this change, it read as: > "... programs written in C, C@t{++}, ...". > --- > > Hello, this is my first patch to a GNU project ever and also the first time I > use an email-based git workflow, so please excuse my mistakes :-) Hi Carl, Thanks for your patches. I see you've used git-send-email, that's excellent. Like I said on IRC, I think the best way to fix this would be to fix the texi2pod.pl script to handle @t instead. I'll reply to your other patches over here: https://sourceware.org/ml/gdb-patches/2019-09/msg00295.html Simon
> From: Simon Marchi <simark@simark.ca> > Date: Mon, 16 Sep 2019 21:19:12 -0400 > > On 2019-09-16 5:47 p.m., Carl Bordum Hansen wrote: > > This change means that the html version of the man page does not stylize > > the "++" in the third paragraph. > > (https://sourceware.org/gdb/current/onlinedocs/gdb/gdb-man.html). The > > tradeoff is, in my opinion, worth it as the man page reads better, since > > it is now formatted properly. Before this change, it read as: > > "... programs written in C, C@t{++}, ...". > > --- > > > > Hello, this is my first patch to a GNU project ever and also the first time I > > use an email-based git workflow, so please excuse my mistakes :-) > > Hi Carl, > > Thanks for your patches. I see you've used git-send-email, that's excellent. > > Like I said on IRC, I think the best way to fix this would be to fix the texi2pod.pl > script to handle @t instead. I agree, but I'm also confused about the problem. If I go to that page, I don't see @t there, and looking at the page source reveals that C@t{++} has been correctly converted to C<tt>++</tt>. So I'm not sure why Carl sees something different. What am I missing here?
On 2019-09-17 2:02 a.m., Eli Zaretskii wrote: >> Like I said on IRC, I think the best way to fix this would be to fix the texi2pod.pl >> script to handle @t instead. > > I agree, but I'm also confused about the problem. If I go to that > page, I don't see @t there, and looking at the page source reveals > that C@t{++} has been correctly converted to C<tt>++</tt>. So I'm not > sure why Carl sees something different. > > What am I missing here? > Hi Eli, We are talking about the actual man page, as viewed with "man". The HTML (or info) version is rendered fine. I can view it by doing: 1. `cd gdb/doc` in the build directory 2. `make man` 3. `man -l gdb.1` Simon
> Cc: carl@bordum.dk, gdb-patches@sourceware.org > From: Simon Marchi <simark@simark.ca> > Date: Tue, 17 Sep 2019 08:36:51 -0400 > > > I agree, but I'm also confused about the problem. If I go to that > > page, I don't see @t there, and looking at the page source reveals > > that C@t{++} has been correctly converted to C<tt>++</tt>. So I'm not > > sure why Carl sees something different. > > > > What am I missing here? > > > > Hi Eli, > > We are talking about the actual man page, as viewed with "man". The HTML (or info) version is rendered fine. > > I can view it by doing: > > 1. `cd gdb/doc` in the build directory > 2. `make man` > 3. `man -l gdb.1` Ah, OK. I do see @t{++} in the man page. I was confused by the reference to the HTML page and by patches posted that seemed to only affect HTML. So back to the topic: I do agree that the conversion tool should be taught about @t.
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index eee0c9d4dd..68c45d9dc9 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -45056,7 +45056,7 @@ Change things in your program, so you can experiment with correcting the effects of one bug and go on to learn about another. @end itemize -You can use @value{GDBN} to debug programs written in C, C@t{++}, Fortran and +You can use @value{GDBN} to debug programs written in C, C++, Fortran and Modula-2. @value{GDBN} is invoked with the shell command @code{gdb}. Once started, it reads