procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve auto-insert-mode documentation

Browse source 
* lisp/autoinsert.el: Improve usage instructions and formatting.
(auto-insert-directory): Doc fix; the directory does not have to end
in slash.
This commit is contained in:
Stefan Kangas 2022-10-03 03:53:22 +02:00
parent 3951199985
commit 2973f91fb3
1 changed files with 19 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
lisp/autoinsert.el
View file

@ -1,7 +1,6 @@
;;; autoinsert.el --- automatic mode-dependent insertion of text into new files -*- lexical-binding: t -*-
;; Copyright (C) 1985-1987, 1994-1995, 1998, 2000-2022 Free Software
;; Foundation, Inc.
;; Copyright (C) 1985-2022 Free Software Foundation, Inc.
;; Author: Charlie Martin <crm@cs.duke.edu>
;; Adapted-By: Daniel Pfeiffer <occitan@esperanto.org>
@ -25,27 +24,27 @@
;;; Commentary:
;; The following defines an association list for text to be
;; automatically inserted when a new file is created, and a function
;; which automatically inserts these files; the idea is to insert
;; default text much as the mode is automatically set using
;; auto-mode-alist.
;; The following defines an association list for text to be
;; automatically inserted when a new file is created, and a function
;; which automatically inserts these files; the idea is to insert
;; default text much as the mode is automatically set using
;; auto-mode-alist.
;;
;; To use, add this to your Init file:
;;
;; To use:
;; (auto-insert-mode t)
;; setq auto-insert-directory to an appropriate slash-terminated value
;; (setq auto-insert-directory "~/some-dir")
;;
;; You can also customize the variable `auto-insert-mode' to load the
;; package. Alternatively, add the following to your init file:
;; (auto-insert-mode 1)
;; You can also customize the variable `auto-insert-mode' to load the
;; package.
;;
;; Author: Charlie Martin
;; Department of Computer Science and
;; National Biomedical Simulation Resource
;; Box 3709
;; Duke University Medical Center
;; Durham, NC 27710
;; (crm@cs.duke.edu,mcnc!duke!crm)
;; Author: Charlie Martin
;; Department of Computer Science and
;; National Biomedical Simulation Resource
;; Box 3709
;; Duke University Medical Center
;; Durham, NC 27710
;; (crm@cs.duke.edu,mcnc!duke!crm)
;;; Code:
@ -348,9 +347,7 @@ described above, e.g. [\"header.insert\" date-and-author-update]."
;; Establish a default value for auto-insert-directory
(defcustom auto-insert-directory "~/insert/"
"Directory from which auto-inserted files are taken.
The value must be an absolute directory name;
thus, on a GNU or Unix system, it must end in a slash."
"Directory from which auto-inserted files are taken."
:type 'directory)