Emacs lisp coding conventions

Emacs lisp coding conventions

[Pavel Janík]

[-- Attachment #1: Type: text/plain, Size: 1137 bytes --]

Hi,

while doing a cleanup in GNU Emacs to follow the Emacs lisp coding
conventions which you can read in both XEmacs and GNU Emacs Lisp Reference
manuals, I have come up with this patch. It cleans the files in the current
Gnus CVS to follow these conventions:

 contrib/gpg-ring.el |    7 +++----
 contrib/gpg.el      |    5 ++---
 contrib/md5.el      |    2 +-
 contrib/ssl.el      |    4 ++--
 contrib/xml.el      |    2 +-
 lisp/binhex.el      |    2 +-
 lisp/flow-fill.el   |    2 +-
 lisp/gnus-mlspl.el  |    6 ++++++
 lisp/gnus-uu.el     |    2 +-
 lisp/mm-bodies.el   |    2 +-
 lisp/mm-extern.el   |    5 ++---
 lisp/mm-partial.el  |    5 ++---
 lisp/mm-uu.el       |    3 +--
 lisp/mm-view.el     |    2 +-
 lisp/nndb.el        |    2 ++
 lisp/nndraft.el     |    3 +--
 lisp/rfc2104.el     |    2 ++
 lisp/smiley.el      |    2 ++

Please apply it to the CVS to make it easier for GNU Emacs maintainers to
integrate Gnus to the next release. After applying this patch, I will clean
Gnus in Emacs's CVS.

Thank you.
-- 
Pavel Janík

panic("esp: what could it be... I wonder...");
                  -- 2.2.16 drivers/scsi/esp.c

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: gnus-elisp-conventions.diff --]
[-- Type: text/x-patch, Size: 7252 bytes --]

diff -x CVS -urN gnus/contrib/gpg-ring.el gnus.patched/contrib/gpg-ring.el
--- gnus/contrib/gpg-ring.el	Thu Jul 12 21:54:41 2001
+++ gnus.patched/contrib/gpg-ring.el	Thu Jul 12 22:05:10 2001
@@ -28,11 +28,10 @@
 
 
 \f
