[Bug libstdc++/100682] New: Outdated manual about the debug mode using

[Bug libstdc++/100682] New: Outdated manual about the debug mode using

[frankhb1989 at gmail dot com]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=100682

            Bug ID: 100682
           Summary: Outdated manual about the debug mode using
           Product: gcc
           Version: 11.0
            Status: UNCONFIRMED
          Severity: normal
          Priority: P3
         Component: libstdc++
          Assignee: unassigned at gcc dot gnu.org
          Reporter: frankhb1989 at gmail dot com
  Target Milestone: ---

As I see <debug/array> has been removed in GCC 11, but the doc disagree:

https://gcc.gnu.org/onlinedocs/libstdc++/manual/debug_mode_using.html
https://gcc.gnu.org/onlinedocs/gcc-11.1.0/libstdc++/manual/manual/debug_mode_using.html

In table 17.2, <debug/array> is still at the first row.

BTW, what is the compatibility policy here? Is it true that any <debug/*>
headers could be removed in a future release of GCC without deprecation?

[Bug libstdc++/100682] Outdated manual about the debug mode using

[redi at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=100682

Jonathan Wakely <redi at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
     Ever confirmed|0                           |1
   Last reconfirmed|                            |2021-05-19
             Status|UNCONFIRMED                 |NEW

--- Comment #1 from Jonathan Wakely <redi at gcc dot gnu.org> ---
(In reply to frankhb1989 from comment #0)
> BTW, what is the compatibility policy here? Is it true that any <debug/*>
> headers could be removed in a future release of GCC without deprecation?

We probably shouldn't do that.

I suppose we could restore <debug/array> but with this content:

#include <array>
namespace __gnu_debug { using std::array; using std::get; using std::swap; }

And then deprecate it.

[Bug libstdc++/100682] Outdated manual about the debug mode using

[redi at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=100682

Jonathan Wakely <redi at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
   Target Milestone|---                         |11.3

[Bug libstdc++/100682] Outdated manual about the debug mode using

[cvs-commit at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=100682

--- Comment #2 from CVS Commits <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by Jonathan Wakely <redi@gcc.gnu.org>:

https://gcc.gnu.org/g:254e5d19a177af23a77b67fd51d0d1a25eaabfc7

commit r12-2467-g254e5d19a177af23a77b67fd51d0d1a25eaabfc7
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Thu Jul 22 11:45:32 2021 +0100

    libstdc++: Restore __gnu_debug::array [PR100682]

    As the PR points out, we removed the debug version of std::array without
    any period of deprecation. Although std::array contains all the actual
    debug checks now, removing the <debug/arrray> header breaks any code
    that was using that explicitly. The manual still lists doing that as
    supported.

    This restores the <debug/array> header, but simply defines
    __gnu_debug::array as an alias for std::array, and declares the alias
    with the deprecated attribute. The docs are updated to match.

    Signed-off-by: Jonathan Wakely <jwakely@redhat.com>

    libstdc++-v3/ChangeLog:

            PR libstdc++/100682
            * doc/xml/manual/debug_mode.xml: Update documentation about
            debug capability of std::array.
            * doc/html/*: Regenerate.
            * include/debug/array: New file.

[Bug libstdc++/100682] Outdated manual about the debug mode using

[redi at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=100682

Jonathan Wakely <redi at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |ASSIGNED
           Assignee|unassigned at gcc dot gnu.org      |redi at gcc dot gnu.org

--- Comment #3 from Jonathan Wakely <redi at gcc dot gnu.org> ---
Fixed on trunk for now.

[Bug libstdc++/100682] Outdated manual about the debug mode using

[cvs-commit at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=100682

--- Comment #4 from CVS Commits <cvs-commit at gcc dot gnu.org> ---
The releases/gcc-11 branch has been updated by Jonathan Wakely
<redi@gcc.gnu.org>:

https://gcc.gnu.org/g:743df0fa0df5af32fce70fcdc6ae6b7dc0f01d9b

commit r11-8920-g743df0fa0df5af32fce70fcdc6ae6b7dc0f01d9b
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Thu Jul 22 11:45:32 2021 +0100

    libstdc++: Restore __gnu_debug::array [PR100682]

    As the PR points out, we removed the debug version of std::array without
    any period of deprecation. Although std::array contains all the actual
    debug checks now, removing the <debug/arrray> header breaks any code
    that was using that explicitly. The manual still lists doing that as
    supported.

    This restores the <debug/array> header, but simply defines
    __gnu_debug::array as an alias for std::array, and declares the alias
    with the deprecated attribute. The docs are updated to match.

    Signed-off-by: Jonathan Wakely <jwakely@redhat.com>

    libstdc++-v3/ChangeLog:

            PR libstdc++/100682
            * doc/xml/manual/debug_mode.xml: Update documentation about
            debug capability of std::array.
            * doc/html/*: Regenerate.
            * include/debug/array: New file.

    (cherry picked from commit 254e5d19a177af23a77b67fd51d0d1a25eaabfc7)

[Bug libstdc++/100682] Outdated manual about the debug mode using

[redi at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=100682

Jonathan Wakely <redi at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|ASSIGNED                    |RESOLVED
         Resolution|---                         |FIXED

--- Comment #5 from Jonathan Wakely <redi at gcc dot gnu.org> ---
I've restored the <debug/array> header and __gnu_debug::array (as an alias for
std::array).