various doc improvements

I bumped the minimum Rust version because I'm taking advantage of
the rustdoc linking added in Rust 1.48:
https://blog.rust-lang.org/2020/11/19/Rust-1.48.html#easier-linking-in-rustdoc
This commit is contained in:
Scott Lamb
2021-04-10 17:34:52 -07:00
parent 98d106553a
commit 2936c138c5
17 changed files with 119 additions and 54 deletions

View File

@@ -4,13 +4,13 @@
syntax = "proto3";
// Metadata stored in sample file dirs as "<dir>/meta". This is checked
// Metadata stored in sample file dirs as `<dir>/meta`. This is checked
// against the metadata stored within the database to detect inconsistencies
// between the directory and database, such as those described in
// design/schema.md.
// `design/schema.md`.
//
// As of schema version 4, the overall file format is as follows: a
// varint-encoded length, followed by a serialized DirMeta message, followed
// varint-encoded length, followed by a serialized `DirMeta` message, followed
// by NUL bytes padding to a total length of 512 bytes. This message never
// exceeds that length.
//