From: Benjamin Kosnik Date: Wed, 24 Jul 2002 07:55:34 +0000 (+0000) Subject: documentation.html: Remove libstdc++-v3.0.86 links... X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6364054f3ae2db85eed718152cce6a21c313fa72;p=platform%2Fupstream%2Fgcc.git documentation.html: Remove libstdc++-v3.0.86 links... 2002-07-23 Benjamin Kosnik * docs/html/documentation.html: Remove libstdc++-v3.0.86 links, confusing usage of "latest." De-tangle contributor information from introductory notes. Move abi.txt link placement, activate. Re-organize. Move chapter info into old FAQ format. * docs/html/organization.html: Removed, obsoleted by doxygen work. * docs/html/abi.txt: Add notes on testing ABI changes. From-SVN: r55702 --- diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index 7c752b0..a6fcda0 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,3 +1,14 @@ +2002-07-23 Benjamin Kosnik + + * docs/html/documentation.html: Remove libstdc++-v3.0.86 links, + confusing usage of "latest." + De-tangle contributor information from introductory notes. + Move abi.txt link placement, activate. + Re-organize. + Move chapter info into old FAQ format. + * docs/html/organization.html: Removed, obsoleted by doxygen work. + * docs/html/abi.txt: Add notes on testing ABI changes. + 2002-07-20 Phil Edwards * docs/html/abi.txt: New file. diff --git a/libstdc++-v3/docs/html/17_intro/organization b/libstdc++-v3/docs/html/17_intro/organization deleted file mode 100644 index 828a811..0000000 --- a/libstdc++-v3/docs/html/17_intro/organization +++ /dev/null @@ -1,84 +0,0 @@ -20 [lib.utilities] - - namespace rel_ops { operators !=, >, <=, >= } - struct pair; - pair binary operators { operators ==, <, !=, >, >=, <= } - - // function objects, or objects with operator() defined - - template class allocator; - template<> class allocator; - template class raw_storage_iterator; - temporary buffers - specialized algorithms for uninitialized_{copy, fill, fill_n} - template class auto_ptr; - - - - -21 [lib.strings] - - template struct char_traits - template<> struct char_traits - template<> struct char_traits - template, A=a > class basic_string; - - typedef basic_string string; - typedef basic_string wstring; - - template void swap(string&, string&) - template istream& operator>>(istream&, string&); - template istream& getline(istream&, string&, C); - template istream& getline(istream&, string&); - template ostream& operator<<(ostream&, string&); - - - - - - -23 [lib.containers] - - - - - - - - - -24 [lib.iterators] - - -25 [lib.algorithms] - - non-modifying sequence operations - for_each, find, find_if, find_end, find_first_of, - adjacent_find, count, count_if, mismatch, equal, - search, search_n - modifying sequence operations - copy, copy_backward, swap, swap_ranges, iter_swap, - transform, replace, replace_if, replace_copy, - replace_copy_if, fill, fill_n, generate, generate_n, - remove, remove_if, remove_copy, remove_copy_if, unique, - unique_copy, reverse, reverse_copy, rotate, - rotate_copy, random_shuffle - sorting and related operations - sort, stable_sort, partial_sort, partial_sort_copy, - nth_element, lower_bound, upper_bound, equal_range, - binary_search, merge, inplace_merge, includes, - set_union, set_intersection, set_difference, - set_symmetric_difference, push_heap, pop_heap, - make_heap, sort_heap, min, max, min_element, - max_element, lexicographical_compare, next_permutation, - prev_permutation - - - - - - - - - - diff --git a/libstdc++-v3/docs/html/abi.txt b/libstdc++-v3/docs/html/abi.txt index 6c0ae1e..cbb0426 100644 --- a/libstdc++-v3/docs/html/abi.txt +++ b/libstdc++-v3/docs/html/abi.txt @@ -6,7 +6,7 @@ document exists, why it's incomplete, and what needs to be done still. =========================== -2002-07-01 Benjamin Kosnik +2002-07-23 Benjamin Kosnik Description of the libstdc++ ABI. @@ -123,9 +123,37 @@ III. Versioning IV. Testing ABI changes -- 'make check-abi'?? - -- other ABI checkers +Currently, there is no formal testing for changes in the libstdc++ +ABI. It would be in the best interest of GNU C++ users everywhere to +have such a test, and work to develop this test is ongoing. + +There is a formal method for checking the compiler parts of the C++ +ABI, donated by Intel. More information can be obtained +here. + +To test the library, the following two ideas have been suggested: + +One. +(Brendan Kehoe, Jeff Law suggestion to run 'make check-c++' two ways, +one with a new compiler and an old library, and the other with an old +compiler and a new library, and look for testsuite regressions) + +Two. +Have the libstdc++ testesuite proactively check the library +ABI. Probably a couple of items would be covered, although perhaps not +all would need to be done at once for this to be useful. Compute the +list of names exported in the shared version of libstdc++ +binary. Then, save this list of names. Have this list of names +re-computed for each new binary of the same version. Next, use sizeof +and offset to compute offsets for each structure and type in the +standard library, saving to another datafile. Then, compute this for +new binaries, and look for differences. + +The thought is to choose one or both of these approaches, and to use a +Makefile hook, perhaps 'make check-abi', to add this capability to the +libstdc++ testsuite. + +Perhaps there are other Library ABI checkers. If so, please notify us. V. Issues not directly addressed, and possible suggestions diff --git a/libstdc++-v3/docs/html/documentation.html b/libstdc++-v3/docs/html/documentation.html index 09ead96..72e0aa4 100644 --- a/libstdc++-v3/docs/html/documentation.html +++ b/libstdc++-v3/docs/html/documentation.html @@ -1,7 +1,8 @@ - - Standard C++ Library v3 + + GNU C++ Standard Library @@ -13,103 +14,215 @@ automatically-generated source documentation, available separately.

