commit 37da0bc0c63083f79d2fbf4622a9b3fd47c415df
parent f79052faef874b19ebbed007c30eb3f2c994a8b2
Author: sisrfeng <53520949+sisrfeng@users.noreply.github.com>
Date: Wed, 11 Oct 2023 17:58:07 +0800
docs: clarify about error in shada (#25594)
Diffstat:
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/runtime/doc/starting.txt b/runtime/doc/starting.txt
@@ -1119,7 +1119,8 @@ any free letter from `a` to `z`) while normally it will create this file,
write to it and then rename `{basename}.tmp.X` to `{basename}`. Such errors
include:
-- Errors which make Nvim think that read file is not a ShaDa file at all:
+- Errors which make Nvim think that the file being read is not a ShaDa
+ file at all:
non-ShaDa files are not overwritten for safety reasons to avoid accidentally
destroying an unrelated file. This could happen e.g. when typing "nvim -i
file" in place of "nvim -R file" (yes, somebody did that at least with Vim).
@@ -1337,10 +1338,13 @@ exactly four MessagePack objects:
reasons, see |shada-compatibility|.
*E575* *E576*
-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:
+Errors in ShaDa file may have two types:
+1. E575 for “logical” errors.
+2. E576 for “critical” errors.
+When writing, critical errors trigger behaviour described in
+|shada-error-handling|.
+When reading, critical errors cause the rest of the file to be skipped.
+Critical errors include:
*shada-critical-contents-errors*
- Any of first three MessagePack objects being not an unsigned integer.
- Third object requesting amount of bytes greater then bytes left in the ShaDa
