GNU bug report logs - #28777
Clarifying the temporary documentation update marks in etc/NEWS

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 28777 in the body.
You can then email your comments to 28777 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Phil Sainty <psainty <at> orcon.net.nz>
To: bug-gnu-emacs <at> gnu.org
Cc: Eli Zaretskii <eliz <at> gnu.org>
Subject: Clarifying the temporary documentation update marks in etc/NEWS
Date: Tue, 10 Oct 2017 23:16:16 +1300

On 10/10/17 04:32, Eli Zaretskii wrote:
>> +++
>
> This indication means the change is already described in the manual.
> But since the patch doesn't include any doc changes except NEWS, I
> presume you decided this shouldn't be mentioned in the manual (and
> I agree), so the indication should be "---" instead.

I conclude that I'm a little confused about the description of the
two marks.  I had intentionally used "+++" because "all necessary
documentation updates are complete" (but I can see now that this
could make "---" redundant, unless both marks were used together).

etc/NEWS says:

> +++ indicates that all necessary documentation updates are complete.
>     (This means all relevant manuals in doc/ AND lisp doc-strings.)
> --- means no change in the manuals is needed.

If I now understand correctly, "---" means that all relevant lisp doc
strings have been updated, and "+++" means the same thing and that
there have additionally been updates to the manual?

If so, then I think this text could be clarified:

> +++ indicates that all necessary documentation updates are complete.
>     (This means all relevant manuals in doc/ AND lisp doc-strings.)
> --- indicates that all lisp doc-string updates are complete and
>     that no change in the manuals is needed.


-Phil

Message #8 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Phil Sainty <psainty <at> orcon.net.nz>
Cc: bug-gnu-emacs <at> gnu.org
Subject: Re: Clarifying the temporary documentation update marks in etc/NEWS
Date: Tue, 10 Oct 2017 15:25:38 +0300

> From: Phil Sainty <psainty <at> orcon.net.nz>
> Cc: Eli Zaretskii <eliz <at> gnu.org>
> Date: Tue, 10 Oct 2017 23:16:16 +1300
> 
> etc/NEWS says:
> 
> > +++ indicates that all necessary documentation updates are complete.
> >     (This means all relevant manuals in doc/ AND lisp doc-strings.)
> > --- means no change in the manuals is needed.
> 
> If I now understand correctly, "---" means that all relevant lisp doc
> strings have been updated, and "+++" means the same thing and that
> there have additionally been updates to the manual?
> 
> If so, then I think this text could be clarified:

Thanks, I've clarified it.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.