X-Git-Url: http://erislabs.net/gitweb/?a=blobdiff_plain;f=doc%2FREADME;h=ed632c09d8ef792662da79c6a99969e8507f6221;hb=1d71dc7c690b5fe61e3e0c06303ffb59434bba4b;hp=a50ddda19d9d73612e1db882637c77af9c6d09ab;hpb=23fe10e274cf20fb2cb75ea1da9556a733106657;p=gnulib.git

diff --git a/doc/README b/doc/README
index a50ddda19..ed632c09d 100644
--- a/doc/README
+++ b/doc/README
@@ -1,16 +1,46 @@
-Sketchy start at information on using files in gnulib.
-
-for mktemp, need these files (including adding to EXTRA_DIST):
-$GNULIBSRC/m4/check-decl.m4	m4
-$GNULIBSRC/m4/mkstemp.m4	m4
-$GNULIBSRC/m4/prereq.m4		m4
-$GNULIBSRC/lib/tempname.c	lib
-$GNULIBSRC/lib/mkstemp.c	lib
-
-then in configure.ac:
-AC_DEFUN([texinfo_MACROS],
-[
-  AC_REQUIRE([gl_PREREQ_TEMPNAME])dnl for mkstemp
-  AC_REQUIRE([UTILS_FUNC_MKSTEMP])
-])dnl
-texinfo_MACROS
+Misc notes
+----------
+
+regexprops-generic.texi is generated via a utility in findutils.
+
+How to update gnulib manual on www.gnu.org
+------------------------------------------
+
+1) You need a non-anonymous checkout of the web pages directory.
+
+   $ cvs -d :ext:jas@cvs.savannah.gnu.org:/web/gnulib \
+         checkout gnulib
+
+2) Get familiar with the instructions for web page maintainers.
+   http://www.gnu.org/server/standards/readme_index.html
+   http://www.gnu.org/server/standards/README.software.html
+   especially the note about symlinks.
+
+3) Assuming GNULIB_CHECKOUT refers to a checkout of the gnulib dir,
+   and      GNULIB_WWW_CHECKOUT refers to the other directory created above (1),
+   do
+
+   GNULIB_WWW_CHECKOUT=`cd $GNULIB_WWW_CHECKOUT && pwd`
+   cd $GNULIB_CHECKOUT/doc
+   make updated-stamp
+   ../build-aux/gendocs.sh -o "$GNULIB_WWW_CHECKOUT/manual" \
+     gnulib "The GNU Portability Library"
+   cd $GNULIB_WWW_CHECKOUT
+
+   Verify that the result looks sane.
+
+4) Commit the modified and the new files.
+
+5) Find the files which have not been overwritten (because they belonged
+   to sections that have been removed or renamed):
+
+   $ cd manual/html_node
+   $ ls -lt
+
+   Remove these files and commit their removal to CVS.
+   For each of these files, add a line to the file .symlinks. This will
+   ensure that hyperlinks to the removed files will redirect to the entire
+   manual; this is better than a 404 error.
+
+There is a problem with 'index.html' being written twice (once for POSIX
+function 'index', once for the table of contents); you can ignore this issue.