mirror of
https://github.com/gcc-mirror/gcc.git
synced 2024-11-21 13:40:47 +00:00
mainpage.html: Add in corrected links.
2008-02-11 Benjamin Kosnik <bkoz@redhat.com> * doc/doxygen/mainpage.html: Add in corrected links. * README: Edit, move most into... * doc/xml/manual/appendix_contributing.xml (Directory Layout): ...here. (Documentation Style): Revise. * doc/xml/spine.xml: Edit file names. * doc/Makefile.am: Edit xml_sources. * doc/Makefile.in: Regenerate. From-SVN: r132249
This commit is contained in:
parent
42d572f5a3
commit
c9024a78a9
@ -1,3 +1,13 @@
|
|||||||
|
2008-02-11 Benjamin Kosnik <bkoz@redhat.com>
|
||||||
|
|
||||||
|
* doc/doxygen/mainpage.html: Add in corrected links.
|
||||||
|
* README: Edit, move most into...
|
||||||
|
* doc/xml/manual/appendix_contributing.xml (Directory Layout): ...here.
|
||||||
|
(Documentation Style): Revise.
|
||||||
|
* doc/xml/spine.xml: Edit file names.
|
||||||
|
* doc/Makefile.am: Edit xml_sources.
|
||||||
|
* doc/Makefile.in: Regenerate.
|
||||||
|
|
||||||
2008-02-11 Paolo Carlini <pcarlini@suse.de>
|
2008-02-11 Paolo Carlini <pcarlini@suse.de>
|
||||||
|
|
||||||
* configure: Regenerate with documented autoconf and automake
|
* configure: Regenerate with documented autoconf and automake
|
||||||
|
@ -1,96 +1,6 @@
|
|||||||
file: libstdc++-v3/README
|
file: libstdc++-v3/README
|
||||||
|
|
||||||
New users may wish to point their web browsers to the file
|
New users may wish to point their web browsers to the file
|
||||||
documentation.html in the 'docs/html' subdirectory. It contains brief
|
index.html in the 'doc/html' subdirectory. It contains brief
|
||||||
building instructions and notes on how to configure the library in
|
building instructions and notes on how to configure the library in
|
||||||
interesting ways.
|
interesting ways.
|
||||||
|
|
||||||
Instructions for configuring and building appear in
|
|
||||||
docs/html/install.html.
|
|
||||||
|
|
||||||
This directory contains the files needed to create an ISO Standard C++
|
|
||||||
Library.
|
|
||||||
|
|
||||||
It has subdirectories:
|
|
||||||
|
|
||||||
docs
|
|
||||||
Files in HTML and text format that document usage, quirks of the
|
|
||||||
implementation, and contributor checklists.
|
|
||||||
|
|
||||||
include
|
|
||||||
All header files for the C++ library are within this directory,
|
|
||||||
modulo specific runtime-related files that are in the libsupc++
|
|
||||||
directory.
|
|
||||||
|
|
||||||
include/std
|
|
||||||
Files meant to be found by #include <name> directives in
|
|
||||||
standard-conforming user programs.
|
|
||||||
|
|
||||||
include/c
|
|
||||||
Headers intended to directly include standard C headers.
|
|
||||||
[NB: this can be enabled via --enable-cheaders=c]
|
|
||||||
|
|
||||||
include/c_std
|
|
||||||
Headers intended to include standard C headers, and put select
|
|
||||||
names into the std:: namespace.
|
|
||||||
[NB: this is the default, and is the same as --enable-cheaders=c_std]
|
|
||||||
|
|
||||||
include/bits
|
|
||||||
Files included by standard headers and by other files in
|
|
||||||
the bits directory.
|
|
||||||
|
|
||||||
include/backward
|
|
||||||
Headers provided for backward compatibility, such as <iostream.h>.
|
|
||||||
They are not used in this library.
|
|
||||||
|
|
||||||
include/ext
|
|
||||||
Headers that define extensions to the standard library. No
|
|
||||||
standard header refers to any of them.
|
|
||||||
|
|
||||||
scripts
|
|
||||||
Scripts that are used during the configure, build, make, or test
|
|
||||||
process.
|
|
||||||
|
|
||||||
src
|
|
||||||
Files that are used in constructing the library, but are not
|
|
||||||
installed.
|
|
||||||
|
|
||||||
testsuites/[backward, demangle, ext, performance, thread, 17_* to 27_*]
|
|
||||||
Test programs are here, and may be used to begin to exercise the
|
|
||||||
library. Support for "make check" and "make check-install" is
|
|
||||||
complete, and runs through all the subdirectories here when this
|
|
||||||
command is issued from the build directory. Please note that
|
|
||||||
"make check" requires DejaGNU 1.4 or later to be installed. Please
|
|
||||||
note that "make check-script" calls the script mkcheck, which
|
|
||||||
requires bash, and which may need the paths to bash adjusted to
|
|
||||||
work properly, as /bin/bash is assumed.
|
|
||||||
|
|
||||||
Other subdirectories contain variant versions of certain files
|
|
||||||
that are meant to be copied or linked by the configure script.
|
|
||||||
Currently these are:
|
|
||||||
|
|
||||||
config/abi
|
|
||||||
config/cpu
|
|
||||||
config/io
|
|
||||||
config/locale
|
|
||||||
config/os
|
|
||||||
|
|
||||||
In addition, two subdirectories are convenience libraries:
|
|
||||||
|
|
||||||
libmath
|
|
||||||
Support routines needed for C++ math. Only needed if the
|
|
||||||
underlying "C" implementation is non-existent, in particular
|
|
||||||
required or optimal long double, long long, and C99 functionality.
|
|
||||||
|
|
||||||
libsupc++
|
|
||||||
Contains the runtime library for C++, including exception
|
|
||||||
handling and memory allocation and deallocation, RTTI, terminate
|
|
||||||
handlers, etc.
|
|
||||||
|
|
||||||
Note that glibc also has a bits/ subdirectory. We will either
|
|
||||||
need to be careful not to collide with names in its bits/
|
|
||||||
directory; or rename bits to (e.g.) cppbits/.
|
|
||||||
|
|
||||||
In files throughout the system, lines marked with an "XXX" indicate
|
|
||||||
a bug or incompletely-implemented feature. Lines marked "XXX MT"
|
|
||||||
indicate a place that may require attention for multi-thread safety.
|
|
||||||
|
@ -73,7 +73,6 @@ xml_srcdir = ${glibcxx_srcdir}/doc/xml
|
|||||||
xml_sources = \
|
xml_sources = \
|
||||||
${xml_srcdir}/spine.xml \
|
${xml_srcdir}/spine.xml \
|
||||||
${xml_srcdir}/authors.xml \
|
${xml_srcdir}/authors.xml \
|
||||||
${xml_srcdir}/manual/spine.xml \
|
|
||||||
${xml_srcdir}/manual/abi.xml \
|
${xml_srcdir}/manual/abi.xml \
|
||||||
${xml_srcdir}/manual/algorithms.xml \
|
${xml_srcdir}/manual/algorithms.xml \
|
||||||
${xml_srcdir}/manual/allocator.xml \
|
${xml_srcdir}/manual/allocator.xml \
|
||||||
@ -186,7 +185,7 @@ doc-fo: $(xml_sources) ${glibcxx_builddir}/doc/fo
|
|||||||
|
|
||||||
# PDF
|
# PDF
|
||||||
# Points to current best xml to PDF generation process.
|
# Points to current best xml to PDF generation process.
|
||||||
doc-pdf: doc-pdf-xmlto
|
doc-pdf: doc-pdf-prince
|
||||||
|
|
||||||
# PDF 1
|
# PDF 1
|
||||||
# fop
|
# fop
|
||||||
|
@ -294,7 +294,6 @@ xml_srcdir = ${glibcxx_srcdir}/doc/xml
|
|||||||
xml_sources = \
|
xml_sources = \
|
||||||
${xml_srcdir}/spine.xml \
|
${xml_srcdir}/spine.xml \
|
||||||
${xml_srcdir}/authors.xml \
|
${xml_srcdir}/authors.xml \
|
||||||
${xml_srcdir}/manual/spine.xml \
|
|
||||||
${xml_srcdir}/manual/abi.xml \
|
${xml_srcdir}/manual/abi.xml \
|
||||||
${xml_srcdir}/manual/algorithms.xml \
|
${xml_srcdir}/manual/algorithms.xml \
|
||||||
${xml_srcdir}/manual/allocator.xml \
|
${xml_srcdir}/manual/allocator.xml \
|
||||||
@ -617,7 +616,7 @@ doc-fo: $(xml_sources) ${glibcxx_builddir}/doc/fo
|
|||||||
|
|
||||||
# PDF
|
# PDF
|
||||||
# Points to current best xml to PDF generation process.
|
# Points to current best xml to PDF generation process.
|
||||||
doc-pdf: doc-pdf-xmlto
|
doc-pdf: doc-pdf-prince
|
||||||
doc-pdf-fop-xml: $(xml_sources) ${glibcxx_builddir}/doc/pdf
|
doc-pdf-fop-xml: $(xml_sources) ${glibcxx_builddir}/doc/pdf
|
||||||
@echo "Generating pdf fop files from xml..."
|
@echo "Generating pdf fop files from xml..."
|
||||||
$(FOP) $(FOP_FLAGS) -xml ${top_srcdir}/doc/xml/spine.xml \
|
$(FOP) $(FOP_FLAGS) -xml ${top_srcdir}/doc/xml/spine.xml \
|
||||||
|
@ -28,9 +28,9 @@
|
|||||||
<p class="smallertext">Generated on @DATE@.</p>
|
<p class="smallertext">Generated on @DATE@.</p>
|
||||||
|
|
||||||
<p>There are two types of documentation for libstdc++. One is the
|
<p>There are two types of documentation for libstdc++. One is the
|
||||||
distribution documentation, which can be read online at
|
distribution documentation, which can be read online
|
||||||
<a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html</a>
|
<a href="http://gcc.gnu.org/onlinedocs/libstdc++/index.html">here</a>
|
||||||
or offline from doc/html/documentation.html in the library source
|
or offline from the file doc/html/index.html in the library source
|
||||||
directory.
|
directory.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@ -64,13 +64,15 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2>Generating the documentation</h2>
|
<h2>Generating the documentation</h2>
|
||||||
<p>These HTML pages are automatically generated, along with the man pages.
|
<p>These HTML pages are automatically generated, along with the man
|
||||||
See <code>doc/doxygen/guide.html</code> in the source tree for how to
|
pages. See the section "Documentation Style"
|
||||||
create (and write) the pages.
|
in <code>doc/xml/manual/appendix_contributing.xml</code> in the
|
||||||
|
source tree for how to create (and write) the doxygen markup.
|
||||||
|
This style guide can also be viewed on the <a href="manual/bk01apas03.html">web</a>.
|
||||||
|
|
||||||
<h2>License, Copyright, and Other Lawyerly Verbosity</h2>
|
<h2>License, Copyright, and Other Lawyerly Verbosity</h2>
|
||||||
<p>The libstdc++ documentation is released under
|
<p>The libstdc++ documentation is released under
|
||||||
<a href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/license.html">
|
<a href="manual/bk01pt01ch01s02.html">
|
||||||
these terms</a>.
|
these terms</a>.
|
||||||
</p>
|
</p>
|
||||||
<p>Part of the generated documentation involved comments and notes from
|
<p>Part of the generated documentation involved comments and notes from
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -6,8 +6,8 @@
|
|||||||
<!ENTITY license SYSTEM "license.xml">
|
<!ENTITY license SYSTEM "license.xml">
|
||||||
]>
|
]>
|
||||||
|
|
||||||
<set id="set-index" xreflabel="set-index">
|
<set id="set-index" xreflabel="The GNU C++ Library Documentation">
|
||||||
<?dbhtml filename="set-index.html"?>
|
<?dbhtml filename="spine.html"?>
|
||||||
<title>The GNU C++ Library Documentation</title>
|
<title>The GNU C++ Library Documentation</title>
|
||||||
|
|
||||||
<setinfo>
|
<setinfo>
|
||||||
|
Loading…
Reference in New Issue
Block a user