From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from esa3.mentor.iphmx.com (esa3.mentor.iphmx.com [68.232.137.180]) by sourceware.org (Postfix) with ESMTPS id DF1CB3858D33 for ; Thu, 9 Mar 2023 03:16:11 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org DF1CB3858D33 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=codesourcery.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=mentor.com X-IronPort-AV: E=Sophos;i="5.98,245,1673942400"; d="scan'208";a="99353189" Received: from orw-gwy-02-in.mentorg.com ([192.94.38.167]) by esa3.mentor.iphmx.com with ESMTP; 08 Mar 2023 19:16:06 -0800 IronPort-SDR: opfQ6atYritMYS6vZiBlAfn3nMup+PZy97zBifrvPmcSjCpPRAFxzXhRLujh/96X4LOH6BrkgJ fn+i5So+6yRj9HhEQ/NA9KXcUwKDD/lHVZWBtAH2gz1wc33EOx3FmOrFnfsMLetXXyojpsdnxE HcjWfdQ1nLXWDNHsYVm/Rhs4IiiwenFSI7XiUUllO1kTvCrej4St8lZ6YQKaGJkgVIhhn0ILDa CxnDSNIqy93KTcXbnKN4smD6ZsukHe5ZrcJnAAzLEtzcnEROK+O+LQUxtD/7INnsLARKlZ5wAn K5E= Message-ID: <9dd976a4-4e09-d901-b949-6d5037567b9b@codesourcery.com> Date: Wed, 8 Mar 2023 20:16:01 -0700 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.7.1 Subject: Re: [PATCH v2 1/5] docs: Create Indices appendix Content-Language: en-US To: =?UTF-8?Q?Arsen_Arsenovi=c4=87?= , CC: Gerald Pfeifer , Joseph Myers References: <20230223102714.3606058-1-arsen@aarsen.me> <20230223102714.3606058-2-arsen@aarsen.me> From: Sandra Loosemore In-Reply-To: <20230223102714.3606058-2-arsen@aarsen.me> Content-Type: text/plain; charset="UTF-8"; format=flowed Content-Transfer-Encoding: 8bit X-ClientProxiedBy: svr-orw-mbx-14.mgc.mentorg.com (147.34.90.214) To svr-orw-mbx-13.mgc.mentorg.com (147.34.90.213) X-Spam-Status: No, score=-3.5 required=5.0 tests=BAYES_00,HEADER_FROM_DIFFERENT_DOMAINS,KAM_DMARC_STATUS,KAM_INFOUSMEBIZ,KAM_SHORT,NICE_REPLY_A,SPF_HELO_PASS,SPF_PASS,TXREP autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: On 2/23/23 03:27, Arsen Arsenović via Gcc-patches wrote: > The GCC manual has multiple indices. By creating an appendix which > lists them, we help makeinfo present a more accessible way for the > reader to see all the indices. > > gcc/ChangeLog: > > * doc/gcc.texi: Add the Indices appendix, to make texinfo > generate nice indices overview page. > (@copying): Move "This file documents the use of the GNU > compilers" into @copying. Add quotations around cover texts. I guess this patch is OK and is necessary to smooth over some misfeatures in newer versions of Texinfo. In particular, comparing your sample output https://www.aarsen.me/~arsen/final/gcc.html/index.html to my own fresh Texinfo 6.7-generated version with your patches applied, and the existing online documention like https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc/index.html the order of the "Short Table of Contents" and longer "Table of Contents" have been switched, so that in the new version you have to scroll all the way down to the bottom of the page (ugh) to click on "Option Index". (Frankly, this seems like a misfeature; the point of having a "Short Table of Contents" is *not* to have to page through the long one to find a particular chapter.) I guess that is a Texinfo change? gcc.texi still has: @summarycontents @contents in that order. OTOH, I see that in your new version there is now a line with links [Contents][Index] before the Introduction. If adding this new appendix makes the [Index] link point at the indices, I think it is OK, although I'm still worried that the overall effect (even without the new version of Texinfo) is making the indices harder to find. I wonder, could we add something to the Introduction text like Tip: This manual is very long. If you're looking for something in particular, try searching the @ref{Option Index} or @ref{Concept and Symbol Index}. ??? -Sandra