From: Eli Zaretskii <eliz@gnu.org>
To: Bastien <bzg@gnu.org>
Cc: 41497@debbugs.gnu.org
Subject: bug#41497: 28.0.50; Flawed text formatting of files like etc/TODO, etc/NEWS, etc.
Date: Mon, 01 Jun 2020 17:54:09 +0300 [thread overview]
Message-ID: <83blm2g7la.fsf@gnu.org> (raw)
In-Reply-To: <87lfl7jo31.fsf@gnu.org> (message from Bastien on Mon, 01 Jun 2020 08:29:38 +0200)
> From: Bastien <bzg@gnu.org>
> Cc: 41497-done@debbugs.gnu.org
> Date: Mon, 01 Jun 2020 08:29:38 +0200
>
> > As for etc/NEWS, we usually
> > fix it shortly before the release, so please look at NEWS on the
> > emacs-27 branch, and if you see problems there, please point them
> > out.
>
> I have seen some problems, like sentences that start as the headline
> and continue as the paragraph below.
>
> Shall I fix these in emacs-27 directly?
Yes, please.
> Temporary note:
> +++ indicates that all relevant manuals in doc/ have been updated.
> --- means no change in the manuals is needed.
> When you add a new item, use the appropriate mark if you are sure it
> applies, and please also update docstrings as needed.
>
> So, +++ both mean that no action is needed, either because the manuals
> have been updated already or because they don't need any update. If
> this is meant as a call to action for Emacs maintainers, what is it
> (since both say that things are okay)? If this is meant to the users,
> what info is conveyed here? What means "Temporary note": is it
> because --- and +++ are removed right before the release?
It's the entries that don't have any markers that are noteworthy.
These markers are a reminder for when Emacs is released: "Someone"
should go through the entries which have neither "+++" not "---"
marker, and decide whether any manuals need to be updated due to that
change. These markers are removed as part of preparing the release
tarball, so they never appear in a released Emacs
> What about getting rid of --- and +++ in these files and moving the
> message is conveys (about the need for an update of the manuals) in
> the etc/TODO file, or in a dedicated etc/PRERELEASE file?
That'd be inconvenient: the person who does the job of updating the
documentation, usually yours truly, will have to look at two files
instead of just one.
Why are those markers a problem?
next prev parent reply other threads:[~2020-06-01 14:54 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-24 6:29 bug#41497: 28.0.50; Flawed text formatting of files like etc/TODO, etc/NEWS, etc Bastien
2020-05-30 16:12 ` Eli Zaretskii
2020-06-01 6:29 ` Bastien
2020-06-01 14:54 ` Eli Zaretskii [this message]
2020-06-01 15:20 ` Robert Pluim
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83blm2g7la.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=41497@debbugs.gnu.org \
--cc=bzg@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.