[PATCH 1/2] emacs: Fix packaging

Subject: [PATCH 1/2] emacs: Fix packaging

Date: Wed, 13 Apr 2016 03:58:47 -0400

To: notmuch@notmuchmail.org

Cc:

From: Chunyang Xu


Refer to (info "(elisp) Library Headers") for package conventions.
---
 emacs/coolj.el                | 2 ++
 emacs/make-deps.el            | 4 ++++
 emacs/notmuch-address.el      | 6 +++++-
 emacs/notmuch-company.el      | 4 +++-
 emacs/notmuch-crypto.el       | 6 +++++-
 emacs/notmuch-hello.el        | 6 +++++-
 emacs/notmuch-jump.el         | 6 +++++-
 emacs/notmuch-lib.el          | 6 +++++-
 emacs/notmuch-maildir-fcc.el  | 9 ++++++++-
 emacs/notmuch-message.el      | 6 +++++-
 emacs/notmuch-mua.el          | 6 +++++-
 emacs/notmuch-parser.el       | 6 +++++-
 emacs/notmuch-print.el        | 6 +++++-
 emacs/notmuch-query.el        | 6 +++++-
 emacs/notmuch-show.el         | 6 +++++-
 emacs/notmuch-tag.el          | 2 +-
 emacs/notmuch-tree.el         | 6 +++++-
 emacs/notmuch-version.el.tmpl | 5 +++++
 emacs/notmuch-wash.el         | 6 +++++-
 emacs/notmuch.el              | 8 +++++++-
 20 files changed, 95 insertions(+), 17 deletions(-)