+
+
+

Introduction

+

This is a short list of text files pertaining to this implementation of + ISO 14882. A brief description may follow the name of the file. +

+

-

Source Documentation

-

In addition to the distribution documentation (these pages), we also - have a set of HTML documents generated from the sources themselves, - using the Doxygen tool. These are useful for examining the signatures - of public member functions for the library classes, etc. -

-

The collections are available in the libstdc++ snapshots directory at - <URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/>. - You will almost certainly need to use one of the - mirror sites to download - the tarball. After unpacking, simply load libstdc++-html-*/index.html - into a browser. Feedback (and additional documentation!) is welcome. + +

+
+

Configuring, Building, Installing

+ + + +
+
+

Source-Level Documentation

+

The library sources have been specially formatted so that with the + proper invocation of another tool (Doxygen), a set of HTML pages + are generated from the sources files themselves. The resultant + documentation is referred to as Source-Level Documentation, and is + useful for examining the signatures of public member functions for + the library classes, finding out what is in a particular include + file, looking at inheritance diagrams, etc.

-

The available user-level collections are also viewable online: +

The Source-Level documentation can be viewed online:

- Other collections (man pages, maintainer docs) are only available on the - FTP sites.

- -

Beginning with 3.0.95, an initial set of man pages are also available in - the same place as the HTML collections. Start with Intro(3). +

This generated HTML collection, as above, is also available for download in + the libstdc++ snapshots directory at + <URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/>. + You will almost certainly need to use one of the mirror sites to download + the tarball. After unpacking, simply load + libstdc++-html-*/index.html into a browser. Feedback (and + additional documentation!) is welcome. +

+

+ In addition, an initial set of man pages are also available in the + same place as the HTML collections. Start with Intro(3).

-
- -

Configuring, Building, Installing

-
+
+

Chapter-Specific Documentation

+

Information, extensions, notes and advice on specific implementation + capabilites and or liabilities broken down into chapter names based on the + C++ standard. +

+ -

Introductory notes for libstdc++

-

This is a short list of text files pertaining to this implementation of - ISO 14882. A brief description follows the name of the file. +

+
+

Contributor-Specific Information

-

- -
- -

Chapter-Specific Information, Extensions, Notes and Advice

-
    -
  1. Chapter 17 (Intro) -
  2. Chapter 18 (Library Support) -
  3. Chapter 19 (Diagnostics) -
  4. Chapter 20 (Utilities) -
  5. Chapter 21 (Strings) -
  6. Chapter 22 (Localization) -
  7. Chapter 23 (Containers) -
  8. Chapter 24 (Iterators) -
  9. Chapter 25 (Algorithms) -
  10. Chapter 26 (Numerics) -
  11. Chapter 27 (I/O) -
  12. Extensions to the Standard Library -
-

Return to the libstdc++ homepage.

-
+

See license.html for copying conditions. Comments and suggestions are welcome, and may be sent to