summaryrefslogtreecommitdiff
path: root/gnulib/doc/README
diff options
context:
space:
mode:
Diffstat (limited to 'gnulib/doc/README')
m---------gnulib0
-rw-r--r--gnulib/doc/README46
2 files changed, 46 insertions, 0 deletions
diff --git a/gnulib b/gnulib
deleted file mode 160000
-Subproject 443bc5ffcf7429e557f4a371b0661abe98ddbc1
diff --git a/gnulib/doc/README b/gnulib/doc/README
new file mode 100644
index 0000000..ed632c0
--- /dev/null
+++ b/gnulib/doc/README
@@ -0,0 +1,46 @@
+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.