From a67d3781a3d73cc2e5e96975587f2018218b8f47 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Sun, 12 Mar 2023 11:37:37 +0100 Subject: [PATCH] doc: apply review comments and improve link formatting --- doc/design.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/design.rst b/doc/design.rst index 06f0cbf3c..e3972aeac 100644 --- a/doc/design.rst +++ b/doc/design.rst @@ -300,8 +300,8 @@ example, the Pack ``73d04e61`` contains two data Blobs and one Tree blob, the plaintext hashes are listed afterwards. The ``length`` field corresponds to ``Length(encrypted_blob)`` in the pack file header. Field ``uncompressed_length`` is only present for compressed blobs and -therefore is never present in the Repository format version 1. It is set -to the value of ``Length(blob)``. +therefore is never present in version 1 of the repository format. It is +set to the value of ``Length(blob)``. The field ``supersedes`` lists the storage IDs of index files that have been replaced with the current index file. This happens when index files @@ -504,12 +504,12 @@ A tree contains a list of entries (in the field ``nodes``) which contain meta data like a name and timestamps. Note that there are some specialities of how this metadata is generated: -- The name is quoted using before being saved. - This handles non-unicode names, but also changes the representation of names - containing `"` or `\\`. +- The name is quoted using `strconv.Quote `__ + before being saved. This handles non-unicode names, but also changes the + representation of names containing ``"`` or ``\``. -- The filemode saved is the mode defined by masked - by ``os.ModePerm | os.ModeType | os.ModeSetuid | os.ModeSetgid | os.ModeSticky`` +- The filemode saved is the mode defined by `fs.FileMode `__ + masked by ``os.ModePerm | os.ModeType | os.ModeSetuid | os.ModeSetgid | os.ModeSticky`` When the entry references a directory, the field ``subtree`` contains the plain text ID of another tree object.