From: Torbjorn SVENSSON <torbjorn.svensson@foss.st.com>
To: "Torbjörn SVENSSON via Gdb-patches" <gdb-patches@sourceware.org>
Cc: Eli Zaretskii <eliz@gnu.org>
Subject: Generated GDB documentation have colliding files on a case insensitive files system
Date: Sat, 7 Jan 2023 10:21:49 +0100 [thread overview]
Message-ID: <f3c39dba-a254-821c-b24a-b846eacf8039@foss.st.com> (raw)
Hi,
If the HTML documentation is put on a case insensitive files system
(like those used in Windows), there are 2 files that collides:
qMemTags.html and QMemTags.html.
Both the files contains a simple redirect to their corresponding anchor
in General-Query-Packets.html, and there appears to be no link to
[qQ]MemTags.html in any of the other generated HTML files.
I'm currently leaning towards that these redirect files are not really
needed and that they should have been omitted.
As it's correct to document both qMemTags and QMemTags, and that the two
RSP commands are indeed different, I see the following potential
solutions to the collision:
* Leave it as is and live with the collision for users extracting an
archive with the HTML documentation on a case insensitive files system.
* Use the "--no-split" argument to makeinfo to generate a single big
HTML file for all the documentation rather than one HTML file per @node.
This solution might have other consequences that I'm not aware of as
there are multiple texi files in the GDB source tree...
* After invoking makeinfo, remove all the generated redirect pages
(appears to be ~214 files).
Is there any other solution that I have no thought of?
What solution is preferred?
I've also started a thread on the bug-texinfo list about adding a
warning for this problem when running the makeinfo command. The thread
can be found here:
https://lists.gnu.org/archive/html/bug-texinfo/2023-01/msg00030.html
Kind regards,
Torbjörn
next reply other threads:[~2023-01-07 9:21 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-07 9:21 Torbjorn SVENSSON [this message]
2023-01-07 9:37 ` Eli Zaretskii
2023-01-07 9:42 ` Torbjorn SVENSSON
2023-01-07 10:43 ` Eli Zaretskii
2023-01-07 10:52 ` Torbjorn SVENSSON
2023-01-07 11:08 ` Eli Zaretskii
2023-01-09 6:51 ` Torbjorn SVENSSON
2023-01-09 12:24 ` Eli Zaretskii
2023-01-15 17:22 ` Torbjorn SVENSSON
2023-01-15 17:39 ` Eli Zaretskii
2023-01-15 17:43 ` Torbjorn SVENSSON
2023-01-15 18:09 ` Eli Zaretskii
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=f3c39dba-a254-821c-b24a-b846eacf8039@foss.st.com \
--to=torbjorn.svensson@foss.st.com \
--cc=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
/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).