crosvm/common/p9/README.md
Dennis Kempin 6b06f405ff docs: Use mdformat to format markdown files
The tool is added to ./tools/fmt which will be called during
./tools/presubmit as well as by Kokoro during testing.

This requires a new dev container version to bundle the mdformat
tool in the container.

Note: mdformat does not have any IDE integrations, but the prettier
plugin with prose-wrap enabled and a line length of 100 provides
almost identical results.

BUG=None
TEST=./tools/fmt --check

Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098
Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org>
Reviewed-by: Alexandre Courbot <acourbot@chromium.org>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-27 21:29:11 +00:00

19 lines
977 B
Markdown

# p9 - Server implementation of the [9p] file system protocol
This directory contains the protocol definition and a server implementation of the [9p] file system
protocol.
- [wire_format_derive] - A [procedural macro] that derives the serialization and de-serialization
implementation for a struct into the [9p] wire format.
- [src/protocol] - Defines all the messages used in the [9p] protocol. Also implements serialization
and de-serialization for some base types (integers, strings, vectors) that form the foundation of
all [9p] messages. Wire format implementations for all other messages are derived using the
`wire_format_derive` macro.
- [src/server.rs] - Implements a full [9p] server, carrying out file system requests on behalf of
clients.
[9p]: http://man.cat-v.org/plan_9/5/intro
[procedural macro]: https://doc.rust-lang.org/proc_macro/index.html
[src/protocol]: src/protocol/
[src/server.rs]: src/server.rs
[wire_format_derive]: wire_format_derive/