Update README files with common style.

- external links use markdown's []() format,
- local files are formated with backquotes,
- duplicated new lines were removed,
- unnecesary single spaces were removed,
- broken links and local paths were updated.
This commit is contained in:
Bartosz Duszel
2020-03-22 13:50:58 +01:00
parent dccac40e69
commit fd6a35eb59
8 changed files with 71 additions and 94 deletions
+12 -13
View File
@@ -1,11 +1,10 @@
Rust Coding Standards
Rust Coding Standards
=======================
You MUST follow the standards laid out in `.../doc/HACKING/CodingStandards.md`,
where applicable.
Module/Crate Declarations
Module/Crate Declarations
---------------------------
Each Tor C module which is being rewritten MUST be in its own crate.
@@ -54,7 +53,7 @@ If you have any external modules as dependencies (e.g. `extern crate
libc;`), you MUST declare them in your crate's `lib.rs` and NOT in any
other module.
Dependencies and versions
Dependencies and versions
---------------------------
In general, we use modules from only the Rust standard library
@@ -81,7 +80,7 @@ Currently, Tor requires that you use the latest stable Rust version. At
some point in the future, we will freeze on a given stable Rust version,
to ensure backward compatibility with stable distributions that ship it.
Updating/Adding Dependencies
Updating/Adding Dependencies
------------------------------
To add/remove/update dependencies, first add your dependencies,
@@ -101,7 +100,7 @@ Next, run `/scripts/maint/updateRustDependencies.sh`. Then, go into
`src/ext/rust` and commit the changes to the `tor-rust-dependencies`
repo.
Documentation
Documentation
---------------
You MUST include `#![deny(missing_docs)]` in your crate.
@@ -118,13 +117,13 @@ types/constants/objects/functions/methods, you SHOULD also include an
You MUST document your module with _module docstring_ comments,
i.e. `//!` at the beginning of each line.
Style
Style
-------
You SHOULD consider breaking up large literal numbers with `_` when it makes it
more human readable to do so, e.g. `let x: u64 = 100_000_000_000`.
Testing
Testing
---------
All code MUST be unittested and integration tested.
@@ -148,7 +147,7 @@ should put:
}
}
Benchmarking
Benchmarking
--------------
The external `test` crate can be used for most benchmarking. However, using
@@ -186,14 +185,14 @@ Finally, to write your benchmark code, in
}
}
Fuzzing
Fuzzing
---------
If you wish to fuzz parts of your code, please see the
[`cargo fuzz`](https://github.com/rust-fuzz/cargo-fuzz) crate, which uses
[cargo fuzz](https://github.com/rust-fuzz/cargo-fuzz) crate, which uses
[libfuzzer-sys](https://github.com/rust-fuzz/libfuzzer-sys).
Whitespace & Formatting
Whitespace & Formatting
-------------------------
You MUST run `rustfmt` (https://github.com/rust-lang-nursery/rustfmt)
@@ -201,7 +200,7 @@ on your code before your code will be merged. You can install rustfmt
by doing `cargo install rustfmt-nightly` and then run it with `cargo
fmt`.
Safety
Safety
--------
You SHOULD read [the nomicon](https://doc.rust-lang.org/nomicon/) before writing