bug#4612: 23.1; checkdoc insert ";;; Code" before autoload cookie

bug#4612: 23.1; checkdoc insert ";;; Code" before autoload cookie

[Kevin Ryde]

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

On foo.el below M-x checkdoc inserts ";;; Code" as

    ;;;###autoload
    ;;; Code:
    (defun foo ()

where I hoped it would be before the cookie like say

    ;;; Code:

    ;;;###autoload
    (defun foo ()

generate-file-autoloads etc is happy with either, but the latter reads
better for humans.  I struck this in one of my own .el files which had
an autoload cookie on the first func.

Incidentally, I see the `cont' loop puts ";;; Code" after any initial
`require' forms.  Is that actually usual, or usual any more?  I think
I've only ever seen `require's after ";;; Code".


2009-10-01  Kevin Ryde  <user42@zip.com.au>

	* emacs-lisp/checkdoc.el (checkdoc-file-comments-engine): When
	inserting ";;; Code" put it before any ";;;###autoload" cookie on
	the first form.  And insert a blank line after ";;; Code" since
	that's usual style.


[-- Attachment #2: foo.el --]
[-- Type: application/emacs-lisp, Size: 187 bytes --]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: checkdoc.el.code-autoload.diff --]
[-- Type: text/x-diff, Size: 915 bytes --]

--- checkdoc.el.~1.74.~	2009-09-18 08:22:27.000000000 +1000
+++ checkdoc.el	2009-09-25 18:22:29.000000000 +1000
@@ -2304,15 +2304,18 @@
        (or
 	;; * Code section
 	(if (not (lm-code-mark))
-	    (let ((cont t))
+	    (let ((cont t)
+		  pos)
 	      (goto-char (point-min))
-	      (while (and cont (re-search-forward "^(" nil t))
-		(setq cont (looking-at "require\\s-+")))
+	      ;; matching ";;;###" to keep autoload cookie with the form
+	      (while (and cont (re-search-forward "^\\(;;;###.*\n\\)?(" nil t))
+		(setq pos (match-beginning 0)
+		      cont (looking-at "require\\s-+")))
 	      (if (and (not cont)
 		       (checkdoc-y-or-n-p
 			"There is no ;;; Code: marker.  Insert one? "))
-		  (progn (beginning-of-line)
-			 (insert ";;; Code:\n")
+		  (progn (goto-char pos)
+			 (insert ";;; Code:\n\n")
 			 nil)
 		(checkdoc-create-error
 		 "You should have a section marked \";;; Code:\""

[-- Attachment #4: Type: text/plain, Size: 1076 bytes --]



In GNU Emacs 23.1.1 (i486-pc-linux-gnu, GTK+ Version 2.16.5)
 of 2009-09-14 on raven, modified by Debian
configured using `configure  '--build=i486-linux-gnu' '--host=i486-linux-gnu' '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib' '--localstatedir=/var/lib' '--infodir=/usr/share/info' '--mandir=/usr/share/man' '--with-pop=yes' '--enable-locallisppath=/etc/emacs23:/etc/emacs:/usr/local/share/emacs/23.1/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/23.1/site-lisp:/usr/share/emacs/site-lisp:/usr/share/emacs/23.1/leim' '--with-x=yes' '--with-x-toolkit=gtk' '--with-toolkit-scroll-bars' 'build_alias=i486-linux-gnu' 'host_alias=i486-linux-gnu' 'CFLAGS=-DDEBIAN -g -O2' 'LDFLAGS=-g' 'CPPFLAGS=''

Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: en_AU
  value of $XMODIFIERS: nil
  locale-coding-system: iso-latin-1-unix
  default-enable-multibyte-characters: t

bug#4612: marked as done (23.1; checkdoc insert ";;; Code" before autoload cookie)

[Emacs bug Tracking System]

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

Your message dated Thu, 22 Oct 2009 09:10:29 +1100
with message-id <8763a8mm96.fsf@blah.blah>
and subject line Re: bug#4612: 23.1; checkdoc insert ";;; Code" before autoload cookie
has caused the Emacs bug report #4612,
regarding 23.1; checkdoc insert ";;; Code" before autoload cookie
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@emacsbugs.donarmstrong.com
immediately.)


-- 
4612: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=4612
Emacs Bug Tracking System
Contact owner@emacsbugs.donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 5666 bytes --]

[-- Attachment #2.1.1: Type: text/plain, Size: 846 bytes --]

On foo.el below M-x checkdoc inserts ";;; Code" as

    ;;;###autoload
    ;;; Code:
    (defun foo ()

where I hoped it would be before the cookie like say

    ;;; Code:

    ;;;###autoload
    (defun foo ()

generate-file-autoloads etc is happy with either, but the latter reads
better for humans.  I struck this in one of my own .el files which had
an autoload cookie on the first func.

Incidentally, I see the `cont' loop puts ";;; Code" after any initial
`require' forms.  Is that actually usual, or usual any more?  I think
I've only ever seen `require's after ";;; Code".


2009-10-01  Kevin Ryde  <user42@zip.com.au>

	* emacs-lisp/checkdoc.el (checkdoc-file-comments-engine): When
	inserting ";;; Code" put it before any ";;;###autoload" cookie on
	the first form.  And insert a blank line after ";;; Code" since
	that's usual style.


[-- Attachment #2.1.2: foo.el --]
[-- Type: application/emacs-lisp, Size: 187 bytes --]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2.1.3: checkdoc.el.code-autoload.diff --]
[-- Type: text/x-diff, Size: 915 bytes --]

--- checkdoc.el.~1.74.~	2009-09-18 08:22:27.000000000 +1000
+++ checkdoc.el	2009-09-25 18:22:29.000000000 +1000
@@ -2304,15 +2304,18 @@
        (or
 	;; * Code section
 	(if (not (lm-code-mark))
-	    (let ((cont t))
+	    (let ((cont t)
+		  pos)
 	      (goto-char (point-min))
-	      (while (and cont (re-search-forward "^(" nil t))
-		(setq cont (looking-at "require\\s-+")))
+	      ;; matching ";;;###" to keep autoload cookie with the form
+	      (while (and cont (re-search-forward "^\\(;;;###.*\n\\)?(" nil t))
+		(setq pos (match-beginning 0)
+		      cont (looking-at "require\\s-+")))
 	      (if (and (not cont)
 		       (checkdoc-y-or-n-p
 			"There is no ;;; Code: marker.  Insert one? "))
-		  (progn (beginning-of-line)
-			 (insert ";;; Code:\n")
+		  (progn (goto-char pos)
+			 (insert ";;; Code:\n\n")
 			 nil)
 		(checkdoc-create-error
 		 "You should have a section marked \";;; Code:\""

[-- Attachment #2.1.4: Type: text/plain, Size: 1076 bytes --]



In GNU Emacs 23.1.1 (i486-pc-linux-gnu, GTK+ Version 2.16.5)
 of 2009-09-14 on raven, modified by Debian
configured using `configure  '--build=i486-linux-gnu' '--host=i486-linux-gnu' '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib' '--localstatedir=/var/lib' '--infodir=/usr/share/info' '--mandir=/usr/share/man' '--with-pop=yes' '--enable-locallisppath=/etc/emacs23:/etc/emacs:/usr/local/share/emacs/23.1/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/23.1/site-lisp:/usr/share/emacs/site-lisp:/usr/share/emacs/23.1/leim' '--with-x=yes' '--with-x-toolkit=gtk' '--with-toolkit-scroll-bars' 'build_alias=i486-linux-gnu' 'host_alias=i486-linux-gnu' 'CFLAGS=-DDEBIAN -g -O2' 'LDFLAGS=-g' 'CPPFLAGS=''

Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: en_AU
  value of $XMODIFIERS: nil
  locale-coding-system: iso-latin-1-unix
  default-enable-multibyte-characters: t

[-- Attachment #3: Type: message/rfc822, Size: 2088 bytes --]

From: Kevin Ryde <user42@zip.com.au>
To: 4612-done@emacsbugs.donarmstrong.com
Cc: Stefan Monnier <monnier@iro.umontreal.ca>
Subject: Re: bug#4612: 23.1; checkdoc insert ";;; Code" before autoload cookie
Date: Thu, 22 Oct 2009 09:10:29 +1100
Message-ID: <8763a8mm96.fsf@blah.blah>

Stefan Monnier <monnier@iro.umontreal.ca> writes:
>
> Please install it.

Beaut, done.  I used generate-autoload-cookie too, for gratuitous
generality :-).

I've still got doubts about putting the ";; Code:" after `require's, but
I'll leave that alone failing a reason for or against it being that way.