octoleo
/
restic
mirror of https://github.com/octoleo/restic.git
2
2
Fork 0
Code Issues Releases Wiki Activity

doc: apply review comments and improve link formatting

This commit is contained in:
Michael Eischer 2023-03-12 11:37:37 +01:00
parent e2df73b0ac
commit a67d3781a3
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/design.rst
View File

@ -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 <https://pkg.go.dev/strconv#Quote> before being saved.
This handles non-unicode names, but also changes the representation of names
containing `"` or `\\`.
- The name is quoted using `strconv.Quote <https://pkg.go.dev/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 <https://pkg.go.dev/io/fs#FileMode> masked
by ``os.ModePerm | os.ModeType | os.ModeSetuid | os.ModeSetgid | os.ModeSticky``
- The filemode saved is the mode defined by `fs.FileMode <https://pkg.go.dev/io/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.