diff options
| author | Bernhard Voelker <mail@bernhard-voelker.de> | 2021-10-19 20:32:37 +0200 |
|---|---|---|
| committer | Bernhard Voelker <mail@bernhard-voelker.de> | 2021-10-20 12:09:11 +0200 |
| commit | 372cd34894e247fe5c2991eb75185ea2ec850ee2 (patch) | |
| tree | d6e346650fbc24d8d7dc196222e368eed0d85418 | |
| parent | 425e82e7b007694ad766beefc130962a97e28dd7 (diff) | |
| download | findutils-372cd34894e247fe5c2991eb75185ea2ec850ee2.tar.gz | |
doc: improve maintainer description of the online manual
* doc/find-maint.texi (User Documentation): Add details how to
update the online manual from Git via the CVS web repository.
| -rw-r--r-- | doc/find-maint.texi | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/doc/find-maint.texi b/doc/find-maint.texi index f033dc72..9f069dd9 100644 --- a/doc/find-maint.texi +++ b/doc/find-maint.texi @@ -613,12 +613,25 @@ Savannah you should be able to check the web pages out like this (@samp{$USER} is a placeholder for your Savannah username): @smallexample -cvs -d :ext:$USER@@cvs.savannah.gnu.org:/web/findutils checkout findutils/manual +cvs -d :ext:$USER@@cvs.savannah.gnu.org:/web/findutils checkout findutils/manual @end smallexample You can automatically update the documentation in this repository -using the script @samp{build-aux/update-online-manual.sh} in the -findutils Git repository. +by using the script @samp{build-aux/update-online-manual.sh} with the +path to the findutils Git repository as parameter. + +@smallexample +build-aux/update-online-manual.sh $HOME/git/findutils +@end smallexample + +That script will generate the documentation in the directory +@samp{doc/manual/} +by calling the @code{make} target @samp{web-manual}; +then it will copy over the files into the CVS checkout. + +There you can check the documentation once again before committing +to CVS. The Savannah CVS server will automatically initiate the +transfer to the web server. @section Build Guidance |