From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 30298 invoked by alias); 23 Dec 2013 15:35:03 -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 30286 invoked by uid 89); 23 Dec 2013 15:35:03 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-0.7 required=5.0 tests=AWL,BAYES_00,FREEMAIL_ENVFROM_END_DIGIT,FREEMAIL_FROM,RCVD_IN_DNSWL_LOW,SPF_PASS autolearn=ham version=3.3.2 X-HELO: mail-wi0-f170.google.com Received: from mail-wi0-f170.google.com (HELO mail-wi0-f170.google.com) (209.85.212.170) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES128-SHA encrypted) ESMTPS; Mon, 23 Dec 2013 15:35:02 +0000 Received: by mail-wi0-f170.google.com with SMTP id hq4so10555194wib.1 for ; Mon, 23 Dec 2013 07:34:59 -0800 (PST) MIME-Version: 1.0 X-Received: by 10.180.206.11 with SMTP id lk11mr18973355wic.16.1387812899135; Mon, 23 Dec 2013 07:34:59 -0800 (PST) Received: by 10.194.123.4 with HTTP; Mon, 23 Dec 2013 07:34:59 -0800 (PST) In-Reply-To: <83a9fs8brb.fsf@gnu.org> References: <83a9fs8brb.fsf@gnu.org> Date: Mon, 23 Dec 2013 15:35:00 -0000 Message-ID: Subject: Re: [doc RFA] Misc. fixes to Python docs From: Doug Evans To: Eli Zaretskii Cc: "gdb-patches@sourceware.org" Content-Type: text/plain; charset=ISO-8859-1 X-IsSubscribed: yes X-SW-Source: 2013-12/txt/msg00881.txt.bz2 On Sun, Dec 22, 2013 at 7:52 PM, Eli Zaretskii wrote: >> From: Doug Evans >> Date: Sun, 22 Dec 2013 17:58:10 -0800 >> >> I found this collection of fixes. >> >> The @tindex is for consistency with all other such entries. >> >> The @code{"charset"} instead of @samp{charset} is for consistency with >> earlier use. > > I question the second issue. IMO @samp looks much better in print > than @code{".."}. I don't have a strong opinion, other than Consistency Is Good. >> +@findex gdb.VERSION >> +@defvar gdb.VERSION > > @defvar inserts its argument into the index automatically, so no need > for @findex (which is wrong anyway, since this is a variable, not a > function). Heh, righto. And in fact I have another patch to remove a lot of dupes for some defuns. >> @@ -26482,7 +26499,6 @@ this function returns @code{None}. >> @findex gdb.objfiles >> @defun gdb.objfiles () >> Return a sequence of all the objfiles current known to @value{GDBN}. >> -@xref{Objfiles In Python}. >> @end defun > > Why did you remove the cross-reference? We're in the chapter on "Objfiles In Python" and it's telling the reader "See the chapter on Objfiles In Python." [Yes, I know xref doesn't expand to include "the chapter on". I'm expanding the wording for illustration's sake.] Self-xrefs feel really out of place.