From c60cd1dcf7a8c5d20ad41ba781d562ebc5dca45c Mon Sep 17 00:00:00 2001 From: Benjamin Kosnik Date: Wed, 21 Nov 2007 16:37:26 +0000 Subject: [PATCH] documentation.html: Validate. 2007-11-20 Benjamin Kosnik * docs/html/documentation.html: Validate. Add links to index, correct broken links. * docs/html/17_intro/C++STYLE: Add bits. * docs/html/17_intro/configury.html: Correct, update. * docs/html/17_intro/api.html: Correct HTML. * include/bits/stl_algobase.h: Adjust comment. From-SVN: r130331 --- libstdc++-v3/ChangeLog | 10 +++ libstdc++-v3/docs/html/17_intro/C++STYLE | 29 +++++-- libstdc++-v3/docs/html/17_intro/api.html | 2 +- .../docs/html/17_intro/configury.html | 44 +++++++---- libstdc++-v3/docs/html/documentation.html | 75 +++++++++++-------- libstdc++-v3/include/bits/stl_algobase.h | 3 +- 6 files changed, 107 insertions(+), 56 deletions(-) diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index 452223a6db4..91914689186 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,3 +1,13 @@ +2007-11-20 Benjamin Kosnik + + * docs/html/documentation.html: Validate. Add links to index, + correct broken links. + * docs/html/17_intro/C++STYLE: Add bits. + * docs/html/17_intro/configury.html: Correct, update. + * docs/html/17_intro/api.html: Correct HTML. + + * include/bits/stl_algobase.h: Adjust comment. + 2007-11-20 Richard Sandiford * testsuite/ext/throw_allocator/variadic_construct.cc: Add diff --git a/libstdc++-v3/docs/html/17_intro/C++STYLE b/libstdc++-v3/docs/html/17_intro/C++STYLE index 87f53d0ea05..45fad2743de 100644 --- a/libstdc++-v3/docs/html/17_intro/C++STYLE +++ b/libstdc++-v3/docs/html/17_intro/C++STYLE @@ -1,12 +1,21 @@ -C++ Standard Library Style Guidelines DRAFT 2001-01-15 +C++ Standard Library Coding Style Guidelines ------------------------------------- This library is written to appropriate C++ coding standards. As such, it is intended to precede the recommendations of the GNU Coding -Standard, which can be referenced here: +Standard, which can be referenced in full here: -http://www.gnu.org/prep/standards_toc.html +http://www.gnu.org/prep/standards/standards.html#Formatting + +The rest of this is also interesting reading, but skip the "Design +Advice" part. + +The GCC coding conventions are here, are are also useful: +http://gcc.gnu.org/codingconventions.html + +In addition, because it doesn't seem to be stated explicitly anywhere +else, there is an 80 column source limit. ChangeLog entries for member functions should use the classname::member function name syntax as follows: @@ -220,6 +229,9 @@ Notable areas of divergence from what may be previous local practice give useful error messages, and programmers can intelligently speculate what went wrong without even using a debugger. +17. The doxygen style guide to comments is a separate document, + see index. + The library currently has a mixture of GNU-C and modern C++ coding styles. The GNU C usages will be combed out gradually. @@ -264,7 +276,6 @@ namespace std class gribble { public: - // ctor, op=, dtor gribble() throw(); gribble(const gribble&); @@ -278,11 +289,11 @@ namespace std virtual ~gribble() throw (); - // argument + // Start with a capitol letter, end with a period. inline void public_member(const char* __arg) const; - // in-class function definitions should be restricted to one-liners. + // In-class function definitions should be restricted to one-liners. int one_line() { return 0 } @@ -293,7 +304,7 @@ namespace std inline int three_lines(); // inline, but defined below. - // note indentation + // Note indentation. template void public_template() const throw(); @@ -320,7 +331,7 @@ namespace std _S_initialize_library(); }; -// More-or-less-standard language features described by lack, not presence: +// More-or-less-standard language features described by lack, not presence. # ifndef _G_NO_LONGLONG extern long long _G_global_with_a_good_long_name; // avoid globals! # endif @@ -384,3 +395,5 @@ namespace std } } // namespace std + + diff --git a/libstdc++-v3/docs/html/17_intro/api.html b/libstdc++-v3/docs/html/17_intro/api.html index 50c8604405a..bfe7b20371d 100644 --- a/libstdc++-v3/docs/html/17_intro/api.html +++ b/libstdc++-v3/docs/html/17_intro/api.html @@ -52,7 +52,7 @@ details were not pried away from the estate.

