From: Paul Eggert Date: Fri, 23 Feb 2018 19:51:31 +0000 (-0800) Subject: Minor doc fixes, mostly for timestamp issues X-Git-Tag: emacs-26.1-rc1~166 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=8a73b80aa43862f6aadda54c3c1f2105c2cfd7f5;p=emacs.git Minor doc fixes, mostly for timestamp issues --- diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi index a572fc702bd..f64d6f1600e 100644 --- a/doc/lispref/buffers.texi +++ b/doc/lispref/buffers.texi @@ -647,7 +647,7 @@ visiting a file or if the time has been explicitly cleared by too. For instance, in a Dired buffer listing a directory, it returns the last modification time of that directory, as recorded by Dired. -If the buffer is not visiting a file, this function returns -1. +If the buffer is not visiting a file, this function returns @minus{}1. @end defun @defun set-visited-file-modtime &optional time @@ -656,7 +656,8 @@ of the visited file, to the value specified by @var{time} if @var{time} is not @code{nil}, and otherwise to the last modification time of the visited file. -If @var{time} is neither @code{nil} nor zero, it should have the form +If @var{time} is neither @code{nil} nor an integer flag returned +by @code{visited-file-modtime}, it should have the form @code{(@var{high} @var{low} @var{microsec} @var{picosec})}, the format used by @code{current-time} (@pxref{Time of Day}). diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index 57428ab40f3..5a8eeddcf6b 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi @@ -1894,8 +1894,7 @@ all. This function sets the access and modification times of @var{filename} to @var{time}. The return value is @code{t} if the times are successfully set, otherwise it is @code{nil}. @var{time} defaults to the current -time and must be in the format returned by @code{current-time} -(@pxref{Time of Day}). +time and must be a time value (@pxref{Time of Day}). @end defun @defun set-file-extended-attributes filename attribute-alist diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index c2fa1094821..2f9bb398865 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi @@ -2277,7 +2277,7 @@ specifies the color mode to use on a text terminal. The value can be either a symbol or a number. A number specifies the number of colors to use (and, indirectly, what commands to issue to produce each color). For example, @code{(tty-color-mode . 8)} specifies use of the -ANSI escape sequences for 8 standard text colors. A value of -1 turns +ANSI escape sequences for 8 standard text colors. A value of @minus{}1 turns off color support. If the parameter's value is a symbol, it specifies a number through diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi index b53d1f0bb90..854dd33030c 100644 --- a/doc/lispref/functions.texi +++ b/doc/lispref/functions.texi @@ -1629,7 +1629,7 @@ anonymous function. This specifies how to order the advice, should several pieces of advice be present. By default, the depth is 0. A depth of 100 indicates that this piece of advice should be kept as deep as -possible, whereas a depth of -100 indicates that it should stay as the +possible, whereas a depth of @minus{}100 indicates that it should stay as the outermost piece. When two pieces of advice specify the same depth, the most recently added one will be outermost. diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 5dbdbdb9431..396d7dd045c 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi @@ -1457,7 +1457,8 @@ on others, years as early as 1901 do work. @cindex formatting time values These functions convert time values to text in a string, and vice versa. -Time values are lists of two to four integers (@pxref{Time of Day}). +Time values include @code{nil}, numbers, and lists of two to four +integers (@pxref{Time of Day}). @defun date-to-time string This function parses the time-string @var{string} and returns the diff --git a/doc/lispref/positions.texi b/doc/lispref/positions.texi index c89a87c2bb8..0a03e246c01 100644 --- a/doc/lispref/positions.texi +++ b/doc/lispref/positions.texi @@ -602,7 +602,7 @@ line @var{count} screen lines from the top of the window; zero means the topmost line. If @var{count} is negative, that specifies a position @w{@minus{}@var{count}} lines from the bottom (or the last line of the buffer, if the buffer ends above the specified screen -position); thus, @var{count} of -1 specifies the last fully visible +position); thus, @var{count} of @minus{}1 specifies the last fully visible screen line of the window. If @var{count} is @code{nil}, then point moves to the beginning of the diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi index 756e7efb957..9b222a04c9f 100644 --- a/doc/lispref/strings.texi +++ b/doc/lispref/strings.texi @@ -920,7 +920,7 @@ floating-point number. @item %g Replace the specification with notation for a floating-point number, using either exponential notation or decimal-point notation. The -exponential notation is used if the exponent would be less than -4 or +exponential notation is used if the exponent would be less than @minus{}4 or greater than or equal to the precision (default: 6). By default, trailing zeros are removed from the fractional portion of the result and a decimal-point character appears only if it is followed by a