From f0bb873672d194163ce75f1ab5c30d9c8bf03ecc Mon Sep 17 00:00:00 2001 From: Jonathan Wakely Date: Fri, 6 Jun 2014 15:36:22 +0100 Subject: [PATCH] faq.xml (faq.stream_reopening_fails): Replace in code example. * doc/xml/faq.xml (faq.stream_reopening_fails): Replace in code example. * doc/xml/manual/backwards_compatibility.xml (backwards.second.stringstreams): Likewise. * doc/xml/manual/configure.xml (--enable-libstdcxx-time): Document change of default. * doc/xml/manual/containers.xml (associative.bitset.type_string): Replace in code example. * doc/xml/manual/debug.xml: Clarify reference to ThreadSanitizer. * doc/xml/manual/documentation_hacking.xml: Improve debugging tips, fix typos, improve markup. * doc/xml/manual/intro.xml (manual.intro.status.bugs.iso): Replace with . * doc/xml/manual/locale.xml (locale.impl.c): Remove backticks. * doc/xml/manual/support.xml (std.support.memory): Replace and remove newlines in string literal. From-SVN: r211316 --- libstdc++-v3/ChangeLog | 19 +++++++ libstdc++-v3/doc/xml/faq.xml | 4 +- .../xml/manual/backwards_compatibility.xml | 2 +- libstdc++-v3/doc/xml/manual/configure.xml | 3 +- libstdc++-v3/doc/xml/manual/containers.xml | 4 +- libstdc++-v3/doc/xml/manual/debug.xml | 3 +- .../doc/xml/manual/documentation_hacking.xml | 52 +++++++++++++------ libstdc++-v3/doc/xml/manual/intro.xml | 10 ++-- libstdc++-v3/doc/xml/manual/locale.xml | 2 +- libstdc++-v3/doc/xml/manual/support.xml | 8 +-- 10 files changed, 74 insertions(+), 33 deletions(-) diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index 976ce975736..0c6b333a86c 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,3 +1,22 @@ +2014-06-06 Jonathan Wakely + + * doc/xml/faq.xml (faq.stream_reopening_fails): Replace in + code example. + * doc/xml/manual/backwards_compatibility.xml + (backwards.second.stringstreams): Likewise. + * doc/xml/manual/configure.xml (--enable-libstdcxx-time): Document + change of default. + * doc/xml/manual/containers.xml (associative.bitset.type_string): + Replace in code example. + * doc/xml/manual/debug.xml: Clarify reference to ThreadSanitizer. + * doc/xml/manual/documentation_hacking.xml: Improve debugging tips, + fix typos, improve markup. + * doc/xml/manual/intro.xml (manual.intro.status.bugs.iso): Replace + with . + * doc/xml/manual/locale.xml (locale.impl.c): Remove backticks. + * doc/xml/manual/support.xml (std.support.memory): Replace + and remove newlines in string literal. + 2014-06-03 Paolo Carlini DR 1423 diff --git a/libstdc++-v3/doc/xml/faq.xml b/libstdc++-v3/doc/xml/faq.xml index 69e2f902200..154e6107630 100644 --- a/libstdc++-v3/doc/xml/faq.xml +++ b/libstdc++-v3/doc/xml/faq.xml @@ -801,12 +801,12 @@ #include <fstream> ... - std::fstream fs(a_file); + std::fstream fs("a_file"); // . // . do things with fs... // . fs.close(); - fs.open(a_new_file); + fs.open("a_new_file"); diff --git a/libstdc++-v3/doc/xml/manual/backwards_compatibility.xml b/libstdc++-v3/doc/xml/manual/backwards_compatibility.xml index 89c7cc683ea..59da85ef3f6 100644 --- a/libstdc++-v3/doc/xml/manual/backwards_compatibility.xml +++ b/libstdc++-v3/doc/xml/manual/backwards_compatibility.xml @@ -412,7 +412,7 @@ erase(size_type __pos = 0, size_type __n = npos) std::ostrstream oss; #endif -oss << Name= << m_name << , number= << m_number << std::endl; +oss << "Name=" << m_name << ", number=" << m_number << std::endl; ... #ifndef HAVE_SSTREAM oss << std::ends; // terminate the char*-string diff --git a/libstdc++-v3/doc/xml/manual/configure.xml b/libstdc++-v3/doc/xml/manual/configure.xml index 1c099722549..717cca713ee 100644 --- a/libstdc++-v3/doc/xml/manual/configure.xml +++ b/libstdc++-v3/doc/xml/manual/configure.xml @@ -185,7 +185,8 @@ desirable because, in glibc, for example, in turn it triggers the linking of libpthread too, which activates locking, a large overhead for single-thread programs. OPTION=no skips the tests completely. - The default is OPTION=no. + The default is OPTION=auto, which skips the checks and enables the + features only for targets known to support them. diff --git a/libstdc++-v3/doc/xml/manual/containers.xml b/libstdc++-v3/doc/xml/manual/containers.xml index 9fea0f7ea1c..ec2cb21c494 100644 --- a/libstdc++-v3/doc/xml/manual/containers.xml +++ b/libstdc++-v3/doc/xml/manual/containers.xml @@ -334,7 +334,7 @@ constructor expression: - std::bitset<5> b ( std::string(10110) ); + std::bitset<5> b ( std::string("10110") ); @@ -342,7 +342,7 @@ - std::bitset<5> b ( 10110 ); // invalid + std::bitset<5> b ( "10110" ); // invalid diff --git a/libstdc++-v3/doc/xml/manual/debug.xml b/libstdc++-v3/doc/xml/manual/debug.xml index 5e84495b67d..923f6ab8613 100644 --- a/libstdc++-v3/doc/xml/manual/debug.xml +++ b/libstdc++-v3/doc/xml/manual/debug.xml @@ -235,7 +235,8 @@ Helgrind, and - ThreadSanitizer. + ThreadSanitizer (this refers to ThreadSanitizer v1, not the + new "tsan" feature built-in to GCC itself). diff --git a/libstdc++-v3/doc/xml/manual/documentation_hacking.xml b/libstdc++-v3/doc/xml/manual/documentation_hacking.xml index 59f8445473e..ba53721171b 100644 --- a/libstdc++-v3/doc/xml/manual/documentation_hacking.xml +++ b/libstdc++-v3/doc/xml/manual/documentation_hacking.xml @@ -274,7 +274,9 @@ Graphviz package will need to be installed. For PDF output, - pdflatex is required. + pdflatex is required as well as a number of TeX packages + such as texlive-xtab and + texlive-tocloft. @@ -360,8 +362,8 @@ Working on the doxygen path only, closely examine the - contents of the following build directory: - build/target/libstdc++-v3/doc/doxygen/latex. + contents of the following build directory: build/target/libstdc++-v3/doc/doxygen/latex. Pay attention to three files enclosed within, annotated as follows. @@ -375,18 +377,36 @@ The actual latex file, or partial latex file. This is generated via doxygen, and is the LaTeX version of the Doxygen XML file libstdc++-api.xml. Go to a specific - line, and look at the genrated LaTeX, and try to deduce what + line, and look at the generated LaTeX, and try to deduce what markup in libstdc++-api.xml is causing it. + + + refman.log + + + + A log created by latex as it processes the + refman.tex file. If generating the PDF fails + look at the end of this file for errors such as: + + ! LaTeX Error: File `xtab.sty' not found. + + This indicates a required TeX package is missing. For the example + above the texlive-xtab package needs to be + installed. + + + refman.out - A log of the compilation of the converted LaTeX form to pdf. This + A log of the compilation of the converted LaTeX form to PDF. This is a linear list, from the beginning of the refman.tex file: the last entry of this file should be the end of the LaTeX file. If it is truncated, then you @@ -436,9 +456,9 @@ deque/vector/list and std::pair as examples. For functions, see their member functions, and the free functions - in stl_algobase.h. Member functions of - other container-like types should read similarly to these - member functions. + in stl_algobase.h. Member + functions of other container-like types should read similarly to + these member functions. @@ -488,8 +508,8 @@ Use either kind of grouping, as appropriate. doxygroups.cc exists for this - purpose. See stl_iterator.h for a good example - of the other kind of grouping. + purpose. See stl_iterator.h + for a good example of the other kind of grouping. @@ -500,8 +520,8 @@ - Complicated math functions should use the multi-line - format. An example from random.h: + Complicated math functions should use the multi-line format. + An example from random.h: @@ -535,9 +555,9 @@ The other relevant detail for header files is the use of a libstdc++-specific doxygen alias that helps distinguish - between public header files (like random) + between public header files (like random) from implementation or private header files (like - bits/c++config.h.) This alias is spelled + bits/c++config.h.) This alias is spelled @headername and can take one or two arguments that detail the public header file or files that should be included to use the contents of the file. All header @@ -827,7 +847,7 @@ make XSL_STYLE_DIR="/usr/share/xml/docbook/stylesheet/nwalsh" Working on the docbook path only, closely examine the contents of the following build directory: - build/target/libstdc++-v3/doc/docbook/latex. + build/target/libstdc++-v3/doc/docbook/latex. Pay attention to three files enclosed within, annotated as follows. @@ -842,7 +862,7 @@ make XSL_STYLE_DIR="/usr/share/xml/docbook/stylesheet/nwalsh" The actual latex file, or partial latex file. This is generated via dblatex, and is the LaTeX version of the DocBook XML file spine.xml. Go to a specific - line, and look at the genrated LaTeX, and try to deduce what + line, and look at the generated LaTeX, and try to deduce what markup in spine.xml is causing it. diff --git a/libstdc++-v3/doc/xml/manual/intro.xml b/libstdc++-v3/doc/xml/manual/intro.xml index cb141865780..a71a9f9090c 100644 --- a/libstdc++-v3/doc/xml/manual/intro.xml +++ b/libstdc++-v3/doc/xml/manual/intro.xml @@ -825,11 +825,11 @@ requirements of the license of GCC. - get gcc sources - extract into gccsrcdir - mkdir gccbuilddir - cd gccbuilddir - gccsrcdir/configure --prefix=destdir --other-opts... + get gcc sources + extract into gccsrcdir + mkdir gccbuilddir + cd gccbuilddir + gccsrcdir/configure --prefix=destdir --other-opts... make make check make install diff --git a/libstdc++-v3/doc/xml/manual/locale.xml b/libstdc++-v3/doc/xml/manual/locale.xml index 8a780950605..01ea1895e95 100644 --- a/libstdc++-v3/doc/xml/manual/locale.xml +++ b/libstdc++-v3/doc/xml/manual/locale.xml @@ -111,7 +111,7 @@ portability is an issue. - `locale -a` displays available locales. + locale -a displays available locales.
diff --git a/libstdc++-v3/doc/xml/manual/support.xml b/libstdc++-v3/doc/xml/manual/support.xml index 410f7140347..573869a8ee4 100644 --- a/libstdc++-v3/doc/xml/manual/support.xml +++ b/libstdc++-v3/doc/xml/manual/support.xml @@ -248,9 +248,9 @@ void my_new_handler () { delete[] safety; - popup_window ("Dude, you are running low on heap memory. You - should, like, close some windows, or something. - The next time you run out, we're gonna burn!"); + popup_window ("Dude, you are running low on heap memory. You" + " should, like, close some windows, or something." + " The next time you run out, we're gonna burn!"); set_new_handler (old_handler); return; } @@ -384,7 +384,7 @@ int main(int argc) { std::set_terminate(__gnu_cxx::__verbose_terminate_handler); if (argc > 5) - throw argument_error(argc is greater than 5!); + throw argument_error("argc is greater than 5!"); else throw argc; }