At least some older implementations don't have std::ios_base, so you should use std::ios::badbit, std::ios::failbit and std::ios::eofbit and std::ios::goodbit.

-
No cout in ostream.h, no cin in istream.h +
No cout in ostream.h, no cin in istream.h

In earlier versions of the standard, diff --git a/libstdc++-v3/docs/html/17_intro/configury.html b/libstdc++-v3/docs/html/17_intro/configury.html index 1c9acf2e137..a35ccf23996 100644 --- a/libstdc++-v3/docs/html/17_intro/configury.html +++ b/libstdc++-v3/docs/html/17_intro/configury.html @@ -34,30 +34,46 @@ No problem is insoluble in all conceivable circumstances.
Last Question, by Isaac Asimov

-

what comes from where

+

Prerequisites for configure and make hacking

+ +

As +noted previously, +certain other tools are necessary for hacking on files that control +configure (configure.ac, acinclude.m4) and +make (Makefile.am). These additional tools +(automake, and autoconf) are further +described in detail in their respective manuals. All the libraries in GCC try to stay in sync with each other in terms of versions of the auto-tools used, so please try to play nicely with the neighbors. +

+ + +
+

Overview: what comes from where

Dependency graph in PNG graphics format. (Get a better browser!)

-

Regenerate using a command sequence like - "aclocal-1.7 && autoconf-2.59 && autoheader-2.59 - && automake-1.7" as needed. And/or configure with - --enable-maintainer-mode. The version numbers will vary depending on +

Regenerate all generated files by using the command sequence + "autoreconf" at the top level of the libstdc++ source + directory. The following will also work, but is much more complex: + "aclocal-1.7 && autoconf-2.59 && + autoheader-2.59 && automake-1.7" The version numbers + may be absent entirely or otherwise vary depending on the current requirements and your vendor's choice of installation names.

-

storing information in non-AC files, like +

Storing information in non-AC files, like configure.host

Until that glorious day when we can use AC_TRY_LINK with a cross-compiler, we have to hardcode the results of what the tests would have shown if @@ -82,7 +98,7 @@ Last Question, by Isaac Asimov

-

general config notes

+

Coding and commenting conventions

Lots of stuff got thrown out because the new autotools kindly generate the same (or better) shell code for us.

@@ -108,7 +124,7 @@ Last Question, by Isaac Asimov

-

acinclude.m4 layout

+

The acinclude.m4 layout

The nice thing about acinclude.m4/aclocal.m4 is that macros aren't actually performed/called/expanded/whatever here, just loaded. So we can arrange the contents however we like. As of this writing, acinclude.m4 is arranged @@ -186,7 +202,7 @@ Last Question, by Isaac Asimov

-

--enable howto

+

GLIBCXX_ENABLE, the --enable howto

All the GLIBCXX_ENABLE_FOO macros use a common helper, GLIBCXX_ENABLE. (You don't have to use it, but it's easy.) The helper does two things for us: diff --git a/libstdc++-v3/docs/html/documentation.html b/libstdc++-v3/docs/html/documentation.html index f14d1b65477..92ce87b065a 100644 --- a/libstdc++-v3/docs/html/documentation.html +++ b/libstdc++-v3/docs/html/documentation.html @@ -57,51 +57,53 @@ href="http://gcc.gnu.org/svn.html">web.

  • License
    • -
  • Known Bugs
    • +
  • Known Bugs
    • -
  • Configuring, Building, Testing, Installing +
  • Configuring, Building, Testing, Installing -
    • + -
  • Using the Library +
  • Using the Library
    • @@ -130,15 +132,18 @@ href="http://gcc.gnu.org/svn.html">web.

    diff --git a/libstdc++-v3/include/bits/stl_algobase.h b/libstdc++-v3/include/bits/stl_algobase.h index f9f3be15cac..32dfacd68ef 100644 --- a/libstdc++-v3/include/bits/stl_algobase.h +++ b/libstdc++-v3/include/bits/stl_algobase.h @@ -1,4 +1,4 @@ -// Bits and pieces used in algorithms -*- C++ -*- +// Core algorithmic facilities -*- C++ -*- // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007 // Free Software Foundation, Inc. @@ -1084,7 +1084,6 @@ _GLIBCXX_END_NESTED_NAMESPACE // of getting the base algorithms. So, make sure that parallel bits // come in too if requested. #ifdef _GLIBCXX_PARALLEL -//# include # include #endif