From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Samer Masterson Newsgroups: gmane.emacs.devel Subject: [PATCH] Adding testing information to CONTRIBUTE Date: Sun, 15 Mar 2015 00:49:47 -0700 Message-ID: <1426405787.4214.1@mail.samertm.com> References: <1425553346.2108.2@mail.samertm.com> <1425564860.10893.0@mail.samertm.com> <83y4nbo0gr.fsf@gnu.org> <1425583915.22241.2@mail.samertm.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="=-3PB4oVcjpurfnqGUKgAh" X-Trace: ger.gmane.org 1426405825 18758 80.91.229.3 (15 Mar 2015 07:50:25 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 15 Mar 2015 07:50:25 +0000 (UTC) Cc: stephen_leake@stephe-leake.org, emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Mar 15 08:50:11 2015 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1YX3JJ-0004RT-Sb for ged-emacs-devel@m.gmane.org; Sun, 15 Mar 2015 08:50:10 +0100 Original-Received: from localhost ([::1]:42686 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YX3JI-00065H-M4 for ged-emacs-devel@m.gmane.org; Sun, 15 Mar 2015 03:50:08 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50447) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YX3JE-00062g-Ev for emacs-devel@gnu.org; Sun, 15 Mar 2015 03:50:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YX3JC-0003Dn-Sp for emacs-devel@gnu.org; Sun, 15 Mar 2015 03:50:04 -0400 Original-Received: from ec2-52-0-7-12.compute-1.amazonaws.com ([52.0.7.12]:54267 helo=samertm.com) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YX3J9-0003AU-2O; Sun, 15 Mar 2015 03:49:59 -0400 Original-Received: from [10.1.10.16] (c-98-210-154-226.hsd1.ca.comcast.net [98.210.154.226]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by samertm.com (Postfix) with ESMTPSA id 22C46424AA; Sun, 15 Mar 2015 07:49:31 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samertm.com; s=mail; t=1426405773; bh=Em2kecGcfbJdkNnrUDgoR1L2cY00uRlnPhD120qpvVI=; h=Date:From:Subject:To:Cc:In-Reply-To:References:From; b=E2F5AvTVxyiQdKzqnFVLSsVmGuWjn4j07z/+UZYgRDBUowM0jQ01EyS/W/MOBdLju L9JTSdZtOYFN2Oz9pIhDWlB406nSTNBgtwDPAe7BtXGWLqnA/6y0NhLZp1NKjJJ/v9 wmLmyqjJqBOHvOCgMXjdC5DPRw8A1ZEA6em69l4s= In-Reply-To: <1425583915.22241.2@mail.samertm.com> X-Mailer: geary/0.9.1 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 52.0.7.12 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:183871 Archived-At: --=-3PB4oVcjpurfnqGUKgAh Content-Type: text/plain; charset=utf-8 The patch below adds testing information to Emacs ("make check", the "test/automated" directory & make commands) Best, Samer Masterson Patch below: [PATCH] Add "Test your changes" and doc tips * CONTRIBUTE (Test your changes.): Add section. (Document your changes.): Add doc tips. --- CONTRIBUTE | 20 ++++++++++++++++++++ ChangeLog | 5 +++++ 2 files changed, 25 insertions(+) diff --git a/CONTRIBUTE b/CONTRIBUTE index 5cf015f..b9ece74 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE @@ -187,6 +187,26 @@ know it does not, mark the NEWS entry with "---". If you know that *all* the necessary documentation updates have been made, mark the entry with "+++". Otherwise do not mark it. +Please see (info "(elisp)Documentation Tips") or +https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html +for more specific tips on Emacs's doc style. Use `checkdoc' to check +for documentation errors before submitting a patch. + +** Test your changes. + +Please test your changes before committing them or sending them to the +list. + +Emacs uses ERT, Emacs Lisp Regression Testing, for testing. See (info +"(ert)") or https://www.gnu.org/software/emacs/manual/html_node/ert/ +for more information on writing and running tests. + +To run tests on the entire Emacs tree, run "make check" from the +top-level directory. Most tests are in the directory +"test/automated". From the "test/automated" directory, run "make +" to run the tests for .el(c). See +"test/automated/Makefile.in" for more information. + ** Understanding Emacs Internals. The best way to understand Emacs Internals is to read the code, diff --git a/ChangeLog b/ChangeLog index 4f6523e..f5db1c5 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2015-03-15 Samer Masterson + + * CONTRIBUTE (Test your changes.): Add section. + (Document your changes.): Add doc tips. + 2015-03-02 Robert Pluim (tiny change) * configure.ac: Error out if with-file-notification=w32 is --=-3PB4oVcjpurfnqGUKgAh Content-Type: text/html; charset=utf-8 Content-Transfer-Encoding: quoted-printable
The patch below adds testing information to Emacs ("make check", the
"test/automated" directory & make commands)

Best,
Samer Masterson

Patch below= :

[PATCH] Add "Test your changes" and doc tips

=
* CONTRIBUTE (Test your changes.): Add section.
(Docum= ent your changes.): Add doc tips.

---
&n= bsp;CONTRIBUTE | 20 ++++++++++++++++++++
 ChangeLog  | =  5 +++++
 2 files changed, 25 insertions(+)
<= br>
diff --git a/CONTRIBUTE b/CONTRIBUTE
index 5cf015f.= .b9ece74 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE
=
@@ -187,6 +187,26 @@ know it does not, mark the NEWS entry with "---".=  If you know
 that *all* the necessary documentation u= pdates have been made, mark
 the entry with "+++". Otherwise= do not mark it.
 
+Please see (info "(elisp)Docum= entation Tips") or
+for = more specific tips on Emacs's doc style. Use `checkdoc' to check
= +for documentation errors before submitting a patch.
+
= +** Test your changes.
+
+Please test your changes befo= re committing them or sending them to the
+list.
+
+Emacs uses ERT, Emacs Lisp Regression Testing, for testing. See (inf= o
+for more information on writing and running tests.
+
+To run tests on the entire Emacs tree, run "make check" from= the
+top-level directory. Most tests are in the directory
<= div>+"test/automated". From the "test/automated" directory, run "make
=
+<filename>" to run the tests for <filename>.el(c). See
+"test/automated/Makefile.in" for more information.
+
 ** Understanding Emacs Internals.
 
&= nbsp;The best way to understand Emacs Internals is to read the code,
<= div>diff --git a/ChangeLog b/ChangeLog
index 4f6523e..f5db1c5 100= 644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 += 1,8 @@
+2015-03-15  Samer Masterson  <samer@samertm.= com>
+
+ * CONTRIBUTE (Test your changes.): Add section.
<= div>+ (Docu= ment your changes.): Add doc tips.
+
 2015-03-02 &= nbsp;Robert Pluim  <rpluim@gmail.com>  (tiny change)
<= div> 
  * configure.ac: Error out if with-file-notification=3Dw32 = is

= --=-3PB4oVcjpurfnqGUKgAh--