From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mout-p-102.mailbox.org (mout-p-102.mailbox.org [IPv6:2001:67c:2050:0:465::102]) by sourceware.org (Postfix) with ESMTPS id 508923858C5E for ; Thu, 9 Mar 2023 10:16:19 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 508923858C5E Authentication-Results: sourceware.org; dmarc=pass (p=reject dis=none) header.from=aarsen.me Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=aarsen.me Received: from smtp202.mailbox.org (smtp202.mailbox.org [10.196.197.202]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-384) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by mout-p-102.mailbox.org (Postfix) with ESMTPS id 4PXQ7g4TZVz9scf; Thu, 9 Mar 2023 11:16:15 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=aarsen.me; s=MBO0001; t=1678356975; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=fSG0FhVMMBdyc9an0KW2KXI0VsiT08s65b9cNXo+IVo=; b=Ol50eN+sRzGBGaDh3zzaw5PCVKFFfmPLEpiNwlIt9hH0Iod4k9mCvdfivJ38D4wSvIzv45 Vl8B6J/f6a8DnLWyALxKJKg8EoVjB6Fp/M27eW1Xldz359LNal6j7XIFXsuBhWNq+uyBt3 0TBCCGYIe4hY1TW/UDXaMyP3r199Hq+wCkWFWcO2VD1bATecb4Uf9Z1m6XLZPok4Dsn3t5 1dSxXc7L+Ssr2EYiczqh+tQV2WamTcFt0vmqloQi4iVaiOf1+f9cAep8HpL9nkDUcDivNW GH6FHxUz/Uex5VplHssDZXkgIf9p0ZQPhT0Qg4ZmH93/UaaW+ERhunjraWuvPA== References: <20230223102714.3606058-1-arsen@aarsen.me> <20230223102714.3606058-2-arsen@aarsen.me> <9dd976a4-4e09-d901-b949-6d5037567b9b@codesourcery.com> From: Arsen =?utf-8?Q?Arsenovi=C4=87?= To: Sandra Loosemore Cc: gcc-patches@gcc.gnu.org, Gerald Pfeifer , Joseph Myers Subject: Re: [PATCH v2 1/5] docs: Create Indices appendix Date: Thu, 09 Mar 2023 11:12:36 +0100 In-reply-to: <9dd976a4-4e09-d901-b949-6d5037567b9b@codesourcery.com> Message-ID: <86ilfa6xhw.fsf@aarsen.me> MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha512; protocol="application/pgp-signature" X-Spam-Status: No, score=-4.3 required=5.0 tests=BAYES_00,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,KAM_INFOUSMEBIZ,KAM_SHORT,RCVD_IN_DNSWL_LOW,SPF_HELO_NONE,SPF_PASS,TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Sandra Loosemore writes: > On 2/23/23 03:27, Arsen Arsenovi=C4=87 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, th= is > 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. Hm, I hadn't noticed that.. That is odd. I'll figure out why this happens later today. Thanks for raising this to my attention. > 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 m= akes > the [Index] link point at the indices, I think it is OK, although I'm sti= ll > 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 partic= ular, > try searching the @ref{Option Index} or @ref{Concept and Symbol Index}. > > ??? I think this is a good idea in either case. It should certainly help users unaccustomed to Texinfo in locating things quickly. > -Sandra =2D-=20 Arsen Arsenovi=C4=87 --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iOYEARYKAI4WIQT+4rPRE/wAoxYtYGFSwpQwHqLEkwUCZAmx618UgAAAAAAuAChp c3N1ZXItZnByQG5vdGF0aW9ucy5vcGVucGdwLmZpZnRoaG9yc2VtYW4ubmV0RkVF MkIzRDExM0ZDMDBBMzE2MkQ2MDYxNTJDMjk0MzAxRUEyQzQ5MxAcYXJzZW5AYWFy c2VuLm1lAAoJEFLClDAeosSTfHUBAIAoXDD+ai74pWogXylwFK2jIcjPDf6AMqdn dBNdIWs2AP4kPrpjtkitmEALj4K+H/L+8XHvF2BwzUejLbzl6DLVCA== =I67n -----END PGP SIGNATURE----- --=-=-=--