From 372cd34894e247fe5c2991eb75185ea2ec850ee2 Mon Sep 17 00:00:00 2001 From: Bernhard Voelker Date: Tue, 19 Oct 2021 20:32:37 +0200 Subject: 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. --- doc/find-maint.texi | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) (limited to 'doc') 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 -- cgit v1.2.1