unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Richard Stallman <rms@gnu.org>
To: Marcin Borkowski <mbork@mbork.pl>
Cc: charles@aurox.ch, emacs-devel@gnu.org
Subject: Re: Please help get ready for proofreading of Emacs manual
Date: Tue, 19 Sep 2017 15:33:22 -0400	[thread overview]
Message-ID: <E1duOGo-0003Pq-QP@fencepost.gnu.org> (raw)
In-Reply-To: <87fubjepj7.fsf@jane> (message from Marcin Borkowski on Mon, 18 Sep 2017 22:10:36 +0200)

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  >   But: should I check factual
  > correctness (for instance, whether the keys given really do correspond
  > to the command names in emacs -Q, or whether there are no mistakes in
  > command names)?  (I assume yes.)  Is there anything else?

To do this efficiently, I suggest starting by reviewing the NEWS files
for the past few Emacs major releases to recall what has been changed.

You don't need to read the WHOLE NEWS file.  Most of it, you can
ignore.  For instance, ignore the parts that don't affect the editing
interface.  Ignore the modes not covered in the Emacs manual, which is
most of them.

Don't try to remember all the details of what you see in NEWS -- just
which areas have changed.

Then, as you read and check the manual, if any of those areas comes
up, you will notice it.  At that point, refer to NEWS to double-check
that the text is correct.  You won't need to do that very often.

  > 3. In what format I should submit my corrections?  (A simple diff/patch
  > might not be enough, since I might have a suggestion which may be
  > controversial and hence should be discussed.  How would I mark such
  > places?)

When it is a simple change, a diff is fine.  You could send it as a
bug report.  I recommend sending only 5 such simple changes in one bug
report -- then start another.  It's only a matter of the maintainers'
convenience.

If you see a more complex issue, please write about it on emacs-devel.
For complex issues, how you format your mail is not crucial, since
the hard part will be thinking about the issue itself.

-- 
Dr Richard Stallman
President, Free Software Foundation (gnu.org, fsf.org)
Internet Hall-of-Famer (internethalloffame.org)
Skype: No way! See stallman.org/skype.html.




  reply	other threads:[~2017-09-19 19:33 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-17  0:00 Please help get ready for proofreading of Emacs manual Richard Stallman
2017-09-18 18:53 ` Charles A. Roelli
2017-09-18 20:10   ` Marcin Borkowski
2017-09-19 19:33     ` Richard Stallman [this message]
2017-09-20  4:04       ` Marcin Borkowski
2017-09-20 20:35         ` Richard Stallman
2017-09-20 22:03           ` John Wiegley
2017-09-21  7:59             ` Eli Zaretskii
2017-09-21 14:26               ` John Wiegley
2017-09-18 20:27   ` Eric Abrahamsen
2017-09-18 23:36   ` Nick Helm
2017-09-19  3:56     ` Eli Zaretskii
2017-09-19  7:25   ` Petteri Hintsanen
2017-09-19 19:33   ` Richard Stallman
2017-09-20 18:50     ` Charles A. Roelli
2017-09-21 18:26       ` Richard Stallman
2017-09-19 19:33   ` Richard Stallman

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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=E1duOGo-0003Pq-QP@fencepost.gnu.org \
    --to=rms@gnu.org \
    --cc=charles@aurox.ch \
    --cc=emacs-devel@gnu.org \
    --cc=mbork@mbork.pl \
    /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 public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).