From: "Arsen Arsenović" <arsen@aarsen.me>
To: Sandra Loosemore <sandra@codesourcery.com>
Cc: gcc-patches@gcc.gnu.org, Gerald Pfeifer <gerald@pfeifer.com>,
Joseph Myers <joseph@codesourcery.com>
Subject: Re: [PATCH v2 1/5] docs: Create Indices appendix
Date: Thu, 09 Mar 2023 21:38:16 +0100 [thread overview]
Message-ID: <86sfed63l6.fsf@aarsen.me> (raw)
In-Reply-To: <9dd976a4-4e09-d901-b949-6d5037567b9b@codesourcery.com>
[-- Attachment #1.1: Type: text/plain, Size: 1644 bytes --]
Sandra Loosemore <sandra@codesourcery.com> writes:
> 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.
Found the change. HTML got support for CONTENTS_OUTPUT_LOCATION, which
defaults to after_top, which ignores the inline location of these
elements. Here's a patch:
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: [PATCH] update_web_docs_git: Set CONTENTS_OUTPUT_LOCATION=inline --]
[-- Type: text/x-patch, Size: 1370 bytes --]
From 0a0c9469301fb25c4b420a1ed4e381f5ea921d07 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Arsen=20Arsenovi=C4=87?= <arsen@aarsen.me>
Date: Thu, 9 Mar 2023 21:44:29 +0100
Subject: [PATCH] update_web_docs_git: Set CONTENTS_OUTPUT_LOCATION=inline
maintainer-scripts/ChangeLog:
* update_web_docs_git: Set CONTENTS_OUTPUT_LOCATION=inline in
order to put @shortcontents above contents. See
9dd976a4-4e09-d901-b949-6d5037567b9b@codesourcery.com on
gcc-patches.
---
maintainer-scripts/update_web_docs_git | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/maintainer-scripts/update_web_docs_git b/maintainer-scripts/update_web_docs_git
index 9ded1744df4..c9f14d1a4d1 100755
--- a/maintainer-scripts/update_web_docs_git
+++ b/maintainer-scripts/update_web_docs_git
@@ -169,7 +169,7 @@ for file in $MANUALS; do
if [ "$file" = "gnat_ugn" ]; then
includes="$includes -I gcc/gcc/ada -I gcc/gcc/ada/doc/gnat_ugn"
fi
- makeinfo --html --css-ref $CSS $includes -o ${file} ${filename}
+ makeinfo --html -c CONTENTS_OUTPUT_LOCATION=inline --css-ref $CSS $includes -o ${file} ${filename}
tar cf ${file}-html.tar ${file}/*.html
texi2dvi $includes -o ${file}.dvi ${filename} </dev/null >/dev/null && dvips -o ${file}.ps ${file}.dvi
texi2pdf $includes -o ${file}.pdf ${filename} </dev/null
--
2.39.2
[-- Attachment #1.3: Type: text/plain, Size: 802 bytes --]
I pushed the updated docs, and added that commit to my branch (as well
as rebasing it, as always).
> 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}.
>
> ???
Even with the above fixed, I think it'd be nice to add this text.
> -Sandra
--
Arsen Arsenović
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 381 bytes --]
next prev parent reply other threads:[~2023-03-09 21:02 UTC|newest]
Thread overview: 59+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-23 10:27 [PATCH v2 0/5] A small Texinfo refinement Arsen Arsenović
2023-02-23 10:27 ` [PATCH v2 1/5] docs: Create Indices appendix Arsen Arsenović
2023-03-09 3:16 ` Sandra Loosemore
2023-03-09 10:12 ` Arsen Arsenović
2023-03-09 20:38 ` Arsen Arsenović [this message]
2023-03-11 1:12 ` Sandra Loosemore
2023-03-11 1:34 ` Arsen Arsenović
2023-03-11 12:22 ` Arsen Arsenović
2023-03-11 19:22 ` Gerald Pfeifer
2023-03-11 20:22 ` Arsen Arsenović
2023-03-11 19:34 ` Sandra Loosemore
2023-03-11 20:14 ` Arsen Arsenović
2023-03-11 20:32 ` [PATCH v2] html: Set CONTENTS_OUTPUT_LOCATION=inline if makeinfo supports it Arsen Arsenović
2023-03-12 10:25 ` [PATCH v2 1/5] docs: Create Indices appendix Gerald Pfeifer
2023-03-12 12:23 ` Arsen Arsenović
2023-02-23 10:27 ` [PATCH v2 2/5] **/*.texi: Reorder index entries Arsen Arsenović
2023-02-23 23:50 ` Gerald Pfeifer
2023-02-23 10:27 ` [PATCH v2 3/5] doc: Add @defbuiltin family of helpers, set documentlanguage Arsen Arsenović
2023-03-09 23:50 ` Sandra Loosemore
2023-02-23 10:27 ` [PATCH v2 4/5] Update texinfo.tex, remove the @gol macro/alias Arsen Arsenović
2023-03-09 23:55 ` Sandra Loosemore
2023-03-10 0:17 ` Gerald Pfeifer
2023-03-10 10:33 ` Thomas Schwinge
2023-03-10 12:49 ` Arsen Arsenović
2023-03-10 15:51 ` Gerald Pfeifer
2023-03-10 15:58 ` Arsen Arsenović
2023-03-10 12:48 ` Arsen Arsenović
2023-03-10 15:49 ` Arsen Arsenović
2023-03-18 20:14 ` Ping (gcc/configure.ac, docs): " Arsen Arsenović
2023-03-20 22:01 ` Sandra Loosemore
2023-03-20 23:06 ` Joseph Myers
2023-03-20 23:27 ` Arsen Arsenović
2023-03-20 23:35 ` Arsen Arsenović
2023-03-21 9:52 ` Arsen Arsenović
2023-03-21 23:11 ` Gerald Pfeifer
2023-02-23 10:27 ` [PATCH v2 5/5] update_web_docs_git: Update CSS reference to new manual CSS Arsen Arsenović
2023-03-10 0:07 ` Sandra Loosemore
2023-03-10 13:00 ` Arsen Arsenović
2023-02-25 22:04 ` [PATCH v2 0/5] A small Texinfo refinement Thomas Schwinge
2023-02-26 14:54 ` Arsen Arsenović
2023-03-08 1:56 ` Sandra Loosemore
2023-03-08 9:11 ` Arsen Arsenović
2023-03-08 18:38 ` Sandra Loosemore
2023-03-08 21:22 ` Arsen Arsenović
2023-03-09 1:09 ` Sandra Loosemore
2023-03-09 1:19 ` Andrew Pinski
2023-03-09 8:26 ` Richard Biener
2023-03-09 23:35 ` Sandra Loosemore
2023-03-10 8:50 ` Iain Sandoe
2023-03-10 17:51 ` Sandra Loosemore
2023-03-10 18:09 ` Sandra Loosemore
2023-03-10 19:00 ` Gerald Pfeifer
2023-03-13 9:05 ` Richard Biener
2023-03-13 11:01 ` Arsen Arsenović
2023-05-29 15:06 ` NightStrike
2023-05-29 17:26 ` Arsen Arsenović
2023-05-29 19:27 ` Sandra Loosemore
2023-03-09 10:22 ` Arsen Arsenović
2023-03-09 8:28 ` Gerald Pfeifer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86sfed63l6.fsf@aarsen.me \
--to=arsen@aarsen.me \
--cc=gcc-patches@gcc.gnu.org \
--cc=gerald@pfeifer.com \
--cc=joseph@codesourcery.com \
--cc=sandra@codesourcery.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).