This is the mail archive of the
libstdc++@gcc.gnu.org
mailing list for the libstdc++ project.
[v3] documentation tweaks in various files
- To: libstdc++ at gcc dot gnu dot org, gcc-patches at gcc dot gnu dot org
- Subject: [v3] documentation tweaks in various files
- From: Phil Edwards <pedwards at disaster dot jaj dot com>
- Date: Sat, 19 May 2001 15:13:49 -0400
I'm a stickler for pretty output in --help. Also this brings some other
comments up-to-date and mentions the new collection of auto-generated
documentation up on the FTP site.
2001-05-19 Phil Edwards <pme@sources.redhat.com>
* acinclude.m4: Fix --help spacing, correct comments.
* aclocal.m4: Regenerate.
* configure: Regenerate.
* mkcheck.in: Add usage comments.
* docs/html/documentation.html: Point to doxygen'd tarball.
Index: acinclude.m4
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/acinclude.m4,v
retrieving revision 1.146
diff -u -3 -p -r1.146 acinclude.m4
--- acinclude.m4 2001/05/18 07:24:22 1.146
+++ acinclude.m4 2001/05/19 20:25:46
@@ -1036,8 +1036,8 @@ dnl
AC_DEFUN(GLIBCPP_ENABLE_CLOCALE, [
AC_MSG_CHECKING([for clocale to use])
AC_ARG_ENABLE(clocale,
- [ --enable-clocale enable model for target locale package.
- --enable-clocale=MODEL use MODEL target-speific locale package. [default=generic]
+ [ --enable-clocale enable model for target locale package.
+ --enable-clocale=MODEL use MODEL target-speific locale package. [default=generic]
],
if test x$enable_clocale = xno; then
enable_clocale=generic
@@ -1080,8 +1080,8 @@ dnl
AC_DEFUN(GLIBCPP_ENABLE_CSTDIO, [
AC_MSG_CHECKING([for cstdio to use])
AC_ARG_ENABLE(cstdio,
- [ --enable-cstdio enable stdio for target io package.
- --enable-cstdio=LIB use LIB target-speific io package. [default=stdio]
+ [ --enable-cstdio enable stdio for target io package.
+ --enable-cstdio=LIB use LIB target-speific io package. [default=stdio]
],
if test x$enable_cstdio = xno; then
enable_cstdio=stdio
@@ -1428,8 +1428,7 @@ define([GLIBCPP_ENABLE_CHEADERS_DEFAULT]
AC_MSG_CHECKING([for c header strategy to use])
AC_ARG_ENABLE(cheaders,
changequote(<<, >>)dnl
-<< --enable-cheaders construct "C" header files for
- g++ [default=>>GLIBCPP_ENABLE_CHEADERS_DEFAULT],
+<< --enable-cheaders construct "C" header files for g++ [default=>>GLIBCPP_ENABLE_CHEADERS_DEFAULT],
changequote([, ])
[case "$enableval" in
c)
@@ -1567,6 +1566,9 @@ dnl GLIBCPP_EXPORT_INSTALL_INFO
dnl calculates gxx_install_dir
dnl exports glibcpp_toolexecdir
dnl exports glibcpp_toolexeclibdir
+dnl exports glibcpp_builddir
+dnl exports glibcpp_srcdir
+dnl exports glibcpp_prefixdir
dnl
dnl Assumes cross_compiling bits already done, and with_cross_host in
dnl particular
@@ -1590,7 +1592,7 @@ AC_MSG_RESULT($libstdcxx_interface)
# Process the option --with-gxx-include-dir=<path to include-files directory>
AC_MSG_CHECKING([for --with-gxx-include-dir])
AC_ARG_WITH(gxx-include-dir,
-[ --with-gxx-include-dir the installation directory for include files],
+[ --with-gxx-include-dir the installation directory for include files],
[case "${withval}" in
yes)
AC_MSG_ERROR(Missing directory for --with-gxx-include-dir)
Index: mkcheck.in
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/mkcheck.in,v
retrieving revision 1.57
diff -u -3 -p -r1.57 mkcheck.in
--- mkcheck.in 2001/05/19 03:42:52 1.57
+++ mkcheck.in 2001/05/19 20:25:46
@@ -23,8 +23,8 @@ elif [ "$WHICH"x = 1x ]; then
echo "running mkcheck"
echo "$0: testing the install directory"
else
- echo 'Usage: mkcheck 0'
- echo ' mkcheck 1'
+ echo 'Usage: mkcheck 0 /* test the build directory */'
+ echo ' mkcheck 1 /* test the install directory */'
exit 1;
fi
Index: docs/html/documentation.html
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/html/documentation.html,v
retrieving revision 1.1
diff -u -3 -p -r1.1 documentation.html
--- documentation.html 2000/12/10 04:03:08 1.1
+++ documentation.html 2001/05/19 20:25:46
@@ -69,6 +69,21 @@
<LI><A HREF="ext/howto.html">Extensions to the Standard Library</A>
</OL>
+<HR>
+<H2><A NAME="4">Source Documentation</A></H2>
+<P>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 latest
+ collection is libstdc++-doxygen-20010501.tar.gz (3.7MB), available in
+ the libstdc++ snapshots directory at
+ <TT><URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/></TT>. You will
+ almost certainly need to use one of the
+ <A HREF="http://gcc.gnu.org/mirrors.html">mirror sites</A>. After
+ unpacking, simply load libstdc++-doxygen-20010501/index.html in a browser.
+ Feedback (and additional documentation!) is welcome.
+</P>
+
</BODY>
</HTML>