diff --git a/runtime/doc/starting.txt b/runtime/doc/starting.txt index e96a014041..dfb80b7f98 100644 --- a/runtime/doc/starting.txt +++ b/runtime/doc/starting.txt @@ -1122,11 +1122,12 @@ Note: when NeoVim finds out that it failed to write part of the ShaDa file (e.g. because there is no space left to write the file) or when it appears that already present ShaDa file contains errors that indicate that this file is likely not a ShaDa file then ShaDa file with `.tmp.X` suffix is left on the -file system (where X is any latin small letter: from U+0061 to U+007A). You +file system (where X is any latin small letter: from U+0061 to U+007A). You may use such file to recover the data if you want, but in any case it needs to be cleaned up after you resolve the issue that prevented old ShaDa file from -being overwritten. If NeoVim fails to find unexisting `.tmp.X` file it will -not write ShaDa file at all. +being overwritten. If NeoVim fails to find unexisting `.tmp.X` file it will +not write ShaDa file at all. Errors which trigger this behaviour are listed +at |shada-keeping-tmpfile|. *:rsh* *:rshada* *E886* :rsh[ada][!] [file] Read from ShaDa file [file] (default: see above). @@ -1305,7 +1306,7 @@ Errors in ShaDa file may have two types: E575 used for all “logical” errors and E576 used for all “critical” errors. Critical errors trigger behaviour described in |shada-error-handling| when writing and skipping the rest of the file when reading and include: - + *shada-keeping-tmpfile* - Any of first three MessagePack objects being not an unsigned integer. - Third object requesting amount of bytes greater then bytes left in the ShaDa file. diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt index d5ff27d8c5..3b3f257351 100644 --- a/runtime/doc/vim_diff.txt +++ b/runtime/doc/vim_diff.txt @@ -99,16 +99,22 @@ Additional differences: - |shada-c| has no effect. - |shada-s| now limits size of every item and not just registers. -- When reading ShaDa files history, jump list and change list items are merged - with those in currently running NeoVim instance according to the timestamp. +- When reading ShaDa files items are merged according to the timestamp. + |shada-merging| - 'viminfo' option got renamed to 'shada'. Old option is kept as an alias for compatibility reasons. -- |:wviminfo| was renamed to |:wshada|, |:rviminfo| to |:rshada|. Old commands - are still kept. -- When writing (|:wshada| without bang or at exit) it merges much more data. - Vim merges only marks. +- |:wviminfo| was renamed to |:wshada|, |:rviminfo| to |:rshada|. Old + commands are still kept. +- When writing (|:wshada| without bang or at exit) it merges much more data, + and does this according to the timestamp. Vim merges only marks. + |shada-merging| - ShaDa file format was designed with forward and backward compatibility in mind. |shada-compatibility| +- Some errors make ShaDa code keep temporary file in-place for user to decide + what to do with it. Vim deletes temporary file in these cases. + |shada-error-handling| +- Vim keeps no timestamps at all, neither in viminfo file nor in the instance + itself. ============================================================================== 4. New Features *nvim-features-new*