diff --git a/emacs/coolj.el b/emacs/coolj.el
index 60af60a..7755060 100644
--- a/emacs/coolj.el
+++ b/emacs/coolj.el
@@ -143,3 +143,5 @@ If no break point is found, return nil."
          t)))
 
 (provide 'coolj)
+
+;;; coolj.el ends here
diff --git a/emacs/make-deps.el b/emacs/make-deps.el
index a1cd731..24c1a45 100644
--- a/emacs/make-deps.el
+++ b/emacs/make-deps.el
@@ -19,6 +19,8 @@
 ;;
 ;; Authors: Austin Clements <aclements@csail.mit.edu>
 
+;;; Code:
+
 (defun batch-make-deps ()
   "Invoke `make-deps' for each file on the command line."
 
@@ -64,3 +66,5 @@ rules will be given relative to DIR, or `default-directory'."
 				 (file-name-sans-extension
 				  (file-relative-name fname dir)))))))))
       (end-of-file nil))))
+
+;;; make-deps.el ends here
diff --git a/emacs/notmuch-address.el b/emacs/notmuch-address.el
index 49e2402..aafbe5f 100644
--- a/emacs/notmuch-address.el
+++ b/emacs/notmuch-address.el
@@ -1,4 +1,4 @@
-;; notmuch-address.el --- address completion with notmuch
+;;; notmuch-address.el --- address completion with notmuch
 ;;
 ;; Copyright © David Edmondson
 ;;
@@ -19,6 +19,8 @@
 ;;
 ;; Authors: David Edmondson <dme@dme.org>
 
+;;; Code:
+
 (require 'message)
 (require 'notmuch-parser)
 (require 'notmuch-lib)
@@ -248,3 +250,5 @@ called when harvesting finishes."
 ;;
 
 (provide 'notmuch-address)
+
+;;; notmuch-address.el ends here
diff --git a/emacs/notmuch-company.el b/emacs/notmuch-company.el
index add3161..b881d6d 100644
--- a/emacs/notmuch-company.el
+++ b/emacs/notmuch-company.el
@@ -1,4 +1,4 @@
-;; notmuch-company.el --- Mail address completion for notmuch via company-mode  -*- lexical-binding: t -*-
+;;; notmuch-company.el --- Mail address completion for notmuch via company-mode  -*- lexical-binding: t -*-
 
 ;; Authors: Trevor Jim <tjim@mac.com>
 ;; 	    Michal Sojka <sojkam1@fel.cvut.cz>
@@ -84,3 +84,5 @@
 
 
 (provide 'notmuch-company)
+
+;;; notmuch-company.el ends here
diff --git a/emacs/notmuch-crypto.el b/emacs/notmuch-crypto.el
index 73ebf51..004463c 100644
--- a/emacs/notmuch-crypto.el
+++ b/emacs/notmuch-crypto.el
@@ -1,4 +1,4 @@
-;; notmuch-crypto.el --- functions for handling display of cryptographic metadata.
+;;; notmuch-crypto.el --- functions for handling display of cryptographic metadata.
 ;;
 ;; Copyright © Jameson Rollins
 ;;
@@ -19,6 +19,8 @@
 ;;
 ;; Authors: Jameson Rollins <jrollins@finestructure.net>
 
+;;; Code:
+
 (require 'notmuch-lib)
 
 (defcustom notmuch-crypto-process-mime nil
@@ -174,3 +176,5 @@ mode."
 ;;
 
 (provide 'notmuch-crypto)
+
+;;; notmuch-crypto.el ends here
diff --git a/emacs/notmuch-hello.el b/emacs/notmuch-hello.el
index 8a31f9a..9495c1a 100644
--- a/emacs/notmuch-hello.el
+++ b/emacs/notmuch-hello.el
@@ -1,4 +1,4 @@
-;; notmuch-hello.el --- welcome to notmuch, a frontend
+;;; notmuch-hello.el --- welcome to notmuch, a frontend
 ;;
 ;; Copyright © David Edmondson
 ;;
@@ -19,6 +19,8 @@
 ;;
 ;; Authors: David Edmondson <dme@dme.org>
 
+;;; Code:
+
 (eval-when-compile (require 'cl))
 (require 'widget)
 (require 'wid-edit) ; For `widget-forward'.
@@ -1016,3 +1018,5 @@ following:
 ;;
 
 (provide 'notmuch-hello)
+
+;;; notmuch-hello.el ends here
diff --git a/emacs/notmuch-jump.el b/emacs/notmuch-jump.el
index 506ae2c..fd770f1 100644
--- a/emacs/notmuch-jump.el
+++ b/emacs/notmuch-jump.el
@@ -1,4 +1,4 @@
-;; notmuch-jump.el --- User-friendly shortcut keys
+;;; notmuch-jump.el --- User-friendly shortcut keys
 ;;
 ;; Copyright © Austin Clements
 ;;
@@ -20,6 +20,8 @@
 ;; Authors: Austin Clements <aclements@csail.mit.edu>
 ;;          David Edmondson <dme@dme.org>
 
+;;; Code:
+
 (eval-when-compile (require 'cl))
 
 (require 'notmuch-lib)
@@ -176,3 +178,5 @@ buffer."
 ;;
 
 (provide 'notmuch-jump)
+
+;;; notmuch-jump.el ends here
diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el
index eca837d..78978ee 100644
--- a/emacs/notmuch-lib.el
+++ b/emacs/notmuch-lib.el
@@ -1,4 +1,4 @@
-;; notmuch-lib.el --- common variables, functions and function declarations
+;;; notmuch-lib.el --- common variables, functions and function declarations
 ;;
 ;; Copyright © Carl Worth
 ;;
@@ -21,6 +21,8 @@
 
 ;; This is an part of an emacs-based interface to the notmuch mail system.
 
+;;; Code:
+
 (require 'mm-view)
 (require 'mm-decode)
 (require 'cl)
@@ -931,3 +933,5 @@ status."
 ;; Local Variables:
 ;; byte-compile-warnings: (not cl-functions)
 ;; End:
+
+;;; notmuch-lib.el ends here
diff --git a/emacs/notmuch-maildir-fcc.el b/emacs/notmuch-maildir-fcc.el
index c2f2f4c..bbf6132 100644
--- a/emacs/notmuch-maildir-fcc.el
+++ b/emacs/notmuch-maildir-fcc.el
@@ -1,3 +1,5 @@
+;;; notmuch-maildir-fcc.el ---
+
 ;; This file is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published
 ;; by the Free Software Foundation; either version 2, or (at your
@@ -12,10 +14,14 @@
 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 ;; Boston, MA 02110-1301, USA.
-;;
+
+;;; Commentary:
+
 ;; To use this as the fcc handler for message-mode,
 ;; customize the notmuch-fcc-dirs variable
 
+;;; Code:
+
 (eval-when-compile (require 'cl))
 (require 'message)
 
@@ -211,3 +217,4 @@ return t if successful, and nil otherwise."
 
 (provide 'notmuch-maildir-fcc)
 
+;;; notmuch-maildir-fcc.el ends here
diff --git a/emacs/notmuch-message.el b/emacs/notmuch-message.el
index 914bdd1..d437b85 100644
--- a/emacs/notmuch-message.el
+++ b/emacs/notmuch-message.el
@@ -1,4 +1,4 @@
-;; notmuch-message.el --- message-mode functions specific to notmuch
+;;; notmuch-message.el --- message-mode functions specific to notmuch
 ;;
 ;; Copyright © Jesse Rosenthal
 ;;
@@ -19,6 +19,8 @@
 ;;
 ;; Authors: Jesse Rosenthal <jrosenthal@jhu.edu>
 
+;;; Code:
+
 (require 'message)
 (require 'notmuch-tag)
 (require 'notmuch-mua)
@@ -46,3 +48,5 @@ the \"inbox\" and \"todo\" tags, you would set:
 (add-hook 'message-send-hook 'notmuch-message-mark-replied)
 
 (provide 'notmuch-message)
+
+;;; notmuch-message.el ends here
diff --git a/emacs/notmuch-mua.el b/emacs/notmuch-mua.el
index 935cbd3..3e5f887 100644
--- a/emacs/notmuch-mua.el
+++ b/emacs/notmuch-mua.el
@@ -1,4 +1,4 @@
-;; notmuch-mua.el --- emacs style mail-user-agent
+;;; notmuch-mua.el --- emacs style mail-user-agent
 ;;
 ;; Copyright © David Edmondson
 ;;
@@ -19,6 +19,8 @@
 ;;
 ;; Authors: David Edmondson <dme@dme.org>
 
+;;; Code:
+
 (require 'message)
 (require 'mm-view)
 (require 'format-spec)
@@ -513,3 +515,5 @@ simply runs the corresponding `message-mode' hook functions."
 ;;
 
 (provide 'notmuch-mua)
+
+;;; notmuch-mua.el ends here
diff --git a/emacs/notmuch-parser.el b/emacs/notmuch-parser.el
index d59c0e1..620ca89 100644
--- a/emacs/notmuch-parser.el
+++ b/emacs/notmuch-parser.el
@@ -1,4 +1,4 @@
-;; notmuch-parser.el --- streaming S-expression parser
+;;; notmuch-parser.el --- streaming S-expression parser
 ;;
 ;; Copyright © Austin Clements
 ;;
@@ -19,6 +19,8 @@
 ;;
 ;; Authors: Austin Clements <aclements@csail.mit.edu>
 
+;;; Code:
+
 (require 'cl)
 
 (defun notmuch-sexp-create-parser ()
@@ -205,3 +207,5 @@ move point in the input buffer."
 ;; Local Variables:
 ;; byte-compile-warnings: (not cl-functions)
 ;; End:
+
+;;; notmuch-parser.el ends here
diff --git a/emacs/notmuch-print.el b/emacs/notmuch-print.el
index 8c18f4b..480a0cf 100644
--- a/emacs/notmuch-print.el
+++ b/emacs/notmuch-print.el
@@ -1,4 +1,4 @@
-;; notmuch-print.el --- printing messages from notmuch.
+;;; notmuch-print.el --- printing messages from notmuch.
 ;;
 ;; Copyright © David Edmondson
 ;;
@@ -19,6 +19,8 @@
 ;;
 ;; Authors: David Edmondson <dme@dme.org>
 
+;;; Code:
+
 (require 'notmuch-lib)
 
 (declare-function notmuch-show-get-prop "notmuch-show" (prop &optional props))
@@ -90,3 +92,5 @@ Optional OUTPUT allows passing a list of flags to muttprint."
   (funcall notmuch-print-mechanism msg))
 
 (provide 'notmuch-print)
+
+;;; notmuch-print.el ends here
diff --git a/emacs/notmuch-query.el b/emacs/notmuch-query.el
index d1daffc..8587d88 100644
--- a/emacs/notmuch-query.el
+++ b/emacs/notmuch-query.el
@@ -1,4 +1,4 @@
-;; notmuch-query.el --- provide an emacs api to query notmuch
+;;; notmuch-query.el --- provide an emacs api to query notmuch
 ;;
 ;; Copyright © David Bremner
 ;;
@@ -19,6 +19,8 @@
 ;;
 ;; Authors: David Bremner <david@tethera.net>
 
+;;; Code:
+
 (require 'notmuch-lib)
 
 (defun notmuch-query-get-threads (search-terms)
@@ -74,3 +76,5 @@ See the function notmuch-query-get-threads for more information."
    (notmuch-query-get-threads search-terms)))
 
 (provide 'notmuch-query)
+
+;;; notmuch-query.el ends here
diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index 46e3869..5d9b7b4 100644
--- a/emacs/notmuch-show.el
+++ b/emacs/notmuch-show.el
@@ -1,4 +1,4 @@
-;; notmuch-show.el --- displaying notmuch forests.
+;;; notmuch-show.el --- displaying notmuch forests.
 ;;
 ;; Copyright © Carl Worth
 ;; Copyright © David Edmondson
@@ -21,6 +21,8 @@
 ;; Authors: Carl Worth <cworth@cworth.org>
 ;;          David Edmondson <dme@dme.org>
 
+;;; Code:
+
 (eval-when-compile (require 'cl))
 (require 'mm-view)
 (require 'message)
@@ -2379,3 +2381,5 @@ is destroyed when FN returns."
 
 
 (provide 'notmuch-show)
+
+;;; notmuch-show.el ends here
diff --git a/emacs/notmuch-tag.el b/emacs/notmuch-tag.el
index c7f62c9..98064a3 100644
--- a/emacs/notmuch-tag.el
+++ b/emacs/notmuch-tag.el
@@ -1,4 +1,4 @@
-;; notmuch-tag.el --- tag messages within emacs
+;;; notmuch-tag.el --- tag messages within emacs
 ;;
 ;; Copyright © Damien Cassou
 ;; Copyright © Carl Worth
diff --git a/emacs/notmuch-tree.el b/emacs/notmuch-tree.el
index 384cb76..4f9ca2d 100644
--- a/emacs/notmuch-tree.el
+++ b/emacs/notmuch-tree.el
@@ -1,4 +1,4 @@
-;; notmuch-tree.el --- displaying notmuch forests.
+;;; notmuch-tree.el --- displaying notmuch forests.
 ;;
 ;; Copyright © Carl Worth
 ;; Copyright © David Edmondson
@@ -22,6 +22,8 @@
 ;; Authors: David Edmondson <dme@dme.org>
 ;;          Mark Walters <markwalters1009@gmail.com>
 
+;;; Code:
+
 (require 'mail-parse)
 
 (require 'notmuch-lib)
@@ -945,3 +947,5 @@ The arguments are:
 ;;
 
 (provide 'notmuch-tree)
+
+;;; notmuch-tree.el ends here
diff --git a/emacs/notmuch-version.el.tmpl b/emacs/notmuch-version.el.tmpl
index 236aaf7..88cc01c 100644
--- a/emacs/notmuch-version.el.tmpl
+++ b/emacs/notmuch-version.el.tmpl
@@ -1,3 +1,4 @@
+;;; notmuch-version.el --- Version of notmuch
 ;; -*- emacs-lisp -*-
 ;;
 ;; %AG%
@@ -17,7 +18,11 @@
 ;; You should have received a copy of the GNU General Public License
 ;; along with Notmuch.  If not, see <http://www.gnu.org/licenses/>.
 
+;;; Code:
+
 (defconst notmuch-emacs-version %VERSION%
   "Version of Notmuch Emacs MUA.")
 
 (provide 'notmuch-version)
+
+;;; notmuch-version.el ends here
diff --git a/emacs/notmuch-wash.el b/emacs/notmuch-wash.el
index a76b4f5..065af16 100644
--- a/emacs/notmuch-wash.el
+++ b/emacs/notmuch-wash.el
@@ -1,4 +1,4 @@
-;; notmuch-wash.el --- cleaning up message bodies
+;;; notmuch-wash.el --- cleaning up message bodies
 ;;
 ;; Copyright © Carl Worth
 ;; Copyright © David Edmondson
@@ -21,6 +21,8 @@
 ;; Authors: Carl Worth <cworth@cworth.org>
 ;;          David Edmondson <dme@dme.org>
 
+;;; Code:
+
 (require 'coolj)
 
 (declare-function notmuch-show-insert-bodypart "notmuch-show" (msg part depth &optional hide))
@@ -423,3 +425,5 @@ for error."
 ;;
 
 (provide 'notmuch-wash)
+
+;;; notmuch-wash.el ends here
diff --git a/emacs/notmuch.el b/emacs/notmuch.el
index 060af8e..b45b5ec 100644
--- a/emacs/notmuch.el
+++ b/emacs/notmuch.el
@@ -1,4 +1,4 @@
-;; notmuch.el --- run notmuch within emacs
+;;; notmuch.el --- run notmuch within emacs
 ;;
 ;; Copyright © Carl Worth
 ;;
@@ -19,6 +19,8 @@
 ;;
 ;; Authors: Carl Worth <cworth@cworth.org>
 
+;;; Commentary:
+
 ;; This is an emacs-based interface to the notmuch mail system.
 ;;
 ;; You will first need to have the notmuch program installed and have a
@@ -47,6 +49,8 @@
 ;; kudos: Notmuch list <notmuch@notmuchmail.org> (subscription is not
 ;; required, but is available from http://notmuchmail.org).
 
+;;; Code:
+
 (eval-when-compile (require 'cl))
 (require 'mm-view)
 (require 'message)
@@ -1064,3 +1068,5 @@ notmuch buffers exist, run `notmuch'."
     (let ((init-file (locate-file notmuch-init-file '("/")
 				  (get-load-suffixes))))
       (if init-file (load init-file nil t t))))
+
+;;; notmuch.el ends here
-- 
2.8.0


Thread: