From 559f64a0b6b6f915d26ada8283b74ab6bbfbf3b2 Mon Sep 17 00:00:00 2001 From: Alex Branham Date: Mon, 25 Mar 2019 20:49:01 -0500 Subject: [PATCH] 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 10cd65878c741d2a22a1f2c36c54fcad4e516f72) --- doc/lispref/text.texi | 4 ++-- lisp/indent.el | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index fb5f56e9ddd..73312bb0caa 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -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. diff --git a/lisp/indent.el b/lisp/indent.el index 7be5a5ab0f4..8a0f8378653 100644 --- a/lisp/indent.el +++ b/lisp/indent.el @@ -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")