-;;;; Code:
+;;; Code:
 
 (require 'gpg)
-(eval-when-compile 
-  (require 'cl))
+(eval-when-compile (require 'cl))
 
 ;;;; Customization:
 
@@ -481,4 +480,4 @@
 
 (provide 'gpg-ring)
 
-;;; gpg-ring.el ends here
\ No newline at end of file
+;;; gpg-ring.el ends here
diff -x CVS -urN gnus/contrib/gpg.el gnus.patched/contrib/gpg.el
--- gnus/contrib/gpg.el	Thu Jul 12 21:54:50 2001
+++ gnus.patched/contrib/gpg.el	Thu Jul 12 22:05:14 2001
@@ -106,11 +106,10 @@
 ;; function (bound to `C-h l' by default).
 
 \f
-;;;; Code:
+;;; Code:
 
 (require 'timer)
-(eval-when-compile 
-  (require 'cl))
+(eval-when-compile (require 'cl))
 
 (eval-and-compile 
   (defalias 'gpg-point-at-eol
diff -x CVS -urN gnus/contrib/md5.el gnus.patched/contrib/md5.el
--- gnus/contrib/md5.el	Thu Jul 12 21:54:53 2001
+++ gnus.patched/contrib/md5.el	Thu Jul 12 21:52:01 2001
@@ -89,7 +89,7 @@
 ;; These notices must be retained in any copies of any part of this
 ;; documentation and/or software.
 
-;;; Code: ---------------------------------------------------------------------
+;;; Code:
 
 (defvar md5-program "md5sum"
   "*Program that reads a message on its standard input and writes an
diff -x CVS -urN gnus/contrib/ssl.el gnus.patched/contrib/ssl.el
--- gnus/contrib/ssl.el	Thu Jul 12 21:54:56 2001
+++ gnus.patched/contrib/ssl.el	Thu Jul 12 21:52:01 2001
@@ -1,4 +1,4 @@
-;;; ssl.el,v --- ssl functions for emacsen without them builtin
+;;; ssl.el --- ssl functions for emacsen without them builtin
 ;; Author: $Author: jas $
 ;; Created: $Date: 2001/03/15 23:27:16 $
 ;; Version: $Revision: 1.1 $
@@ -26,7 +26,7 @@
 ;;; Boston, MA 02111-1307, USA.
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
-(require 'cl)
+(eval-when-compile (require 'cl))
 (require 'base64)
 
 (eval-and-compile
diff -x CVS -urN gnus/contrib/xml.el gnus.patched/contrib/xml.el
--- gnus/contrib/xml.el	Thu Jul 12 22:04:01 2001
+++ gnus.patched/contrib/xml.el	Thu Jul 12 21:52:01 2001
@@ -1,4 +1,4 @@
-;; @(#) xml.el --- XML parser
+;;; xml.el --- XML parser
 
 ;; Copyright (C) 2000, 2001 Free Software Foundation, Inc.
 
diff -x CVS -urN gnus/lisp/binhex.el gnus.patched/lisp/binhex.el
--- gnus/lisp/binhex.el	Thu Jul 12 21:56:44 2001
+++ gnus.patched/lisp/binhex.el	Thu Jul 12 21:52:04 2001
@@ -1,4 +1,4 @@
-;;; binhex.el -- elisp native binhex decode
+;;; binhex.el --- elisp native binhex decode
 ;; Copyright (c) 1998, 1999, 2000 Free Software Foundation, Inc.
 
 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
diff -x CVS -urN gnus/lisp/flow-fill.el gnus.patched/lisp/flow-fill.el
--- gnus/lisp/flow-fill.el	Thu Jul 12 21:56:44 2001
+++ gnus.patched/lisp/flow-fill.el	Thu Jul 12 21:52:05 2001
@@ -38,7 +38,7 @@
 ;; Todo: encoding, implement basic `fill-region' (Emacs and XEmacs
 ;;       implementations differ..)
 
-;; History:
+;;; History:
 
 ;; 2000-02-17  posted on ding mailing list
 ;; 2000-02-19  use `point-at-{b,e}ol' in XEmacs
diff -x CVS -urN gnus/lisp/gnus-mlspl.el gnus.patched/lisp/gnus-mlspl.el
--- gnus/lisp/gnus-mlspl.el	Thu Jul 12 21:56:46 2001
+++ gnus.patched/lisp/gnus-mlspl.el	Thu Jul 12 21:52:08 2001
@@ -20,6 +20,10 @@
 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
+;;; Commentary:
+
+;;; Code:
+
 (eval-when-compile (require 'cl))
 (require 'gnus)
 (require 'gnus-sum)
@@ -220,3 +224,5 @@
     split))
 
 (provide 'gnus-mlspl)
+
+;;; gnus-mlspl.el ends here
diff -x CVS -urN gnus/lisp/gnus-uu.el gnus.patched/lisp/gnus-uu.el
--- gnus/lisp/gnus-uu.el	Thu Jul 12 21:56:57 2001
+++ gnus.patched/lisp/gnus-uu.el	Thu Jul 12 21:52:09 2001
@@ -2156,4 +2156,4 @@
 
 (provide 'gnus-uu)
 
-;; gnus-uu.el ends here
+;;; gnus-uu.el ends here
diff -x CVS -urN gnus/lisp/mm-bodies.el gnus.patched/lisp/mm-bodies.el
--- gnus/lisp/mm-bodies.el	Thu Jul 12 21:55:39 2001
+++ gnus.patched/lisp/mm-bodies.el	Thu Jul 12 21:52:09 2001
@@ -283,4 +283,4 @@
 
 (provide 'mm-bodies)
 
-;; mm-bodies.el ends here
+;;; mm-bodies.el ends here
diff -x CVS -urN gnus/lisp/mm-extern.el gnus.patched/lisp/mm-extern.el
--- gnus/lisp/mm-extern.el	Thu Jul 12 21:55:49 2001
+++ gnus.patched/lisp/mm-extern.el	Thu Jul 12 22:05:32 2001
@@ -25,8 +25,7 @@
 
 ;;; Code:
 
-(eval-when-compile
-  (require 'cl))
+(eval-when-compile (require 'cl))
 
 (require 'mm-util)
 (require 'mm-decode)
@@ -164,4 +163,4 @@
 		  (error nil))
 		(delete-region ,(point-min-marker) ,(point-max-marker))))))))))
 
-;; mm-extern.el ends here
+;;; mm-extern.el ends here
diff -x CVS -urN gnus/lisp/mm-partial.el gnus.patched/lisp/mm-partial.el
--- gnus/lisp/mm-partial.el	Thu Jul 12 21:55:50 2001
+++ gnus.patched/lisp/mm-partial.el	Thu Jul 12 22:06:20 2001
@@ -25,8 +25,7 @@
 
 ;;; Code:
 
-(eval-when-compile
-  (require 'cl))
+(eval-when-compile (require 'cl))
 
 (require 'gnus-sum)
 (require 'mm-util)
@@ -149,4 +148,4 @@
 		  (error nil))
 		(delete-region ,(point-min-marker) ,(point-max-marker))))))))))
 
-;; mm-partial.el ends here
+;;; mm-partial.el ends here
diff -x CVS -urN gnus/lisp/mm-uu.el gnus.patched/lisp/mm-uu.el
--- gnus/lisp/mm-uu.el	Thu Jul 12 21:55:55 2001
+++ gnus.patched/lisp/mm-uu.el	Thu Jul 12 21:52:09 2001
@@ -1,4 +1,4 @@
-;;; mm-uu.el -- Return uu stuff as mm handles
+;;; mm-uu.el --- Return uu stuff as mm handles
 ;; Copyright (c) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
 
 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
@@ -22,7 +22,6 @@
 ;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
-
 
 ;;; Code:
 
diff -x CVS -urN gnus/lisp/mm-view.el gnus.patched/lisp/mm-view.el
--- gnus/lisp/mm-view.el	Thu Jul 12 21:55:56 2001
+++ gnus.patched/lisp/mm-view.el	Thu Jul 12 21:52:09 2001
@@ -309,4 +309,4 @@
 
 (provide 'mm-view)
 
-;; mm-view.el ends here
+;;; mm-view.el ends here
diff -x CVS -urN gnus/lisp/nndb.el gnus.patched/lisp/nndb.el
--- gnus/lisp/nndb.el	Thu Jul 12 21:56:59 2001
+++ gnus.patched/lisp/nndb.el	Thu Jul 12 21:52:09 2001
@@ -326,3 +326,5 @@
   (nntp))
 
 (provide 'nndb)
+
+;;; nndb.el ends here
diff -x CVS -urN gnus/lisp/nndraft.el gnus.patched/lisp/nndraft.el
--- gnus/lisp/nndraft.el	Wed Jul 11 22:27:00 2001
+++ gnus.patched/lisp/nndraft.el	Thu Jul 12 22:06:25 2001
@@ -32,8 +32,7 @@
 (require 'nnmh)
 (require 'nnoo)
 (require 'mm-util)
-(eval-when-compile
-  (require 'cl))
+(eval-when-compile (require 'cl))
 
 (nnoo-declare nndraft
   nnmh)
diff -x CVS -urN gnus/lisp/rfc2104.el gnus.patched/lisp/rfc2104.el
--- gnus/lisp/rfc2104.el	Thu Jul 12 21:57:00 2001
+++ gnus.patched/lisp/rfc2104.el	Thu Jul 12 21:52:10 2001
@@ -51,6 +51,8 @@
 ;;; 1999-10-23  included in pgnus
 ;;; 2000-08-15  `rfc2104-hexstring-to-bitstring'
 ;;; 2000-05-12  added sha-1 example, added test case reference
+
+;;; Code:
  
 (eval-when-compile (require 'cl))
 
diff -x CVS -urN gnus/lisp/smiley.el gnus.patched/lisp/smiley.el
--- gnus/lisp/smiley.el Thu Jul 12 21:57:03 2001
+++ gnus.patched/lisp/smiley.el Thu Jul 12 22:20:36 2001
@@ -36,7 +36,9 @@
 
 ;; The smilies were drawn by Joe Reiss <jreiss@vt.edu>.
 
+;;; Code:
+
 (require 'cl)
 (require 'custom)
 

Re: Emacs lisp coding conventions

[Katsumi Yamaoka]

>>>>> In <m366cxevwq.fsf@SnowWhite.SuSE.cz> 
>>>>>	Pavel@Janik.cz (Pavel Janík) wrote:

Pavel> Hi,
Pavel> while doing a cleanup in GNU Emacs to follow the Emacs lisp
Pavel> coding conventions which you can read in both XEmacs and GNU
Pavel> Emacs Lisp Reference manuals, I have come up with this
Pavel> patch. It cleans the files in the current Gnus CVS to follow
Pavel> these conventions:

By the way, I am using font-lock to highlight some kind of garbages,
for instance, leading and trailing whitespaces, long lines, etc.

ftp://ftp.jpl.org/pub/elisp/develock.el.gz
-- 
Katsumi Yamaoka <yamaoka@jpl.org>

Re: Emacs lisp coding conventions

[Pavel Janík]

   From: Katsumi Yamaoka <yamaoka@jpl.org>
   Date: Fri, 13 Jul 2001 09:50:34 +0900

Hi,

   > By the way, I am using font-lock to highlight some kind of garbages,
   > for instance, leading and trailing whitespaces, long lines, etc.
   > 
   > ftp://ftp.jpl.org/pub/elisp/develock.el.gz

I will try it. Some days ago, I tried to remove trailing whitespaces from
Emacs' CVS and got a source tree, which is smaller for ~200k :-) Yes, there
are things which can be better :-)

Thank you for this tip.
-- 
Pavel Janík

Doctor, it hurts, where is my problem?
                  -- Hubert Mantel with his crystal-ball

Re: Emacs lisp coding conventions

[ShengHuo ZHU]

Pavel@Janik.cz (Pavel Janík) writes:

> Hi,
> 
> while doing a cleanup in GNU Emacs to follow the Emacs lisp coding
> conventions which you can read in both XEmacs and GNU Emacs Lisp Reference
> manuals, I have come up with this patch. It cleans the files in the current
> Gnus CVS to follow these conventions:

Thanks. Installed.

ShengHuo