gnu-web-doc-update doesn't work when the manual isn't already online

gnu-web-doc-update doesn't work when the manual isn't already online

[Reuben Thomas]

[-- Attachment #1: Type: text/plain, Size: 492 bytes --]

I spent a while trying to work out why I was getting CVS errors from the
script for GNU a2ps, and I realised that the problem was that a2ps's manual
wasn't online yet. This causes confusing error messages when the "manual"
subdirectory isn't online, and cvs can't find a CVS directory and hence
CVSROOT.

I think it would be sufficient to "cvs add" the manual subdirectory before
trying to "cvs add" its contents, adding

( cd pkg && $CVS add manual )

at line 180.

-- 
https://rrt.sc3d.org

[-- Attachment #2: Type: text/html, Size: 1430 bytes --]

Re: gnu-web-doc-update doesn't work when the manual isn't already online

[Bruno Haible]

Hi Reuben,

Reuben Thomas wrote:
> I spent a while trying to work out why I was getting CVS errors from the
> script for GNU a2ps, and I realised that the problem was that a2ps's manual
> wasn't online yet. This causes confusing error messages when the "manual"
> subdirectory isn't online, and cvs can't find a CVS directory and hence
> CVSROOT.
> 
> I think it would be sufficient to "cvs add" the manual subdirectory before
> trying to "cvs add" its contents, adding
> 
> ( cd pkg && $CVS add manual )
> 
> at line 180.

If we do this unconditionally, the user will get a warning message

  cvs add: manual/CVS already exists

in the update case. This patch should thus work better.

Btw, I prefer to not use this script, because it does not handle removed
doc pages yet. In these cases, it is advisable to augment the .symlinks
file, so that users who use old URLs don't get HTTP 404 errors. But the
script does not do this yet.


2023-03-22  Bruno Haible  <bruno@clisp.org>

	gnu-web-doc-update: Make it work for the first upload of a manual.
	Reported by Reuben Thomas <rrt@sc3d.org> in
	<https://lists.gnu.org/archive/html/bug-gnulib/2023-03/msg00066.html>.
	* build-aux/gnu-web-doc-update: Put the 'manual' directory under version
	control if it is not yet.

diff --git a/build-aux/gnu-web-doc-update b/build-aux/gnu-web-doc-update
index c968b1dcda..2c6e451eb5 100755
--- a/build-aux/gnu-web-doc-update
+++ b/build-aux/gnu-web-doc-update
@@ -2,7 +2,7 @@
 # Run this after each non-alpha release, to update the web documentation at
 # https://www.gnu.org/software/$pkg/manual/
 
-VERSION=2022-01-27.18; # UTC
+VERSION=2023-03-22.05; # UTC
 
 # Copyright (C) 2009-2023 Free Software Foundation, Inc.
 
@@ -179,6 +179,9 @@ tmp=$(mktemp -d web-doc-update.XXXXXX) || exit 1
 $RSYNC -avP "$builddir"/doc/manual/ $tmp/$pkg/manual
 
 (
+  cd $tmp/$pkg
+  test -d manual/CVS || $dryrun $CVS add -ko manual
+
   cd $tmp/$pkg/manual
 
   # Add all the files.  This is simpler than trying to add only the

Re: gnu-web-doc-update doesn't work when the manual isn't already online

[Reuben Thomas]

[-- Attachment #1: Type: text/plain, Size: 587 bytes --]

On Wed, 22 Mar 2023 at 05:42, Bruno Haible <bruno@clisp.org> wrote:

>
> If we do this unconditionally, the user will get a warning message
>
>   cvs add: manual/CVS already exists
>
> in the update case. This patch should thus work better.
>

Thanks for the improvement!


> Btw, I prefer to not use this script, because it does not handle removed
> doc pages yet. In these cases, it is advisable to augment the .symlinks
> file, so that users who use old URLs don't get HTTP 404 errors. But the
> script does not do this yet.
>

Doesn't --mirror handle this?

-- 
https://rrt.sc3d.org

[-- Attachment #2: Type: text/html, Size: 1556 bytes --]

Re: gnu-web-doc-update doesn't work when the manual isn't already online

[Bruno Haible]

Reuben Thomas wrote:
> > Btw, I prefer to not use this script, because it does not handle removed
> > doc pages yet. In these cases, it is advisable to augment the .symlinks
> > file, so that users who use old URLs don't get HTTP 404 errors. But the
> > script does not do this yet.
> >
> 
> Doesn't --mirror handle this?

What I mean is that when a developer has removed or renamed some info nodes
in the documentation, previously existing HTML pages no longer exist.
Last time this happened, for example, after restructured the regular expressions
documentation, I added the following symlinks to compensate for the deleted
HTML pages:

Whole_002dstring-Operators.html Buffer-Operators.html
Regular-expressions.html Emacs-Syntax-Tables.html
Regular-expressions.html GNU-Emacs-Operators.html
Match_002dbeginning_002dof_002dstring-Operator.html Match_002dbeginning_002dof_002dbuffer-Operator.html
Match_002dend_002dof_002dstring-Operator.html Match_002dend_002dof_002dbuffer-Operator.html
Regular-expressions.html Match_002dnot_002dsyntactic_002dclass-Operator.html
Regular-expressions.html Match_002dsyntactic_002dclass-Operator.html
Regular-expressions.html Non_002dEmacs-Syntax-Tables.html
Regular-expressions.html Syntactic-Class-Operators.html

I don't see how a script can do this automatically.

Bruno

Re: gnu-web-doc-update doesn't work when the manual isn't already online

[Reuben Thomas]

[-- Attachment #1: Type: text/plain, Size: 500 bytes --]

On Thu, 23 Mar 2023 at 13:24, Bruno Haible <bruno@clisp.org> wrote:

>
> What I mean is that when a developer has removed or renamed some info nodes
> in the documentation, previously existing HTML pages no longer exist.
> Last time this happened, for example, after restructured the regular
> expressions
> documentation, I added the following symlinks to compensate for the deleted
> HTML pages:
>

I see, and I agree this is hard to do automatically in the general case.

-- 
https://rrt.sc3d.org

[-- Attachment #2: Type: text/html, Size: 1104 bytes --]