From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 6212 invoked by alias); 23 Jun 2014 13:45:55 -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 6202 invoked by uid 89); 23 Jun 2014 13:45:55 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.9 required=5.0 tests=AWL,BAYES_00,SPF_HELO_PASS,SPF_PASS,T_RP_MATCHES_RCVD autolearn=ham version=3.3.2 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, 23 Jun 2014 13:45:54 +0000 Received: from int-mx10.intmail.prod.int.phx2.redhat.com (int-mx10.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id s5NDjngU021162 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 23 Jun 2014 09:45:50 -0400 Received: from [127.0.0.1] (ovpn01.gateway.prod.ext.ams2.redhat.com [10.39.146.11]) by int-mx10.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id s5NDjmFS014577; Mon, 23 Jun 2014 09:45:48 -0400 Message-ID: <53A82F8B.7080507@redhat.com> Date: Mon, 23 Jun 2014 13:45:00 -0000 From: Pedro Alves User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:24.0) Gecko/20100101 Thunderbird/24.6.0 MIME-Version: 1.0 To: Mingjie Xing CC: Eli Zaretskii , gdb-patches@sourceware.org Subject: Re: [patch] Share options between info and man page References: <831tuy2kzi.fsf@gnu.org> <83ioo91nnk.fsf@gnu.org> <8338fc1wed.fsf@gnu.org> <53983FFA.6020909@redhat.com> In-Reply-To: Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit X-SW-Source: 2014-06/txt/msg00812.txt.bz2 On 06/12/2014 04:35 AM, Mingjie Xing wrote: > Hi Pedro, thank you for the careful checking. See the attachment for > the new patch and the diff result. Following my comment, > > 2014-06-11 19:39 GMT+08:00 Pedro Alves : >> On 06/10/2014 06:56 PM, Eli Zaretskii wrote: >> >>> Thanks. This looks good to me. If no one objects, it should go in >>> soon. >> >> I applied the patch locally, and noticed some things misrendered in the >> new man page, like, options are now listed with double quotes instead >> of being highlighted. E.g.: >> >> "-help" >> "-h" > > This is because the previous man page uses "@table @env" while the > current Invoke sections uses "@table @code". I've fixed. > >> This one is preexisting, but note "C@t{++}" in: >> >> "You can use GDB to debug programs written in C, C@t{++}, Fortran and Modula-2." > > This seems that texi2pod is unable to handle "@t". The problem also > occurs for the old man page if you build from the current git. But then we lose formatting on the info pages, right? Should we re-define it as a macro under ifset man ? @ifset man @macro t{text} \text\ @end macro @end ifset (I don't actually know whether possible.) > >> This sentence seems to be out of place: >> >> "You can run GDB in various alternative modes---for example, in batch mode or quiet mode." > > OK, I've put it out. > >> Not sure, but "---" might be misrendered too. > > Hmm, there are many such usage (no space before/afert "--") in gdb.texinfo. Those three dashes are rendered as an em dash in texinfo: http://www.gnu.org/software/texinfo/manual/texinfo/html_node/Conventions.html I'd assume the man page should end up with \(em instead of literal ---. Should we have a macro for this too? > >> This incomplete sentence appears, seemingly trying to refer to a chapter >> in the manual: >> >> " For further documentation on startup processing, For documentation on how to write command files," > > Yes, still seems texi2pod's problem, which simply through away the > content for @xref/@pxref. I've changed ", @xref" to ", see @ref" to > correctly display them in man page. > > Note, that current doc uses @xref after a comma, which is incorrect. > >> At this point, I generated a diff of the old/new man pages, in plain text, with: >> >> $ man ./gdb.1 > gdb.1.txt >> $ man ./gdb.1.new > gdb.1.new.txt >> $ diff -up gdb.1.txt gdb.1.new.txt >> >> I think that's helpful to review this. The result is below. Seems there are >> other odd things in there, like "GDB/MI INTERFACE" in all caps? > > Still texi2pod's problem. It can't handle correctly the nested form > "@dfn{@sc{gdb/mi} interface}". This can be fix by reorder the process > sequence. Move > > s/\@sc\{([^\}]*)\}/\U$1/g; > > before > > s/\@(?:dfn|var|emph|cite|i)\{([^\}]*)\}/I<$1>/g; > > But, what if @sc{@dfn{...}}? Hopefully Eli can take a new look. The new resulting output diff looks much better to me now. Thanks for doing this. -- Pedro Alves