From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Chong Yidong Newsgroups: gmane.emacs.help Subject: Call for volunteers to check manual files Date: Mon, 07 Nov 2005 20:52:11 -0500 Message-ID: <87hdanx5x0.fsf@stupidchicken.com> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1131415006 23380 80.91.229.2 (8 Nov 2005 01:56:46 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Tue, 8 Nov 2005 01:56:46 +0000 (UTC) Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Tue Nov 08 02:56:43 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1EZIhg-0003VJ-2E for geh-help-gnu-emacs@m.gmane.org; Tue, 08 Nov 2005 02:55:16 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1EZIhf-00051r-Iy for geh-help-gnu-emacs@m.gmane.org; Mon, 07 Nov 2005 20:55:15 -0500 Original-Path: shelby.stanford.edu!newsfeed.stanford.edu!bloom-beacon.mit.edu!senator-bedfellow.mit.edu!dreaderd!not-for-mail Original-Newsgroups: gnu.emacs.help,comp.emacs User-Agent: Gnus/5.11 (Gnus v5.11) Emacs/22.0.50 (gnu/linux) Cancel-Lock: sha1:zY80uGVF88191iAFleuOy+hgNF4= Original-Lines: 78 Original-NNTP-Posting-Host: SYDNEYPACIFIC-THREE-FIFTY-SIX.MIT.EDU Original-X-Trace: 1131414738 senator-bedfellow.mit.edu 558 18.95.6.101 Original-Xref: shelby.stanford.edu gnu.emacs.help:135305 comp.emacs:90506 Original-To: help-gnu-emacs@gnu.org X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.help:30898 Archived-At: This is a call for volunteers to help check the manuals for the upcoming Emacs 22 release. Before the Emacs developers can release Emacs 22, we need to check the manuals for factual accuracy, especially the parts describing new features. Any help that you can provide would be greatly appreciated. We need to keep track of how many people have checked different parts of the manual. So, if you would like to help, please read and *follow* these simple instructions: 1. Download the development version of Emacs from CVS. Instructions can be found at http://savannah.gnu.org/cvs/?group=emacs 2. Build Emacs. See INSTALL.CVS, in the source tree, for instructions; basically, $ ./configure $ make bootstrap 3. Read etc/NEWS (in the Emacs source tree) to find the changes made to Emacs since version 21.4. This is a very long file, but try to read as much as you can. If you can't digest it in one go, skim through it now and come back to specific sections later, when you're checking the manuals. 4. Visit admin/FOR-RELEASE, and find the list of Emacs manual files that have not been checked. There are two manuals that need to be checked: the Emacs Manual, and the Emacs Lisp Reference Manual. Choose a file that has not been checked by at least two people. (It is OK if you want to check the others, but the unchecked files are more important.) 5. Read the manual file. These are Texinfo files (*.texi), and can be found in the directory man/ (for the Emacs Manual) or lispref/ (for the Emacs Lisp Reference Manual.) You can also read the manuals using Info-mode in the Emacs that you built. What you are looking for, IN ORDER OF IMPORTANCE, are * Wrong facts * Unclear or misleading statements * Spelling or grammar mistakes The main goal is to find wrong facts! It is OK to report other types of mistakes, but don't let that detract from this purpose. Look out, in particular, for features that are new to Emacs 22. If you are unsure if something is a mistake, go back and check in etc/NEWS, or test it out on the Emacs that you built. 6. Once you have checked the *the entire file*, send an email to emacs-devel@gnu.org, stating * "I have checked [which file(s)]." * What mistakes you found (if any). The best way to report mistakes is to comment the Texinfo file as you are checking it, and send a patch at the end. For example, when you find such a mistake: The commands @kbd{M-f} (@code{forward-word}) and @kbd{M-b} (@code{forward-word}) move forward and backward over words. These Meta characters are thus analogous to the corresponding control Add a comment to it like this: The commands @kbd{M-f} (@code{forward-word}) and @kbd{M-b} (@code{forward-word}) move forward and backward over words. These @c Should be backward-word. Meta characters are thus analogous to the corresponding control At the end, run M-x diff and attach the patch to your report. Thanks for your time.