]> git.eshelyaron.com Git - emacs.git/commitdiff
Backport: Update documentation for indent-relative functions
authorAlex Branham <alex.branham@gmail.com>
Tue, 26 Mar 2019 01:49:01 +0000 (20:49 -0500)
committerBasil L. Contovounesios <contovob@tcd.ie>
Thu, 11 Apr 2019 10:41:06 +0000 (11:41 +0100)
* lisp/indent.el (indent-relative): Document what happens when there
  is no previous nonblank line.
* doc/lispref/text.texi (Relative Indent): Document
  indent-relative-first-indent-point instead of obsolete
  indent-relative-maybe. Fix documentation of which argument from
  'indent-relative' is used.

Bug#34858

(cherry picked from commit 10cd65878c741d2a22a1f2c36c54fcad4e516f72)

doc/lispref/text.texi
lisp/indent.el

index fb5f56e9dddc4b50728295165498497535fe5c9e..73312bb0caa12f8fcd1a6acbf0ce84f57d8f0c82 100644 (file)
@@ -2570,11 +2570,11 @@ The quick brown fox jum  @point{}ped.
 @end example
 @end deffn
 
-@deffn Command indent-relative-maybe
+@deffn Command indent-relative-first-indent-point
 @comment !!SourceFile indent.el
 This command indents the current line like the previous nonblank line,
 by calling @code{indent-relative} with @code{t} as the
-@var{unindented-ok} argument.  The return value is unpredictable.
+@var{first-only} argument.  The return value is unpredictable.
 
 If the previous nonblank line has no indent points beyond the current
 column, this command does nothing.
index 7be5a5ab0f45966efb8075bdf8afb308cf5bb9b8..8a0f8378653b13ba4066d87e7f4deb926897a5a2 100644 (file)
@@ -592,8 +592,9 @@ considered.
 
 If the previous nonblank line has no indent points beyond the
 column point starts at, then `tab-to-tab-stop' is done, if both
-FIRST-ONLY and UNINDENTED-OK are nil, otherwise nothing is done
-in this case.
+FIRST-ONLY and UNINDENTED-OK are nil, otherwise nothing is done.
+If there isn't a previous nonblank line and UNINDENTED-OK is nil,
+call `tab-to-tab-stop'.
 
 See also `indent-relative-first-indent-point'."
   (interactive "P")