Commit | Line | Data |
---|---|---|
0fc37e7d ER |
1 | ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers |
2 | ||
6e24ad22 | 3 | ;; Copyright (C) 1992, 1994, 1997 Free Software Foundation, Inc. |
0fc37e7d ER |
4 | |
5 | ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> | |
6 | ;; Maintainer: Eric S. Raymond <esr@snark.thyrsus.com> | |
7 | ;; Created: 14 Jul 1992 | |
0fc37e7d | 8 | ;; Keywords: docs |
1894df21 | 9 | ;; X-Bogus-Bureaucratic-Cruft: Gruad will get you if you don't watch out! |
0fc37e7d ER |
10 | |
11 | ;; This file is part of GNU Emacs. | |
12 | ||
13 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
14 | ;; it under the terms of the GNU General Public License as published by | |
7c938215 | 15 | ;; the Free Software Foundation; either version 2, or (at your option) |
0fc37e7d ER |
16 | ;; any later version. |
17 | ||
18 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
d5eead69 | 24 | ;; along with GNU Emacs; see the file COPYING. If not, write to |
470c5afe EN |
25 | ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
26 | ;; Boston, MA 02111-1307, USA. | |
0fc37e7d ER |
27 | |
28 | ;;; Commentary: | |
29 | ||
30 | ;; This minor mode adds some services to Emacs-Lisp editing mode. | |
31 | ;; | |
32 | ;; First, it knows about the header conventions for library packages. | |
33 | ;; One entry point supports generating synopses from a library directory. | |
34 | ;; Another can be used to check for missing headers in library files. | |
35 | ;; | |
36 | ;; Another entry point automatically addresses bug mail to a package's | |
37 | ;; maintainer or author. | |
38 | ||
39 | ;; This file can be loaded by your lisp-mode-hook. Have it (require 'lisp-mnt) | |
40 | ||
41 | ;; This file is an example of the header conventions. Note the following | |
42 | ;; features: | |
43 | ;; | |
44 | ;; * Header line --- makes it possible to extract a one-line summary of | |
45 | ;; the package's uses automatically for use in library synopses, KWIC | |
46 | ;; indexes and the like. | |
47 | ;; | |
48 | ;; Format is three semicolons, followed by the filename, followed by | |
49 | ;; three dashes, followed by the summary. All fields space-separated. | |
50 | ;; | |
51 | ;; * Author line --- contains the name and net address of at least | |
52 | ;; the principal author. | |
53 | ;; | |
68756f1f | 54 | ;; If there are multiple authors, they should be listed on continuation |
0fc37e7d ER |
55 | ;; lines led by ;;<TAB>, like this: |
56 | ;; | |
57 | ;; ;; Author: Ashwin Ram <Ram-Ashwin@cs.yale.edu> | |
58 | ;; ;; Dave Sill <de5@ornl.gov> | |
59 | ;; ;; David Lawrence <tale@pawl.rpi.edu> | |
60 | ;; ;; Noah Friedman <friedman@ai.mit.edu> | |
61 | ;; ;; Joe Wells <jbw@maverick.uswest.com> | |
62 | ;; ;; Dave Brennan <brennan@hal.com> | |
63 | ;; ;; Eric Raymond <esr@snark.thyrsus.com> | |
64 | ;; | |
65 | ;; This field may have some special values; notably "FSF", meaning | |
66 | ;; "Free Software Foundation". | |
67 | ;; | |
68 | ;; * Maintainer line --- should be a single name/address as in the Author | |
69 | ;; line, or an address only, or the string "FSF". If there is no maintainer | |
70 | ;; line, the person(s) in the Author field are presumed to be it. The example | |
71 | ;; in this file is mildly bogus because the maintainer line is redundant. | |
ca4bd734 | 72 | ;; The idea behind these two fields is to be able to write a Lisp function |
0fc37e7d ER |
73 | ;; that does "send mail to the author" without having to mine the name out by |
74 | ;; hand. Please be careful about surrounding the network address with <> if | |
75 | ;; there's also a name in the field. | |
76 | ;; | |
77 | ;; * Created line --- optional, gives the original creation date of the | |
78 | ;; file. For historical interest, basically. | |
79 | ;; | |
80 | ;; * Version line --- intended to give the reader a clue if they're looking | |
68756f1f ER |
81 | ;; at a different version of the file than the one they're accustomed to. This |
82 | ;; may be an RCS or SCCS header. | |
0fc37e7d ER |
83 | ;; |
84 | ;; * Adapted-By line --- this is for FSF's internal use. The person named | |
85 | ;; in this field was the one responsible for installing and adapting the | |
86 | ;; package for the distribution. (This file doesn't have one because the | |
87 | ;; author *is* one of the maintainers.) | |
88 | ;; | |
89 | ;; * Keywords line --- used by the finder code (now under construction) | |
c0d79871 | 90 | ;; for finding Emacs Lisp code related to a topic. |
0fc37e7d | 91 | ;; |
1894df21 NF |
92 | ;; * X-Bogus-Bureaucratic-Cruft line --- this is a joke and an example |
93 | ;; of a comment header. Headers starting with `X-' should never be used | |
94 | ;; for any real purpose; this is the way to safely add random headers | |
95 | ;; without invoking the wrath of any program. | |
0fc37e7d | 96 | ;; |
ca4bd734 | 97 | ;; * Commentary line --- enables Lisp code to find the developer's and |
0fc37e7d ER |
98 | ;; maintainers' explanations of the package internals. |
99 | ;; | |
100 | ;; * Change log line --- optional, exists to terminate the commentary | |
101 | ;; section and start a change-log part, if one exists. | |
102 | ;; | |
c0d79871 | 103 | ;; * Code line --- exists so Lisp can know where commentary and/or |
0fc37e7d ER |
104 | ;; change-log sections end. |
105 | ;; | |
106 | ;; * Footer line --- marks end-of-file so it can be distinguished from | |
107 | ;; an expanded formfeed or the results of truncation. | |
108 | ||
109 | ;;; Change Log: | |
110 | ||
111 | ;; Tue Jul 14 23:44:17 1992 ESR | |
112 | ;; * Created. | |
113 | ||
114 | ;;; Code: | |
115 | ||
68756f1f | 116 | (require 'emacsbug) |
0fc37e7d | 117 | |
d5eead69 RS |
118 | ;;; Variables: |
119 | ||
ca4bd734 | 120 | (defvar lm-header-prefix "^;;*[ \t]+\\(@\(#\)\\)?[ \t]*\\([\$]\\)?" |
d5eead69 | 121 | "Prefix that is ignored before the tag. |
ca4bd734 RS |
122 | For example, you can write the 1st line synopsis string and headers like this |
123 | in your Lisp package: | |
d5eead69 RS |
124 | |
125 | ;; @(#) package.el -- pacakge description | |
126 | ;; | |
127 | ;; @(#) $Maintainer: Person Foo Bar $ | |
128 | ||
129 | The @(#) construct is used by unix what(1) and | |
130 | then $identifier: doc string $ is used by GNU ident(1)") | |
131 | ||
ca4bd734 | 132 | (defvar lm-comment-column 16 |
d5eead69 RS |
133 | "Column used for placing formatted output.") |
134 | ||
ca4bd734 | 135 | (defvar lm-commentary-header "Commentary\\|Documentation" |
d5eead69 RS |
136 | "Regexp which matches start of documentation section.") |
137 | ||
ca4bd734 | 138 | (defvar lm-history-header "Change Log\\|History" |
d5eead69 RS |
139 | "Regexp which matches the start of code log section.") |
140 | ||
141 | ;;; Functions: | |
142 | ||
0fc37e7d ER |
143 | ;; These functions all parse the headers of the current buffer |
144 | ||
d5eead69 | 145 | (defsubst lm-get-header-re (header &optional mode) |
6e24ad22 | 146 | "Return regexp for matching HEADER. |
ca4bd734 RS |
147 | If called with optional MODE and with value `section', |
148 | return section regexp instead." | |
149 | (cond ((eq mode 'section) | |
150 | (concat "^;;;;* " header ":[ \t]*$")) | |
151 | (t | |
152 | (concat lm-header-prefix header ":[ \t]*")))) | |
d5eead69 RS |
153 | |
154 | (defsubst lm-get-package-name () | |
6e24ad22 | 155 | "Return package name by looking at the first line." |
d5eead69 RS |
156 | (save-excursion |
157 | (goto-char (point-min)) | |
158 | (if (and (looking-at (concat lm-header-prefix)) | |
159 | (progn (goto-char (match-end 0)) | |
160 | (looking-at "\\([^\t ]+\\)") | |
161 | (match-end 1))) | |
6e24ad22 | 162 | (buffer-substring-no-properties (match-beginning 1) (match-end 1)) |
d5eead69 RS |
163 | ))) |
164 | ||
165 | (defun lm-section-mark (header &optional after) | |
166 | "Return the buffer location of a given section start marker. | |
ca4bd734 RS |
167 | The HEADER is the section mark string to search for. |
168 | If AFTER is non-nil, return the location of the next line." | |
0fc37e7d ER |
169 | (save-excursion |
170 | (let ((case-fold-search t)) | |
171 | (goto-char (point-min)) | |
d5eead69 | 172 | (if (re-search-forward (lm-get-header-re header 'section) nil t) |
0fc37e7d ER |
173 | (progn |
174 | (beginning-of-line) | |
64e07c7b | 175 | (if after (forward-line 1)) |
0fc37e7d ER |
176 | (point)) |
177 | nil)))) | |
178 | ||
d5eead69 | 179 | (defsubst lm-code-mark () |
ca4bd734 | 180 | "Return the buffer location of the `Code' start marker." |
0fc37e7d ER |
181 | (lm-section-mark "Code")) |
182 | ||
d5eead69 | 183 | (defsubst lm-commentary-mark () |
ca4bd734 | 184 | "Return the buffer location of the `Commentary' start marker." |
d5eead69 RS |
185 | (lm-section-mark lm-commentary-header)) |
186 | ||
187 | (defsubst lm-history-mark () | |
ca4bd734 | 188 | "Return the buffer location of the `History' start marker." |
d5eead69 RS |
189 | (lm-section-mark lm-history-header)) |
190 | ||
191 | (defun lm-header (header) | |
ca4bd734 RS |
192 | "Return the contents of the header named HEADER." |
193 | (goto-char (point-min)) | |
194 | (let ((case-fold-search t)) | |
195 | (if (and (re-search-forward (lm-get-header-re header) (lm-code-mark) t) | |
196 | ;; RCS ident likes format "$identifier: data$" | |
197 | (looking-at "\\([^$\n]+\\)") | |
198 | (match-end 1)) | |
6e24ad22 | 199 | (buffer-substring-no-properties (match-beginning 1) (match-end 1)) |
ca4bd734 | 200 | nil))) |
0fc37e7d | 201 | |
d5eead69 | 202 | (defun lm-header-multiline (header) |
ca4bd734 | 203 | "Return the contents of the header named HEADER, with continuation lines. |
d5eead69 | 204 | The returned value is a list of strings, one per line." |
0fc37e7d ER |
205 | (save-excursion |
206 | (goto-char (point-min)) | |
d5eead69 RS |
207 | (let ((res (lm-header header))) |
208 | (cond | |
209 | (res | |
210 | (setq res (list res)) | |
211 | (forward-line 1) | |
212 | ||
213 | (while (and (looking-at (concat lm-header-prefix "[\t ]+")) | |
214 | (progn | |
215 | (goto-char (match-end 0)) | |
216 | (looking-at "\\(.*\\)")) | |
217 | (match-end 1)) | |
6e24ad22 | 218 | (setq res (cons (buffer-substring-no-properties |
d5eead69 RS |
219 | (match-beginning 1) |
220 | (match-end 1)) | |
221 | res)) | |
222 | (forward-line 1)) | |
223 | )) | |
224 | res | |
225 | ))) | |
0fc37e7d ER |
226 | |
227 | ;; These give us smart access to the header fields and commentary | |
228 | ||
229 | (defun lm-summary (&optional file) | |
ca4bd734 | 230 | "Return the one-line summary of file FILE, or current buffer if FILE is nil." |
0fc37e7d ER |
231 | (save-excursion |
232 | (if file | |
233 | (find-file file)) | |
234 | (goto-char (point-min)) | |
235 | (prog1 | |
d5eead69 RS |
236 | (if (and |
237 | (looking-at lm-header-prefix) | |
238 | (progn (goto-char (match-end 0)) | |
239 | (looking-at "[^ ]+[ \t]+--+[ \t]+\\(.*\\)"))) | |
6e24ad22 | 240 | (buffer-substring-no-properties (match-beginning 1) (match-end 1))) |
0fc37e7d ER |
241 | (if file |
242 | (kill-buffer (current-buffer))) | |
243 | ))) | |
244 | ||
68756f1f | 245 | (defun lm-crack-address (x) |
6e24ad22 | 246 | "Split up an email address X into full name and real email address. |
ca4bd734 | 247 | The value is a cons of the form (FULLNAME . ADDRESS)." |
68756f1f ER |
248 | (cond ((string-match "\\(.+\\) [(<]\\(\\S-+@\\S-+\\)[>)]" x) |
249 | (cons (substring x (match-beginning 1) (match-end 1)) | |
250 | (substring x (match-beginning 2) (match-end 2)))) | |
251 | ((string-match "\\(\\S-+@\\S-+\\) [(<]\\(.*\\)[>)]" x) | |
252 | (cons (substring x (match-beginning 2) (match-end 2)) | |
253 | (substring x (match-beginning 1) (match-end 1)))) | |
254 | ((string-match "\\S-+@\\S-+" x) | |
255 | (cons nil x)) | |
256 | (t | |
257 | (cons x nil)))) | |
258 | ||
0fc37e7d | 259 | (defun lm-authors (&optional file) |
ca4bd734 RS |
260 | "Return the author list of file FILE, or current buffer if FILE is nil. |
261 | Each element of the list is a cons; the car is the full name, | |
262 | the cdr is an email address." | |
0fc37e7d ER |
263 | (save-excursion |
264 | (if file | |
265 | (find-file file)) | |
68756f1f ER |
266 | (let ((authorlist (lm-header-multiline "author"))) |
267 | (prog1 | |
268 | (mapcar 'lm-crack-address authorlist) | |
269 | (if file | |
270 | (kill-buffer (current-buffer))) | |
271 | )))) | |
0fc37e7d ER |
272 | |
273 | (defun lm-maintainer (&optional file) | |
ca4bd734 RS |
274 | "Return the maintainer of file FILE, or current buffer if FILE is nil. |
275 | The return value has the form (NAME . ADDRESS)." | |
0fc37e7d ER |
276 | (save-excursion |
277 | (if file | |
278 | (find-file file)) | |
279 | (prog1 | |
68756f1f ER |
280 | (let ((maint (lm-header "maintainer"))) |
281 | (if maint | |
282 | (lm-crack-address maint) | |
283 | (car (lm-authors)))) | |
0fc37e7d ER |
284 | (if file |
285 | (kill-buffer (current-buffer))) | |
286 | ))) | |
287 | ||
288 | (defun lm-creation-date (&optional file) | |
ca4bd734 | 289 | "Return the created date given in file FILE, or current buffer if FILE is nil." |
0fc37e7d ER |
290 | (save-excursion |
291 | (if file | |
292 | (find-file file)) | |
293 | (prog1 | |
294 | (lm-header "created") | |
295 | (if file | |
296 | (kill-buffer (current-buffer))) | |
297 | ))) | |
298 | ||
299 | ||
300 | (defun lm-last-modified-date (&optional file) | |
ca4bd734 | 301 | "Return the modify-date given in file FILE, or current buffer if FILE is nil." |
0fc37e7d ER |
302 | (save-excursion |
303 | (if file | |
304 | (find-file file)) | |
305 | (prog1 | |
68756f1f ER |
306 | (if (progn |
307 | (goto-char (point-min)) | |
308 | (re-search-forward | |
e555bfcb | 309 | "\\$[I]d: [^ ]+ [^ ]+ \\([^/]+\\)/\\([^/]+\\)/\\([^ ]+\\) " |
68756f1f ER |
310 | (lm-code-mark) t)) |
311 | (format "%s %s %s" | |
312 | (buffer-substring (match-beginning 3) (match-end 3)) | |
313 | (nth (string-to-int | |
314 | (buffer-substring (match-beginning 2) (match-end 2))) | |
315 | '("" "Jan" "Feb" "Mar" "Apr" "May" "Jun" | |
316 | "Jul" "Aug" "Sep" "Oct" "Nov" "Dec")) | |
317 | (buffer-substring (match-beginning 1) (match-end 1)) | |
318 | )) | |
0fc37e7d ER |
319 | (if file |
320 | (kill-buffer (current-buffer))) | |
68756f1f | 321 | ))) |
0fc37e7d ER |
322 | |
323 | (defun lm-version (&optional file) | |
ca4bd734 RS |
324 | "Return the version listed in file FILE, or current buffer if FILE is nil. |
325 | This can befound in an RCS or SCCS header to crack it out of." | |
0fc37e7d ER |
326 | (save-excursion |
327 | (if file | |
328 | (find-file file)) | |
329 | (prog1 | |
330 | (or | |
331 | (lm-header "version") | |
332 | (let ((header-max (lm-code-mark))) | |
333 | (goto-char (point-min)) | |
334 | (cond | |
335 | ;; Look for an RCS header | |
e555bfcb | 336 | ((re-search-forward "\\$[I]d: [^ ]+ \\([^ ]+\\) " header-max t) |
6e24ad22 | 337 | (buffer-substring-no-properties (match-beginning 1) (match-end 1))) |
0fc37e7d ER |
338 | |
339 | ;; Look for an SCCS header | |
340 | ((re-search-forward | |
341 | (concat | |
342 | (regexp-quote "@(#)") | |
343 | (regexp-quote (file-name-nondirectory (buffer-file-name))) | |
344 | "\t\\([012345679.]*\\)") | |
345 | header-max t) | |
6e24ad22 | 346 | (buffer-substring-no-properties (match-beginning 1) (match-end 1))) |
0fc37e7d ER |
347 | |
348 | (t nil)))) | |
349 | (if file | |
350 | (kill-buffer (current-buffer))) | |
351 | ))) | |
352 | ||
353 | (defun lm-keywords (&optional file) | |
ca4bd734 | 354 | "Return the keywords given in file FILE, or current buffer if FILE is nil." |
0fc37e7d ER |
355 | (save-excursion |
356 | (if file | |
357 | (find-file file)) | |
358 | (prog1 | |
359 | (let ((keywords (lm-header "keywords"))) | |
360 | (and keywords (downcase keywords))) | |
361 | (if file | |
362 | (kill-buffer (current-buffer))) | |
363 | ))) | |
364 | ||
365 | (defun lm-adapted-by (&optional file) | |
ca4bd734 RS |
366 | "Return the adapted-by names in file FILE, or current buffer if FILE is nil. |
367 | This is the name of the person who cleaned up this package for | |
368 | distribution." | |
0fc37e7d ER |
369 | (save-excursion |
370 | (if file | |
371 | (find-file file)) | |
372 | (prog1 | |
373 | (lm-header "adapted-by") | |
374 | (if file | |
375 | (kill-buffer (current-buffer))) | |
376 | ))) | |
377 | ||
64e07c7b | 378 | (defun lm-commentary (&optional file) |
ca4bd734 RS |
379 | "Return the commentary in file FILE, or current buffer if FILE is nil. |
380 | The value is returned as a string. In the text, the commentary starts | |
381 | with tag `Commentary' and ends with tag `Change Log' or `History'." | |
0fc37e7d ER |
382 | (save-excursion |
383 | (if file | |
384 | (find-file file)) | |
385 | (prog1 | |
d5eead69 RS |
386 | (let ((commentary (lm-commentary-mark)) |
387 | (change-log (lm-history-mark)) | |
388 | (code (lm-code-mark)) | |
389 | ) | |
390 | (cond | |
391 | ((and commentary change-log) | |
6e24ad22 | 392 | (buffer-substring-no-properties commentary change-log)) |
d5eead69 | 393 | ((and commentary code) |
6e24ad22 | 394 | (buffer-substring-no-properties commentary code)) |
d5eead69 RS |
395 | (t |
396 | nil))) | |
0fc37e7d ER |
397 | (if file |
398 | (kill-buffer (current-buffer))) | |
399 | ))) | |
400 | ||
401 | ;;; Verification and synopses | |
402 | ||
d5eead69 | 403 | (defun lm-insert-at-column (col &rest strings) |
6e24ad22 | 404 | "Insert, at column COL, list of STRINGS." |
d5eead69 | 405 | (if (> (current-column) col) (insert "\n")) |
b4d73c71 | 406 | (move-to-column col t) |
d5eead69 | 407 | (apply 'insert strings)) |
0fc37e7d | 408 | |
d5eead69 | 409 | (defun lm-verify (&optional file showok &optional verb) |
0fc37e7d | 410 | "Check that the current buffer (or FILE if given) is in proper format. |
ca4bd734 | 411 | If FILE is a directory, recurse on its files and generate a report in |
0fc37e7d | 412 | a temporary buffer." |
d5eead69 RS |
413 | (interactive) |
414 | (let* ((verb (or verb (interactive-p))) | |
415 | ret | |
416 | name | |
417 | ) | |
418 | (if verb | |
419 | (setq ret "Ok.")) ;init value | |
420 | ||
421 | (if (and file (file-directory-p file)) | |
422 | (setq | |
423 | ret | |
424 | (progn | |
425 | (switch-to-buffer (get-buffer-create "*lm-verify*")) | |
426 | (erase-buffer) | |
427 | (mapcar | |
428 | '(lambda (f) | |
429 | (if (string-match ".*\\.el$" f) | |
430 | (let ((status (lm-verify f))) | |
431 | (if status | |
0fc37e7d ER |
432 | (progn |
433 | (insert f ":") | |
d5eead69 RS |
434 | (lm-insert-at-column lm-comment-column status "\n")) |
435 | (and showok | |
436 | (progn | |
437 | (insert f ":") | |
438 | (lm-insert-at-column lm-comment-column "OK\n"))))))) | |
439 | (directory-files file)) | |
440 | )) | |
441 | (save-excursion | |
442 | (if file | |
443 | (find-file file)) | |
444 | (setq name (lm-get-package-name)) | |
445 | ||
446 | (setq | |
447 | ret | |
448 | (prog1 | |
449 | (cond | |
450 | ((null name) | |
451 | "Can't find a package NAME") | |
452 | ||
453 | ((not (lm-authors)) | |
454 | "Author: tag missing.") | |
455 | ||
456 | ((not (lm-maintainer)) | |
457 | "Maintainer: tag missing.") | |
458 | ||
459 | ((not (lm-summary)) | |
460 | "Can't find a one-line 'Summary' description") | |
461 | ||
462 | ((not (lm-keywords)) | |
463 | "Keywords: tag missing.") | |
464 | ||
465 | ((not (lm-commentary-mark)) | |
466 | "Can't find a 'Commentary' section marker.") | |
467 | ||
468 | ((not (lm-history-mark)) | |
469 | "Can't find a 'History' section marker.") | |
470 | ||
471 | ((not (lm-code-mark)) | |
472 | "Can't find a 'Code' section marker") | |
473 | ||
474 | ((progn | |
475 | (goto-char (point-max)) | |
476 | (not | |
477 | (re-search-backward | |
478 | (concat "^;;;[ \t]+" name "[ \t]+ends here[ \t]*$" | |
479 | "\\|^;;;[ \t]+ End of file[ \t]+" name) | |
480 | nil t | |
481 | ))) | |
482 | (format "Can't find a footer line for [%s]" name)) | |
483 | (t | |
484 | ret)) | |
485 | (if file | |
486 | (kill-buffer (current-buffer))) | |
487 | )))) | |
488 | (if verb | |
489 | (message ret)) | |
490 | ret | |
491 | )) | |
0fc37e7d ER |
492 | |
493 | (defun lm-synopsis (&optional file showall) | |
494 | "Generate a synopsis listing for the buffer or the given FILE if given. | |
ca4bd734 RS |
495 | If FILE is a directory, recurse on its files and generate a report in |
496 | a temporary buffer. If SHOWALL is non-nil, also generate a line for files | |
0fc37e7d | 497 | which do not include a recognizable synopsis." |
d5eead69 RS |
498 | (interactive |
499 | (list | |
500 | (read-file-name "Synopsis for (file or dir): "))) | |
501 | ||
0fc37e7d ER |
502 | (if (and file (file-directory-p file)) |
503 | (progn | |
504 | (switch-to-buffer (get-buffer-create "*lm-verify*")) | |
505 | (erase-buffer) | |
506 | (mapcar | |
507 | '(lambda (f) | |
508 | (if (string-match ".*\\.el$" f) | |
509 | (let ((syn (lm-synopsis f))) | |
510 | (if syn | |
511 | (progn | |
512 | (insert f ":") | |
f9636fb2 | 513 | (lm-insert-at-column lm-comment-column syn "\n")) |
0fc37e7d ER |
514 | (and showall |
515 | (progn | |
516 | (insert f ":") | |
f9636fb2 | 517 | (lm-insert-at-column lm-comment-column "NA\n"))))))) |
0fc37e7d ER |
518 | (directory-files file)) |
519 | ) | |
520 | (save-excursion | |
521 | (if file | |
522 | (find-file file)) | |
523 | (prog1 | |
524 | (lm-summary) | |
525 | (if file | |
526 | (kill-buffer (current-buffer))) | |
527 | )))) | |
528 | ||
529 | (defun lm-report-bug (topic) | |
530 | "Report a bug in the package currently being visited to its maintainer. | |
6e24ad22 | 531 | Prompts for bug subject TOPIC. Leaves you in a mail buffer." |
68756f1f | 532 | (interactive "sBug Subject: ") |
d5eead69 RS |
533 | (let ((package (lm-get-package-name)) |
534 | (addr (lm-maintainer)) | |
535 | (version (lm-version))) | |
3082623d RS |
536 | (mail nil |
537 | (if addr | |
538 | (concat (car addr) " <" (cdr addr) ">") | |
539 | bug-gnu-emacs) | |
540 | topic) | |
0fc37e7d ER |
541 | (goto-char (point-max)) |
542 | (insert "\nIn " | |
543 | package | |
ef92f83b | 544 | (if version (concat " version " version) "") |
0fc37e7d | 545 | "\n\n") |
d5eead69 | 546 | (message |
0fc37e7d ER |
547 | (substitute-command-keys "Type \\[mail-send] to send bug report.")))) |
548 | ||
549 | (provide 'lisp-mnt) | |
550 | ||
551 | ;;; lisp-mnt.el ends here | |
d5eead69 | 552 |