From: Glenn Morris <rgm@gnu.org>
Date: Tue, 13 Sep 2011 06:55:10 +0000 (-0700)
Subject: Doc fixes related to lisp-indent-function (bug#9484)
X-Git-Tag: emacs-pretest-24.0.90~104^2~68
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b75567193d7ad56b4ff1e385bc94423621064dbd;p=emacs.git

Doc fixes related to lisp-indent-function (bug#9484)

* lisp/emacs-lisp/lisp-mode.el (lisp-indent-function): Doc fix.

* lisp/progmodes/scheme.el (scheme-indent-function): Give it a doc string.

* lisp/emacs-lisp/cl-indent.el (common-lisp-indent-function): Comment.
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index b96b2a4a542..91368fe5304 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2011-09-13  Glenn Morris  <rgm@gnu.org>
+
+	* emacs-lisp/lisp-mode.el (lisp-indent-function):
+	* progmodes/scheme.el (scheme-indent-function): Doc fixes.
+
 2011-09-12  Chong Yidong  <cyd@stupidchicken.com>
 
 	* dired-aux.el (dired-mark-read-string): Don't return default
diff --git a/lisp/emacs-lisp/cl-indent.el b/lisp/emacs-lisp/cl-indent.el
index 40434636e62..287bb531538 100644
--- a/lisp/emacs-lisp/cl-indent.el
+++ b/lisp/emacs-lisp/cl-indent.el
@@ -167,6 +167,7 @@ is set to `defun'.")
 	   (+ loop-indentation lisp-loop-forms-indentation)))))
 
 
+;; Cf (info "(elisp)Specification List")
 ;;;###autoload
 (defun common-lisp-indent-function (indent-point state)
   "Function to indent the arguments of a Lisp function call.
diff --git a/lisp/emacs-lisp/lisp-mode.el b/lisp/emacs-lisp/lisp-mode.el
index c8620aaa439..f2bea30ea39 100644
--- a/lisp/emacs-lisp/lisp-mode.el
+++ b/lisp/emacs-lisp/lisp-mode.el
@@ -1102,25 +1102,31 @@ is the buffer position of the start of the containing expression."
 
 (defun lisp-indent-function (indent-point state)
   "This function is the normal value of the variable `lisp-indent-function'.
-It is used when indenting a line within a function call, to see if the
-called function says anything special about how to indent the line.
+The function `calculate-lisp-indent' calls this to determine
+if the arguments of a Lisp function call should be indented specially.
 
 INDENT-POINT is the position where the user typed TAB, or equivalent.
 Point is located at the point to indent under (for default indentation);
 STATE is the `parse-partial-sexp' state for that position.
 
-If the current line is in a call to a Lisp function
-which has a non-nil property `lisp-indent-function',
-that specifies how to do the indentation.  The property value can be
-* `defun', meaning indent `defun'-style;
+If the current line is in a call to a Lisp function that has a non-nil
+property `lisp-indent-function' (or the deprecated `lisp-indent-hook'),
+it specifies how to indent.  The property value can be:
+
+* `defun', meaning indent `defun'-style
+  \(this is also the case if there is no property and the function
+  has a name that begins with \"def\", and three or more arguments);
+
 * an integer N, meaning indent the first N arguments specially
-  like ordinary function arguments and then indent any further
+  (like ordinary function arguments), and then indent any further
   arguments like a body;
-* a function to call just as this function was called.
-  If that function returns nil, that means it doesn't specify
-  the indentation.
 
-This function also returns nil meaning don't specify the indentation."
+* a function to call that returns the indentation (or nil).
+  `lisp-indent-function' calls this function with the same two arguments
+  that it itself received.
+
+This function returns either the indentation to use, or nil if the
+Lisp function does not specify a special indentation."
   (let ((normal-indent (current-column)))
     (goto-char (1+ (elt state 1)))
     (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
diff --git a/lisp/progmodes/scheme.el b/lisp/progmodes/scheme.el
index 470b309434c..fadcbf158e9 100644
--- a/lisp/progmodes/scheme.el
+++ b/lisp/progmodes/scheme.el
@@ -442,9 +442,19 @@ that variable's value is a string."
 
 (defvar calculate-lisp-indent-last-sexp)
 
-;; Copied from lisp-indent-function, but with gets of
-;; scheme-indent-{function,hook}.
+
+;; FIXME this duplicates almost all of lisp-indent-function.
+;; Extract common code to a subroutine.
 (defun scheme-indent-function (indent-point state)
+  "Scheme mode function for the value of the variable `lisp-indent-function'.
+This behaves like the function `lisp-indent-function', except that:
+
+i) it checks for a non-nil value of the property `scheme-indent-function'
+\(or the deprecated `scheme-indent-hook'), rather than `lisp-indent-function.'
+
+ii) if that property specifes a function, it is called with three
+arguments (not two), the third argument being the default (i.e., current)
+indentation."
   (let ((normal-indent (current-column)))
     (goto-char (1+ (elt state 1)))
     (parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)