annotate doc/README @ 14776:a3bd209aea02

test-perror: rewrite to use init script Make the test simpler, and also check for correct exit status. * modules/perror-tests (Files): Add init.sh. * tests/test-perror.sh: Use temporary directory. Signed-off-by: Eric Blake <eblake@redhat.com>
author Eric Blake <eblake@redhat.com>
date Fri, 20 May 2011 08:57:54 -0600
parents c8a2ef62800e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10834
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
1 Misc notes
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
2 ----------
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
3
6008
47323bc9321f regexprops, generated by findutils helper
Karl Berry <karl@freefriends.org>
parents: 5016
diff changeset
4 regexprops-generic.texi is generated via a utility in findutils.
10834
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
5
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
6 How to update gnulib manual on www.gnu.org
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
7 ------------------------------------------
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
8
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
9 1) You need a non-anonymous checkout of the web pages directory.
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
10
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
11 $ cvs -d :ext:jas@cvs.savannah.gnu.org:/web/gnulib \
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
12 checkout gnulib
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
13
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
14 2) Get familiar with the instructions for web page maintainers.
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
15 http://www.gnu.org/server/standards/readme_index.html
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
16 http://www.gnu.org/server/standards/README.software.html
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
17 especially the note about symlinks.
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
18
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
19 3) Assuming GNULIB_CHECKOUT refers to a checkout of the gnulib dir,
10835
Simon Josefsson <simon@josefsson.org>
parents: 10834
diff changeset
20 and GNULIB_WWW_CHECKOUT refers to the other directory created above (1),
10834
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
21 do
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
22
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
23 GNULIB_WWW_CHECKOUT=`cd $GNULIB_WWW_CHECKOUT && pwd`
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
24 cd $GNULIB_CHECKOUT/doc
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
25 make updated-stamp
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
26 ../build-aux/gendocs.sh -o "$GNULIB_WWW_CHECKOUT/manual" \
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
27 gnulib "The GNU Portability Library"
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
28 cd $GNULIB_WWW_CHECKOUT
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
29
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
30 Verify that the result looks sane.
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
31
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
32 4) Commit the modified and the new files.
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
33
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
34 5) Find the files which have not been overwritten (because they belonged
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
35 to sections that have been removed or renamed):
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
36
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
37 $ cd manual/html_node
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
38 $ ls -lt
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
39
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
40 Remove these files and commit their removal to CVS.
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
41 For each of these files, add a line to the file .symlinks. This will
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
42 ensure that hyperlinks to the removed files will redirect to the entire
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
43 manual; this is better than a 404 error.
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
44
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
45 There is a problem with 'index.html' being written twice (once for POSIX
9055e374e54c Add instructions to generate online gnulib manual, from Bruno.
Simon Josefsson <simon@josefsson.org>
parents: 6008
diff changeset
46 function 'index', once for the table of contents); you can ignore this issue.