diff options
Diffstat (limited to 'doc/lispref')
-rw-r--r-- | doc/lispref/buffers.texi | 10 | ||||
-rw-r--r-- | doc/lispref/compile.texi | 2 | ||||
-rw-r--r-- | doc/lispref/customize.texi | 24 | ||||
-rw-r--r-- | doc/lispref/files.texi | 34 | ||||
-rw-r--r-- | doc/lispref/loading.texi | 2 | ||||
-rw-r--r-- | doc/lispref/text.texi | 9 | ||||
-rw-r--r-- | doc/lispref/windows.texi | 18 |
7 files changed, 64 insertions, 35 deletions
diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi index 6a1d125701c..c40e088293e 100644 --- a/doc/lispref/buffers.texi +++ b/doc/lispref/buffers.texi @@ -427,19 +427,19 @@ It is a permanent local, unaffected by @end defvar @defvar buffer-file-number -This buffer-local variable holds the file number and directory device -number of the file visited in the current buffer, or @code{nil} if no +This buffer-local variable holds the inode number and device +identifier of the file visited in the current buffer, or @code{nil} if no file or a nonexistent file is visited. It is a permanent local, unaffected by @code{kill-all-local-variables}. -The value is normally a list of the form @code{(@var{filenum} -@var{devnum})}. This pair of numbers uniquely identifies the file among +The value is normally a list of the form @code{(@var{inodenum} +@var{device})}. This tuple uniquely identifies the file among all files accessible on the system. See the function @code{file-attributes}, in @ref{File Attributes}, for more information about them. If @code{buffer-file-name} is the name of a symbolic link, then both -numbers refer to the recursive target. +@var{inodenum} and @var{device} refer to the recursive target of the link. @end defvar @defun get-file-buffer filename diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index 7ccee08e53a..70e0f98f443 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi @@ -985,7 +985,7 @@ too late. While setting this variable disables automatic compilation of Lisp files, the compiler may still be invoked to install @dfn{trampolines} if any built-in functions are redefined. However, these trampolines -will not get written to disk. +will not get written to your cache directory. You can also use the @samp{EMACS_INHIBIT_AUTOMATIC_NATIVE_COMPILATION} environment variable to disable native compilation. diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi index 6ba35cffffe..204719e942b 100644 --- a/doc/lispref/customize.texi +++ b/doc/lispref/customize.texi @@ -1428,12 +1428,32 @@ emacs, The GNU Emacs Manual}.) be a call to @code{deftheme}, and the last form should be a call to @code{provide-theme}. -@defmac deftheme theme &optional doc +@defmac deftheme theme &optional doc &rest properties This macro declares @var{theme} (a symbol) as the name of a Custom theme. The optional argument @var{doc} should be a string describing the theme; this is the description shown when the user invokes the @code{describe-theme} command or types @kbd{?} in the @samp{*Custom -Themes*} buffer. +Themes*} buffer. The remaining arguments @var{properties} are used +pass a property list with theme attributes. + +The following attributes are supported: + +@table @code +@item :family +A symbol designating what ``family'' a theme belongs to. A +@dfn{family} of themes is a set of similar themes that differ by minor +aspects, such as face colors that are meant for the light vs dark +background of the frame. +@item :kind +A symbol. If a theme is enabled and this property has the value +@code{color-scheme}, then the @code{theme-choose-variant} command will +look for other available themes that belong to the same family in +order to switch the themes. Other values are currently unspecified +and should not be used. +@item :background-mode +A symbol, either @code{light} or @code{dark}. This attribute is +currently unused, but should still be specified. +@end table Two special theme names are disallowed (using them causes an error): @code{user} is a dummy theme that stores the user's direct diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index e1aa2de523c..b26d4f10585 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi @@ -1253,14 +1253,6 @@ the @samp{smb} method. For all other connection methods, runtime tests are performed. @end defun -@defun file-in-directory-p file dir -This function returns @code{t} if @var{file} is a file in directory -@var{dir}, or in a subdirectory of @var{dir}. It also returns -@code{t} if @var{file} and @var{dir} are the same directory. It -compares the truenames of the two directories. If @var{dir} does not -name an existing directory, the return value is @code{nil}. -@end defun - @defun vc-responsible-backend file This function determines the responsible VC backend of the given @var{file}. For example, if @file{emacs.c} is a file tracked by Git, @@ -1412,14 +1404,17 @@ The file's inode number (@code{file-attribute-inode-number}), a nonnegative integer. @item -The filesystem number of the device that the file is on -@code{file-attribute-device-number}), an integer. -This element and the file's inode number -together give enough information to distinguish any two files on the -system---no two files can have the same values for both of these -numbers. +The filesystem's identifier of the device that the file is on +(@code{file-attribute-device-number}), an integer or a cons cell of +two integers. The latter is sometimes used by remote files, in order +to distinguish remote filesystems from local ones. @end enumerate +The file's inode and device together give enough information +to distinguish any two files on the system---no two files can have the +same values for both of these attributes. This tuple that uniquely +identifies the file is returned by @code{file-attribute-file-identifier}. + For example, here are the file attributes for @file{files.texi}: @example @@ -3100,6 +3095,17 @@ is called with one argument (the file or directory) and should return non-@code{nil} if that directory is the one it is looking for. @end defun +@cindex parent directory of file +@cindex ancestor directory of file +@cindex file, ancestor directory of +@defun file-in-directory-p file dir +This function returns @code{t} if @var{file} is a file in directory +@var{dir}, or in a subdirectory of @var{dir}. It also returns +@code{t} if @var{file} and @var{dir} are the same directory. It +compares the truenames of the two directories. If @var{dir} does not +name an existing directory, the return value is @code{nil}. +@end defun + @defun directory-files-and-attributes directory &optional full-name match-regexp nosort id-format count This is similar to @code{directory-files} in deciding which files to report on and how to report their names. However, instead diff --git a/doc/lispref/loading.texi b/doc/lispref/loading.texi index 4e4f12dc324..c7fbdac1d76 100644 --- a/doc/lispref/loading.texi +++ b/doc/lispref/loading.texi @@ -662,7 +662,7 @@ and @code{define-overloadable-function} (see the commentary in and @code{define-global-minor-mode}. @item Other definition types: -@code{defcustom}, @code{defgroup}, @code{defclass} +@code{defcustom}, @code{defgroup}, @code{deftheme}, @code{defclass} (@pxref{Top,EIEIO,,eieio,EIEIO}), and @code{define-skeleton} (@pxref{Top,Autotyping,,autotype,Autotyping}). @end table diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 8b859042ad0..509ce56725d 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -5321,9 +5321,12 @@ This has exactly the same effect as the previous example, but is more efficient and safer (because it doesn't involve any string parsing or interpolation). -@code{sqlite-execute} returns the number of affected rows. For -instance, an @samp{insert} statement will return @samp{1}, whereas an -@samp{update} statement may return zero or a higher number. +@code{sqlite-execute} usually returns the number of affected rows. +For instance, an @samp{insert} statement will typically return +@samp{1}, whereas an @samp{update} statement may return zero or a +higher number. However, when using @acronym{SQL} statements like +@w{@samp{insert into @dots{} returning @dots{}}} and the like, the values +specified by @w{@samp{returning @dots{}}} will be returned instead. Strings in SQLite are, by default, stored as @code{utf-8}, and selecting a text column will decode the string using that charset. diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index ee3b15992b7..e946a408fd6 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi @@ -6684,32 +6684,32 @@ time window change functions were run for @var{window}'s frame. If it returns @code{nil}, @var{window} has been created after that. If it returns @code{t}, @var{window} was not shown at that time but has been restored from a previously saved window configuration afterwards. -Otherwise, the return value is the buffer shown by @code{window} at +Otherwise, the return value is the buffer shown by @var{window} at that time. @end defun @defun window-old-pixel-width &optional window This function returns the total pixel width of @var{window} the -last time window change functions found @code{window} live on its -frame. It is zero if @code{window} was created after that. +last time window change functions found @var{window} live on its +frame. It is zero if @var{window} was created after that. @end defun @defun window-old-pixel-height &optional window This function returns the total pixel height of @var{window} the last -time window change functions found @code{window} live on its frame. -It is zero if @code{window} was created after that. +time window change functions found @var{window} live on its frame. +It is zero if @var{window} was created after that. @end defun @defun window-old-body-pixel-width &optional window This function returns the pixel width of @var{window}'s text area the -last time window change functions found @code{window} live on its -frame. It is zero if @code{window} was created after that. +last time window change functions found @var{window} live on its +frame. It is zero if @var{window} was created after that. @end defun @defun window-old-body-pixel-height &optional window This function returns the pixel height of @var{window}'s text area the -last time window change functions found @code{window} live on its -frame. It is zero if @code{window} was created after that. +last time window change functions found @var{window} live on its +frame. It is zero if @var{window} was created after that. @end defun In order to find out which window or frame was selected the last time |