[Bug build/25716] New: Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[Bug build/25716] New: Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[freddie_chopin at op dot pl]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

            Bug ID: 25716
           Summary: Generated doxygen docs cause problems for Windows due
                    to case-insensitive filesystem
           Product: gdb
           Version: 9.1
            Status: UNCONFIRMED
          Severity: normal
          Priority: P2
         Component: build
          Assignee: unassigned at sourceware dot org
          Reporter: freddie_chopin at op dot pl
  Target Milestone: ---

Doxygen docs for GDB contain these two files:
frame-apply.html
Frame-Apply.html

Their names differ only in case (their contents are obviously different), so
when dumping such package on an case-insensitive filesystem (like quite
frequently on Windows) you end up with just one of these files, serving as
both.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug build/25716] Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[pcarroll at codesourcery dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

Paul Carroll <pcarroll at codesourcery dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |pcarroll at codesourcery dot com

--- Comment #1 from Paul Carroll <pcarroll at codesourcery dot com> ---
We ran into this same problem.  I've identified the problem as being a new
@anchor in the gdb.texinfo file.  The solution is to remove the @anchor(frame
apply) and then modify the 2 @xref's that refer to that anchor.  When I do
that, the 'frame-apply.html' file is not created (using texi2html).  I will
attach my proposed patch, which should solve this issue.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug build/25716] Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[pcarroll at codesourcery dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

--- Comment #2 from Paul Carroll <pcarroll at codesourcery dot com> ---
Created attachment 12626
  --> https://sourceware.org/bugzilla/attachment.cgi?id=12626&action=edit
Proposed patch for PR25716

This patch removes a new @anchor(frame apply) and modifies the 2 @xref's that
refer to it, so as to avoid the creation of multiple files that are only
different by case.  This will avoid issues with Windows.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug build/25716] Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[simark at simark dot ca]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

Simon Marchi <simark at simark dot ca> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |simark at simark dot ca

--- Comment #3 from Simon Marchi <simark at simark dot ca> ---
Hi Paul,

Would you mind sending the patch on the gdb-patches mailing list?  Our
documentation maintainer will be able to review it there.

See: https://sourceware.org/gdb/wiki/ContributionChecklist

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug build/25716] Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[pcarroll at codesourcery dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

--- Comment #4 from Paul Carroll <pcarroll at codesourcery dot com> ---
I posted the patch to gdb-patches.  I guess we'll see when there is a comment.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug build/25716] Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[simark at simark dot ca]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

--- Comment #5 from Simon Marchi <simark at simark dot ca> ---
(In reply to Paul Carroll from comment #4)
> I posted the patch to gdb-patches.  I guess we'll see when there is a
> comment.

Thanks.  Don't hesitate to ping after ~ 2 weeks if you don't get an answer.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug build/25716] Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[pcarroll at codesourcery dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

Paul Carroll <pcarroll at codesourcery dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #12626|0                           |1
        is obsolete|                            |

--- Comment #6 from Paul Carroll <pcarroll at codesourcery dot com> ---
Created attachment 12687
  --> https://sourceware.org/bugzilla/attachment.cgi?id=12687&action=edit
Accepted version of patch

It looks like Andrew Burgess accepted my slightly-revised patch yesterday:

https://sourceware.org/pipermail/gdb-patches/2020-July/170256.html

Now to see about getting it applied...

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug build/25716] Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[pcarroll at codesourcery dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

--- Comment #7 from Paul Carroll <pcarroll at codesourcery dot com> ---
Eli Zaretskii also cleared the patch today.
https://sourceware.org/pipermail/gdb-patches/2020-July/170270.html

So I would think nothing should prevent applying the patch.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug build/25716] Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[cvs-commit at gcc dot gnu.org]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

--- Comment #8 from cvs-commit at gcc dot gnu.org <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by Sandra Loosemore <sandra@sourceware.org>:

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=ed788fee02b844266283a5faa66ba64c5b4739ea

commit ed788fee02b844266283a5faa66ba64c5b4739ea
Author: Paul Carroll <pcarroll@codesourcery.com>
Date:   Mon Jul 13 12:31:05 2020 -0700

    Fix frame-apply.html collision in GDB manual.

    The addition of an anchor for the "frame apply" command was causing
    the HTML documentation to include files named both "frame-apply.html"
    and "Frame-Apply.html", which collide on case-insensitive file
    systems.  This patch removes the redundant anchor and adjusts the two
    xrefs to it.

    2020-07-13 Paul Carroll <pcarroll@codesourcery.com>

            PR gdb/25716

            gdb/doc/
            * gdb.texinfo (Frame Apply): Remove anchor for 'frame
            apply' and adjust xrefs to it.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug build/25716] Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[pcarroll at codesourcery dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

--- Comment #9 from Paul Carroll <pcarroll at codesourcery dot com> ---
I would think this issue could be closed now, although perhaps it depends on
whether anyone else has verified the fix.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug build/25716] Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[brobecker at gnat dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

Joel Brobecker <brobecker at gnat dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Resolution|---                         |FIXED
                 CC|                            |brobecker at gnat dot com
             Status|UNCONFIRMED                 |RESOLVED

--- Comment #10 from Joel Brobecker <brobecker at gnat dot com> ---
Let's just close it. The author can re-open if he finds it's not fixed
for him.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug build/25716] Generated doxygen docs cause problems for Windows due to case-insensitive filesystem

[brobecker at gnat dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=25716

Joel Brobecker <brobecker at gnat dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
   Target Milestone|---                         |10.1

-- 
You are receiving this mail because:
You are on the CC list for the bug.