Backport: Update documentation for indent-relative functions

* 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 10cd65878c)
This commit is contained in:
Alex Branham 2019-03-25 20:49:01 -05:00 committed by Basil L. Contovounesios
parent cb5a340823
commit 559f64a0b6
2 changed files with 5 additions and 4 deletions

View file

@ -2570,11 +2570,11 @@ The quick brown fox jum @point{}ped.
@end example @end example
@end deffn @end deffn
@deffn Command indent-relative-maybe @deffn Command indent-relative-first-indent-point
@comment !!SourceFile indent.el @comment !!SourceFile indent.el
This command indents the current line like the previous nonblank line, This command indents the current line like the previous nonblank line,
by calling @code{indent-relative} with @code{t} as the 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 If the previous nonblank line has no indent points beyond the current
column, this command does nothing. column, this command does nothing.

View file

@ -592,8 +592,9 @@ considered.
If the previous nonblank line has no indent points beyond the If the previous nonblank line has no indent points beyond the
column point starts at, then `tab-to-tab-stop' is done, if both column point starts at, then `tab-to-tab-stop' is done, if both
FIRST-ONLY and UNINDENTED-OK are nil, otherwise nothing is done FIRST-ONLY and UNINDENTED-OK are nil, otherwise nothing is done.
in this case. 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'." See also `indent-relative-first-indent-point'."
(interactive "P") (interactive "P")