From c784f1620498f78cfb9075a4696f2813722eb547 Mon Sep 17 00:00:00 2001 From: Jonathan Wakely Date: Mon, 20 Jan 2020 20:37:52 +0000 Subject: [PATCH] libstdc++: Fix recent documentation changes * doc/xml/faq.xml: Fix grammar. * doc/xml/manual/appendix_contributing.xml: Improve instructions. * doc/xml/manual/spine.xml: Update copyright years. * doc/html/*: Regenerate. --- libstdc++-v3/ChangeLog | 7 +++++ libstdc++-v3/doc/html/api.html | 2 +- libstdc++-v3/doc/html/faq.html | 28 +++++-------------- libstdc++-v3/doc/html/index.html | 4 +-- .../html/manual/appendix_contributing.html | 12 ++++---- .../doc/html/manual/appendix_gpl.html | 2 +- libstdc++-v3/doc/html/manual/index.html | 2 +- .../doc/html/manual/source_code_style.html | 3 ++ libstdc++-v3/doc/html/manual/status.html | 14 +++++----- .../doc/html/manual/using_concurrency.html | 2 +- libstdc++-v3/doc/xml/faq.xml | 18 +++++------- .../doc/xml/manual/appendix_contributing.xml | 7 +++-- libstdc++-v3/doc/xml/manual/spine.xml | 1 + 13 files changed, 47 insertions(+), 55 deletions(-) diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index 906f4ba6f10..17cc0f34b55 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,3 +1,10 @@ +2020-01-20 Jonathan Wakely + + * doc/xml/faq.xml: Fix grammar. + * doc/xml/manual/appendix_contributing.xml: Improve instructions. + * doc/xml/manual/spine.xml: Update copyright years. + * doc/html/*: Regenerate. + 2020-01-19 Eric S. Raymond * doc/xml/faq.xml: Update for SVN -> Git transition. diff --git a/libstdc++-v3/doc/html/api.html b/libstdc++-v3/doc/html/api.html index c1d3eb1de5c..fc27b5f98ae 100644 --- a/libstdc++-v3/doc/html/api.html +++ b/libstdc++-v3/doc/html/api.html @@ -38,4 +38,4 @@

In addition, a rendered set of man pages are available in the same location specified above. Start with C++Intro(3). -

+

\ No newline at end of file diff --git a/libstdc++-v3/doc/html/faq.html b/libstdc++-v3/doc/html/faq.html index 1f6934ef4c8..ac99835acf2 100644 --- a/libstdc++-v3/doc/html/faq.html +++ b/libstdc++-v3/doc/html/faq.html @@ -113,9 +113,8 @@ clauses 20 through 33 and annex D (prior to the 2017 standard the library clauses started with 17). For those who want to see exactly how far the project has come, or just want the latest - bleeding-edge code, the up-to-date source is available over - anonymous SVN, and can be browsed over the - web. + bleeding-edge code, the up-to-date source can be cloned via + Git.

N.B. The library is called libstdc++ not stdlibc++.

1.2.

@@ -260,24 +259,11 @@ mirrors. A full list of download sites is provided on the main GCC site.

- Current libstdc++ sources can always be checked out of the main - GCC source repository using the appropriate version control - tool. At this time, that tool - is Subversion. -

- Subversion, or SVN, is - one of several revision control packages. It was selected for GNU - projects because it's free (speech), free (beer), and very high - quality. The Subversion - home page has a better description. -

- The “anonymous client checkout” feature of SVN is - similar to anonymous FTP in that it allows anyone to retrieve - the latest libstdc++ sources. -

- For more information - see SVN - details. + Current libstdc++ sources can always be found in the main GCC source + repository, available using the appropriate version control tool. + At this time, that tool is Git. + For more details see the documentation on + using the Git repository.

3.3.

How do I know if it works?

Libstdc++ comes with its own validation testsuite, which includes diff --git a/libstdc++-v3/doc/html/index.html b/libstdc++-v3/doc/html/index.html index 6302b323bee..46475208895 100644 --- a/libstdc++-v3/doc/html/index.html +++ b/libstdc++-v3/doc/html/index.html @@ -1,6 +1,6 @@ -The GNU C++ Library

The GNU C++ Library

Short Contents

- Copyright (C) 2008-2019 +The GNU C++ Library

The GNU C++ Library

Short Contents

+ Copyright (C) 2008-2020 FSF

diff --git a/libstdc++-v3/doc/html/manual/appendix_contributing.html b/libstdc++-v3/doc/html/manual/appendix_contributing.html index 7c7bd5a2593..28c46555d91 100644 --- a/libstdc++-v3/doc/html/manual/appendix_contributing.html +++ b/libstdc++-v3/doc/html/manual/appendix_contributing.html @@ -90,14 +90,12 @@ easily and simply show the existing error or test new functionality.

  • - The patch itself. If you are accessing the SVN - repository use svn update; svn diff NEW; - else, use diff -cp OLD NEW ... If your + The patch itself. If you are using the Git repository use + git diff or git format-patch + to produce a patch; + otherwise, use diff -cp OLD NEW. If your version of diff does not support these options, then get the - latest version of GNU - diff. The SVN - Tricks wiki page has information on customising the - output of svn diff. + latest version of GNU diff.

  • When you have all these pieces, bundle them up in a mail message and send it to libstdc++@gcc.gnu.org. All diff --git a/libstdc++-v3/doc/html/manual/appendix_gpl.html b/libstdc++-v3/doc/html/manual/appendix_gpl.html index 119d623389a..e5189e3720b 100644 --- a/libstdc++-v3/doc/html/manual/appendix_gpl.html +++ b/libstdc++-v3/doc/html/manual/appendix_gpl.html @@ -675,7 +675,7 @@ under certain conditions; type ‘show c’ for det subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this - License. But first, please read https://www.gnu.org/philosophy/why-not-lgpl.html. + License. But first, please read https://www.gnu.org/licenses/why-not-lgpl.html.

  • Chapter 1. Status

    Implementation Status

    C++ 1998/2003

    Implementation Status

    This status table is based on the table of contents of ISO/IEC 14882:2003.

    -This page describes the C++ support in mainline GCC SVN, not in any +This page describes the C++ support in mainline GCC, not in any particular release.

    Table 1.1. C++ 1998/2003 Implementation Status

    SectionDescriptionStatusComments
    18 @@ -155,7 +155,7 @@ options. The pre-defined symbol __cplusplus is used to check for the presence of the required flag.

    -This page describes the C++11 support in mainline GCC SVN, not in any +This page describes the C++11 support in mainline GCC, not in any particular release.

    Table 1.2. C++ 2011 Implementation Status

    SectionDescriptionStatusComments
    18 @@ -407,7 +407,7 @@ options. The pre-defined symbol __cplusplus is used to check for the presence of the required flag.

    -This page describes the C++14 and library TS support in mainline GCC SVN, +This page describes the C++14 and library TS support in mainline GCC, not in any particular release.

    Table 1.3. C++ 2014 Implementation Status

    PaperTitleStatusComments
    @@ -542,7 +542,7 @@ options. The pre-defined symbol __cplusplus is used to check for the presence of the required flag.

    -This section describes the C++17 and library TS support in mainline GCC SVN, +This section describes the C++17 and library TS support in mainline GCC, not in any particular release.

    The following table lists new library features that are included in @@ -1034,7 +1034,7 @@ options. The pre-defined symbol __cplusplus is used to check for the presence of the required flag.

    -This section describes the C++20 and library TS support in mainline GCC SVN, +This section describes the C++20 and library TS support in mainline GCC, not in any particular release.

    The following table lists new library features that have been accepted into @@ -1523,7 +1523,7 @@ In this implementation the header names are prefixed by tr1/, for instance <tr1/functional>, <tr1/memory>, and so on.

    -This page describes the TR1 support in mainline GCC SVN, not in any particular +This page describes the TR1 support in mainline GCC, not in any particular release.

    Table 1.8. C++ TR1 Implementation Status

    SectionDescriptionStatusComments
    2General Utilities
    2.1Reference wrappers  
    2.1.1Additions to header <functional> synopsisY 
    2.1.2Class template reference_wrapper  
    2.1.2.1reference_wrapper construct/copy/destroyY 
    2.1.2.2reference_wrapper assignmentY 
    2.1.2.3reference_wrapper accessY 
    2.1.2.4reference_wrapper invocationY 
    2.1.2.5reference_wrapper helper functionsY 
    2.2Smart pointers  
    2.2.1Additions to header <memory> synopsisY 
    2.2.2Class bad_weak_ptrY 
    2.2.3Class template shared_ptr 

    @@ -1544,7 +1544,7 @@ ISO/IEC TR 24733 Date: 2009-08-28 Extension for the programming language C++ to support decimal floating-point arithmetic

    -This page describes the TR 24733 support in mainline GCC SVN, not in any +This page describes the TR 24733 support in mainline GCC, not in any particular release.

    Table 1.9. C++ TR 24733 Implementation Status

    SectionDescriptionStatusComments
    0 diff --git a/libstdc++-v3/doc/html/manual/using_concurrency.html b/libstdc++-v3/doc/html/manual/using_concurrency.html index 436be0e2f5e..1b6ebed067d 100644 --- a/libstdc++-v3/doc/html/manual/using_concurrency.html +++ b/libstdc++-v3/doc/html/manual/using_concurrency.html @@ -158,7 +158,7 @@ gcc version 4.1.2 20070925 (Red Hat 4.1.2-33) }

    For further details of the C++11 memory model see Hans-J. Boehm's Threads - and memory model for C++ pages, particularly the introduction + and memory model for C++ pages, particularly the introduction and FAQ.

    Atomics

    IO

    This gets a bit tricky. Please read carefully, and bear with me. diff --git a/libstdc++-v3/doc/xml/faq.xml b/libstdc++-v3/doc/xml/faq.xml index 21c312dce35..aff6c8d6004 100644 --- a/libstdc++-v3/doc/xml/faq.xml +++ b/libstdc++-v3/doc/xml/faq.xml @@ -34,8 +34,8 @@ clauses 20 through 33 and annex D (prior to the 2017 standard the library clauses started with 17). For those who want to see exactly how far the project has come, or just want the latest - bleeding-edge code, the up-to-date source , and can be cloned via Git: see - web. + bleeding-edge code, the up-to-date source can be cloned via + Git. @@ -295,15 +295,11 @@ download sites is provided on the main GCC site. - Current libstdc++ sources can always be checked out of the main - GCC source repository using the appropriate version control - tool. At this time, that tool - is Git. - - - For more information - see - details. + Current libstdc++ sources can always be found in the main GCC source + repository, available using the appropriate version control tool. + At this time, that tool is Git. + For more details see the documentation on + using the Git repository. diff --git a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml index d2913b1663c..79fa0ed32b8 100644 --- a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml +++ b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml @@ -170,9 +170,10 @@ - The patch itself. If you are accessing the Git - repository use git pull; git diff >NEW; - else, use diff -cp OLD NEW ... If your + The patch itself. If you are using the Git repository use + git diff or git format-patch + to produce a patch; + otherwise, use diff -cp OLD NEW. If your version of diff does not support these options, then get the latest version of GNU diff. diff --git a/libstdc++-v3/doc/xml/manual/spine.xml b/libstdc++-v3/doc/xml/manual/spine.xml index a2cc1294e73..4db3037ac4d 100644 --- a/libstdc++-v3/doc/xml/manual/spine.xml +++ b/libstdc++-v3/doc/xml/manual/spine.xml @@ -27,6 +27,7 @@ 2017 2018 2019 + 2020 FSF -- 2.30.2