Skip to content

R
riscv-gcc-1
Commit 66fda8b2 by Benjamin Kosnik Committed by Benjamin Kosnik
Options

re PR libstdc++/15123 (libstdc++-doc: Allocators.3 manpage is empty) 


2004-05-20  Benjamin Kosnik  <bkoz@redhat.com>

	PR libstdc++/15123
	PR libstdc++/13928
	* docs/doxygen/Intro.3: Remove Allocators.3.
	Add new extension headers, extension namespace list.
	* docs/doxygen/run_doxygen (problematic): Remove Allocators.3
	Rename GLIBCXXSTD names to std::. Rename __gnu_debug to
	__gnu_debug::. Remove __policy_ renames.
	* docs/doxygen/guide.html: Add dot note.
	* docs/doxygen/stdheader.cc: Edit, add files.
	* docs/doxygen/user.cfg.in: Regenerate with Doxygen 1.3.7.

From-SVN: r82066
parent 52fe4de8
Showing with 73 additions and 28 deletions
libstdc++-v3/ChangeLog
2004-05-20 Benjamin Kosnik <bkoz@redhat.com>
PR libstdc++/15123
PR libstdc++/13928
* docs/doxygen/Intro.3: Remove Allocators.3.
Add new extension headers, extension namespace list.
* docs/doxygen/run_doxygen (problematic): Remove Allocators.3
Rename GLIBCXXSTD names to std::. Rename __gnu_debug to
__gnu_debug::. Remove __policy_ renames.
* docs/doxygen/guide.html: Add dot note.
* docs/doxygen/stdheader.cc: Edit, add files.
* docs/doxygen/user.cfg.in: Regenerate with Doxygen 1.3.7.
2004-05-18 Jonathan Wakely <redi@gcc.gnu.org> 2004-05-18 Jonathan Wakely <redi@gcc.gnu.org>
* include/ext/stdio_filebuf.h: Update comments to reflect PR 11691. * include/ext/stdio_filebuf.h: Update comments to reflect PR 11691.
......
libstdc++-v3/docs/doxygen/Intro.3
.\" t .\" t
.\" This man page is released under the FDL as part of libstdc++-v3. .\" This man page is released under the FDL as part of libstdc++-v3.
.TH C++Intro 3 "25 Febuary 2003" "GNU libstdc++-v3" "Standard C++ Library" .TH C++Intro 3 "20 May 2004" "GNU libstdc++-v3" "Standard C++ Library"
.SH NAME .SH NAME
C++Intro \- Introduction to the GNU libstdc++-v3 man pages C++Intro \- Introduction to the GNU libstdc++-v3 man pages
.SH DESCRIPTION .SH DESCRIPTION
...@@ -16,7 +16,7 @@ and have manual entries beginning with "std::". For example, to see ...@@ -16,7 +16,7 @@ and have manual entries beginning with "std::". For example, to see
documentation of the template class documentation of the template class
.I std::vector .I std::vector
one would use "man std::vector". Some entities do not have a separate man one would use "man std::vector". Some entities do not have a separate man
page; for those see the main listing in "man Namespace_Std". page; for those see the main listing in "man Namespace_std".
.P .P
All the man pages are automatically generated by Doxygen. For more All the man pages are automatically generated by Doxygen. For more
information on this tool, see the HTML counterpart to these man pages. information on this tool, see the HTML counterpart to these man pages.
...@@ -30,22 +30,23 @@ or Austern's.) These category pages are: ...@@ -30,22 +30,23 @@ or Austern's.) These category pages are:
.\" Keep them alphabatized. .\" Keep them alphabatized.
.TS .TS
lB l. lB l.
Allocators Classes encapsulating memory allocation schemes. C++Intro This page.
Arithmetic_functors Functors for basic math. Namespace_std A listing of the contents of std::.
Namespace___gnu_cxx A listing of the contents of __gnu_cxx::.
Containers An introduction to container classes.
Sequences Linear containers.
Assoc_containers Key-based containers. Assoc_containers Key-based containers.
Iterator_types Programatically distinguishing iterators/pointers.
Intro_functors An introduction to function objects, or functors.
Arithmetic_functors Functors for basic math.
Binder_functors Functors which "remember" an argument. Binder_functors Functors which "remember" an argument.
Comparison_functors Functors wrapping built-in comparisons. Comparison_functors Functors wrapping built-in comparisons.
Containers An introduction to container classes.
Func_ptr_functors Functors for use with pointers to functions. Func_ptr_functors Functors for use with pointers to functions.
C++Intro This page.
Intro_functors An introduction to function objects, or functors.
Iterator_types Programatically distinguishing iterators/pointers.
Logical_functors Functors wrapping the Boolean operations. Logical_functors Functors wrapping the Boolean operations.
Member_ptr_functor Functors for use with pointers to members. Member_ptr_functor Functors for use with pointers to members.
Namespace_Std A listing of the contents of std::.
Negation_functors Functors which negate their contents. Negation_functors Functors which negate their contents.
SGIextensions A list of the extensions from the SGI STL subset. SGIextensions A list of the extensions from the SGI STL subset.
Sequences Linear containers.
.TE .TE
.P .P
The HTML documentation typically goes into much more depth. The HTML documentation typically goes into much more depth.
...@@ -94,10 +95,16 @@ in the name. Otherwise you need to read FAQ 5.4. ...@@ -94,10 +95,16 @@ in the name. Otherwise you need to read FAQ 5.4.
.\" Easy way to generate these columns of headers is to use GNU ls(1): .\" Easy way to generate these columns of headers is to use GNU ls(1):
.\" ls -w 40 file1 file2... | sed 's=[a-z_][a-z_]*=<ext/&>=g' .\" ls -w 40 file1 file2... | sed 's=[a-z_][a-z_]*=<ext/&>=g'
.TS .TS
lB. lB lB.
<ext/algorithm> <ext/hash_set> <ext/numeric> <ext/slist> <ext/algorithm> <ext/numeric>
<ext/functional> <ext/iterator> <ext/rb_tree> <ext/functional> <ext/iterator>
<ext/hash_map> <ext/memory> <ext/rope> <ext/slist> <ext/rb_tree>
<ext/hash_map> <ext/hash_set>
<ext/rope> <ext/memory>
<ext/bitmap_allocator.h> <ext/debug_allocator.h>
<ext/malloc_allocator.h> <ext/mt_allocator.h>
<ext/pool_allocator.h> <ext/pod_char_traits.h>
<ext/stdio_filebuf.h> <ext/stdio_sync_filebuf.h>
.TE .TE
.SS Libraries .SS Libraries
.TP .TP
......
libstdc++-v3/docs/doxygen/guide.html
...@@ -34,6 +34,11 @@ ...@@ -34,6 +34,11 @@
<img src="doxygen.png" alt="Doxygen" align=center border=0 width=110 height=53> <img src="doxygen.png" alt="Doxygen" align=center border=0 width=110 height=53>
</a>, a working version of <code>g++</code> somewhere in the PATH, and </a>, a working version of <code>g++</code> somewhere in the PATH, and
the <a href="http://www.gnu.org/software/coreutils/">GNU coreutils</a>. the <a href="http://www.gnu.org/software/coreutils/">GNU coreutils</a>.
In addition, to generate the pretty pictures, the
<a href=
"http://www.research.att.com/sw/tools/graphviz/download.html">Graphviz</a>
package will need to be installed.
(g++ is used to build a program which manipulates man pages. GNU versions (g++ is used to build a program which manipulates man pages. GNU versions
of find, xargs, and possibly sed and grep are used, just because the GNU of find, xargs, and possibly sed and grep are used, just because the GNU
versions make things very easy.) versions make things very easy.)
......
libstdc++-v3/docs/doxygen/run_doxygen
...@@ -215,14 +215,14 @@ mv s20_3_5_negators.3 Negation_functors.3 ...@@ -215,14 +215,14 @@ mv s20_3_5_negators.3 Negation_functors.3
mv s20_3_6_binder.3 Binder_functors.3 mv s20_3_6_binder.3 Binder_functors.3
mv s20_3_7_adaptors.3 Func_ptr_functors.3 mv s20_3_7_adaptors.3 Func_ptr_functors.3
mv s20_3_8_memadaptors.3 Member_ptr_functors.3 mv s20_3_8_memadaptors.3 Member_ptr_functors.3
mv std.3 Namespace_Std.3
mv iterator_tags.3 Iterator_types.3 mv iterator_tags.3 Iterator_types.3
mv std.3 Namespace_std.3
mv __gnu_cxx.3 Namespace___gnu_cxx.3
# man pages are for functions/types/other entities, not source files # man pages are for functions/types/other entities, not source files
# directly. who the heck would type "man foo.h" anyhow? # directly. who the heck would type "man foo.h" anyhow?
find . -name "[a-z]*" -a ! -name "std_*" -print | xargs rm find . -name "[a-z]*" -a ! -name "std_*" -print | xargs rm
rm -f *.h.3 *config* *.cc.3 *.tcc.3 rm -f *.h.3 *config* *.cc.3 *.tcc.3 *_t.3
rm -f *_t.3 # workaround doxygen template parsing bug for now
# this is used to examine what we would have deleted, for debugging # this is used to examine what we would have deleted, for debugging
#mkdir trash #mkdir trash
#find . -name "[a-z]*" -a ! -name "std_*" -print | xargs -i mv {} trash #find . -name "[a-z]*" -a ! -name "std_*" -print | xargs -i mv {} trash
...@@ -247,8 +247,7 @@ rm stdheader ...@@ -247,8 +247,7 @@ rm stdheader
# implementations of man(1), e.g., Linux's. We need to have another top-level # implementations of man(1), e.g., Linux's. We need to have another top-level
# *roff tag to /stop/ the .SH NAME entry. # *roff tag to /stop/ the .SH NAME entry.
#problematic=`egrep --files-without-match '^\.SH SYNOPSIS' [A-Z]*.3` #problematic=`egrep --files-without-match '^\.SH SYNOPSIS' [A-Z]*.3`
problematic='Containers.3 Sequences.3 Assoc_containers.3 Allocators.3 problematic='Containers.3 Sequences.3 Assoc_containers.3 Iterator_types.3'
Iterator_types.3'
for f in $problematic; do for f in $problematic; do
sed '/^\.SH NAME/{ sed '/^\.SH NAME/{
n n
...@@ -280,8 +279,12 @@ for f in __gnu_cxx_*; do ...@@ -280,8 +279,12 @@ for f in __gnu_cxx_*; do
newname=`echo $f | sed 's/^__gnu_cxx_/__gnu_cxx::/'` newname=`echo $f | sed 's/^__gnu_cxx_/__gnu_cxx::/'`
mv $f $newname mv $f $newname
done done
for f in *__policy_*; do for f in __gnu_debug_*; do
newname=`echo $f | sed 's/__policy_/__policy::/'` newname=`echo $f | sed 's/^__gnu_debug_/__gnu_debug::/'`
mv $f $newname
done
for f in GLIBCXXSTD_*; do
newname=`echo $f | sed 's/^GLIBCXXSTD_/std::/'`
mv $f $newname mv $f $newname
done done
......
libstdc++-v3/docs/doxygen/stdheader.cc
...@@ -25,17 +25,15 @@ void init_map() ...@@ -25,17 +25,15 @@ void init_map()
headers["algo.h"] = "algorithm"; headers["algo.h"] = "algorithm";
headers["algobase.h"] = "algorithm"; headers["algobase.h"] = "algorithm";
headers["algorithm.h"] = "algorithm"; headers["algorithm.h"] = "algorithm";
headers["alloc.h"] = "memory"; headers["allocator.h"] = "memory";
headers["basic_ios.h"] = "ios"; headers["basic_ios.h"] = "ios";
headers["basic_ios.tcc"] = "ios"; headers["basic_ios.tcc"] = "ios";
headers["basic_string.h"] = "string";
headers["basic_string.tcc"] = "string";
headers["bitset.h"] = "bitset"; headers["bitset.h"] = "bitset";
headers["bvector.h"] = "vector"; headers["bvector.h"] = "vector";
//headers["char_traits.h"] uhhhhhh
headers["complex.h"] = "complex"; headers["complex.h"] = "complex";
//headers["construct.h"] stl_construct.h entirely internal //headers["construct.h"] stl_construct.h entirely internal
headers["deque.h"] = "deque"; headers["deque.h"] = "deque";
headers["deque.tcc"] = "deque";
headers["fstream.h"] = "fstream"; headers["fstream.h"] = "fstream";
headers["fstream.tcc"] = "fstream"; headers["fstream.tcc"] = "fstream";
headers["function.h"] = "functional"; headers["function.h"] = "functional";
...@@ -52,7 +50,11 @@ void init_map() ...@@ -52,7 +50,11 @@ void init_map()
headers["iterator_base_types.h"] = "iterator"; headers["iterator_base_types.h"] = "iterator";
headers["limits.h"] = "limits"; headers["limits.h"] = "limits";
headers["list.h"] = "list"; headers["list.h"] = "list";
headers["list.tcc"] = "list";
headers["codecvt.h"] = "locale";
headers["locale.h"] = "locale"; headers["locale.h"] = "locale";
headers["localefwd.h"] = "locale";
headers["locale_classes.h"] = "locale";
headers["locale_facets.h"] = "locale"; headers["locale_facets.h"] = "locale";
headers["locale_facets.tcc"] = "locale"; headers["locale_facets.tcc"] = "locale";
headers["map.h"] = "map"; headers["map.h"] = "map";
...@@ -63,7 +65,6 @@ void init_map() ...@@ -63,7 +65,6 @@ void init_map()
headers["ostream.h"] = "ostream"; headers["ostream.h"] = "ostream";
headers["ostream.tcc"] = "ostream"; headers["ostream.tcc"] = "ostream";
headers["pair.h"] = "utility"; headers["pair.h"] = "utility";
//headers["pthread_alloc.h"] who knows
headers["queue.h"] = "queue"; headers["queue.h"] = "queue";
headers["raw_storage_iter.h"] = "memory"; headers["raw_storage_iter.h"] = "memory";
headers["relops.h"] = "utility"; headers["relops.h"] = "utility";
...@@ -71,21 +72,38 @@ void init_map() ...@@ -71,21 +72,38 @@ void init_map()
headers["sstream.h"] = "sstream"; headers["sstream.h"] = "sstream";
headers["sstream.tcc"] = "sstream"; headers["sstream.tcc"] = "sstream";
headers["stack.h"] = "stack"; headers["stack.h"] = "stack";
headers["functexcept.h"] = "stdexcept";
headers["stdexcept.h"] = "stdexcept"; headers["stdexcept.h"] = "stdexcept";
headers["stream_iterator.h"] = "iterator";
headers["streambuf_iterator.h"] = "iterator";
headers["streambuf.h"] = "streambuf"; headers["streambuf.h"] = "streambuf";
headers["streambuf.tcc"] = "streambuf"; headers["streambuf.tcc"] = "streambuf";
headers["string.h"] = "string"; headers["string.h"] = "string";
headers["char_traits.h"] = "string";
headers["postypes.h"] = "string";
headers["basic_string.h"] = "string";
headers["basic_string.tcc"] = "string";
headers["tempbuf.h"] = "memory"; headers["tempbuf.h"] = "memory";
//headers["threads.h"] who knows
headers["tree.h"] = "backward/tree.h"; headers["tree.h"] = "backward/tree.h";
headers["uninitialized.h"] = "memory"; headers["uninitialized.h"] = "memory";
headers["utility.h"] = "utility"; headers["utility.h"] = "utility";
headers["gslice.h"] = "valarray";
headers["gslice_array.h"] = "valarray";
headers["indirect_array.h"] = "valarray";
headers["mask_array.h"] = "valarray";
headers["slice_array.h"] = "valarray";
headers["valarray.h"] = "valarray"; headers["valarray.h"] = "valarray";
headers["valarray_after.h"] = "valarray";
headers["valarray_before.h"] = "valarray";
headers["valarray_array.h"] = "valarray"; headers["valarray_array.h"] = "valarray";
headers["valarray_array.tcc"] = "valarray"; headers["valarray_array.tcc"] = "valarray";
headers["valarray_meta.h"] = "valarray"; headers["valarray_meta.h"] = "valarray";
headers["vector.h"] = "vector"; headers["vector.h"] = "vector";
//headers["threads.h"] who knows
//headers["concurrence.h"] who knows
//headers["atomicity.h"] who knows
// C wrappers -- probably was an easier way to do these, but oh well // C wrappers -- probably was an easier way to do these, but oh well
headers["cassert.h"] = "cassert"; headers["cassert.h"] = "cassert";
headers["cctype.h"] = "cctype"; headers["cctype.h"] = "cctype";
...@@ -149,5 +167,4 @@ int main (int argc, char**) ...@@ -149,5 +167,4 @@ int main (int argc, char**)
do_word (w); do_word (w);
} }
// vim:ts=4:et:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment