kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-20 11:15:14 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update 'backupdir' and 'undodir' descriptions

Browse Source
This commit is contained in:
Gregory Anders 2021-08-27 10:38:20 -06:00
parent 4e516e53bf
commit e5d464d8e0
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
runtime/doc/options.txt
View File

@ -828,8 +828,8 @@ A jump table for the options with a short description can be found at |Q_op|.
global global
List of directories for the backup file, separated with commas. List of directories for the backup file, separated with commas.
- The backup file will be created in the first directory in the list - The backup file will be created in the first directory in the list
where this is possible. The directory must exist, Vim will not where this is possible. If none of the directories exist Nvim will
create it for you. attempt to create the last directory in the list.
- Empty means that no backup file will be created ('patchmode' is - Empty means that no backup file will be created ('patchmode' is
impossible!). Writing may fail because of this. impossible!). Writing may fail because of this.
- A directory "." means to put the backup file in the same directory - A directory "." means to put the backup file in the same directory
@ -6536,14 +6536,14 @@ A jump table for the options with a short description can be found at |Q_op|.
'undodir' 'udir' string (default "$XDG_DATA_HOME/nvim/undo//") 'undodir' 'udir' string (default "$XDG_DATA_HOME/nvim/undo//")
global global
List of directory names for undo files, separated with commas. List of directory names for undo files, separated with commas.
See |'backupdir'| for details of the format. See 'backupdir' for details of the format.
"." means using the directory of the file. The undo file name for "." means using the directory of the file. The undo file name for
"file.txt" is ".file.txt.un~". "file.txt" is ".file.txt.un~".
For other directories the file name is the full path of the edited For other directories the file name is the full path of the edited
file, with path separators replaced with "%". file, with path separators replaced with "%".
When writing: The first directory that exists is used. "." always When writing: The first directory that exists is used. "." always
works, no directories after "." will be used for writing. If none of works, no directories after "." will be used for writing. If none of
the directories exist Neovim will attempt to create last directory in the directories exist Nvim will attempt to create the last directory in
the list. the list.
When reading all entries are tried to find an undo file. The first When reading all entries are tried to find an undo file. The first
undo file that exists is used. When it cannot be read an error is undo file that exists is used. When it cannot be read an error is
@ -6552,6 +6552,10 @@ A jump table for the options with a short description can be found at |Q_op|.
This option cannot be set from a |modeline| or in the |sandbox|, for This option cannot be set from a |modeline| or in the |sandbox|, for
security reasons. security reasons.
Note that unlike 'directory' and 'backupdir', 'undodir' always acts as
though the trailing slashes are present (see 'backupdir' for what this
means).
*'undofile'* *'noundofile'* *'udf'* *'noudf'* *'undofile'* *'noundofile'* *'udf'* *'noudf'*
'undofile' 'udf' boolean (default off) 'undofile' 'udf' boolean (default off)
local to buffer local to buffer