Skip to content

Commit a568dcf

Browse files
polazarushg-anssi
authored andcommitted
more fix
1 parent e326185 commit a568dcf

File tree

7 files changed

+26
-27
lines changed

7 files changed

+26
-27
lines changed

src/en/devenv.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ references:
2323

2424
[Rustup] is the Rust toolchain installer. Among other things, it enables
2525
switching between different flavors of the toolchain (stable, beta, nightly),
26-
managing additional components installation and keeping them up to date.
26+
managing the installation of additional components and keeping them up to date.
2727

2828
<div class="warning">
2929

3030
From a security perspective, `rustup` does perform all downloads over HTTPS,
3131
but does not yet validate signatures of downloads. Protection against
32-
downgrade attacks, certificate pinning, validation of signatures are still
32+
downgrade attacks, certificate pinning, and validation of signatures are still
3333
works in progress.
3434
In some cases, it may be preferable to opt for an alternative installation
3535
method listed in the *Install* section of the official Rust website.
@@ -156,10 +156,10 @@ It has a fundamental role in most Rust developments:
156156
- It’s also a front-end to run complementary tools such as those that are
157157
described below, in the form of sub-commands.
158158

159-
Cargo enables automatic dependencies resolution before compilation
159+
Cargo enables automatic dependency resolution before compilation
160160
by checking their checksums.
161-
File `Cargo.lock` contains all dependencies checksums which are compared to
162-
the one downloaded.
161+
The `Cargo.lock` file contains the checksums of all dependencies, which are compared to
162+
the ones downloaded.
163163
If a difference is detected, compilation fails:
164164

165165
```
@@ -181,14 +181,14 @@ the file is overwritten with the latest available version of every crate.
181181

182182
<div class="reco" id="DENV-CARGO-LOCK" type="Rule" title="Track Cargo.lock in version control system">
183183

184-
`Cargo.lock` files MUST be tracked by version control system.
184+
`Cargo.lock` files MUST be tracked by a version control system.
185185

186186
</div>
187187

188188
<div class="warning">
189189

190190
Ongoing discussions occur on how to best protect
191-
and verify crates *on their first download* (according TOFU rule).
191+
and verify crates *on their first download* (according to the TOFU rule).
192192
For now, the security of the first download relies on the good security of the
193193
website [crates.io] and the GitHub hosted repository containing the
194194
registry index. In some cases, it may be preferable to opt for an alternative
@@ -219,7 +219,7 @@ in development profiles' sections (`[profile.dev]` and `[profile.test]`).
219219

220220
</div>
221221

222-
Cargo proposes other ways to setup its configuration and change its behavior on
222+
Cargo proposes other ways to set up its configuration and change its behavior on
223223
a given system. This can be very useful, but it may also be difficult to know
224224
and remember at a given time all the options that are effectively used, and
225225
in particular passed to the compiler. At the end, this can affect the confidence
@@ -232,7 +232,7 @@ to use the Cargo build scripts feature.
232232
<div class="reco" id="DENV-CARGO-ENVVARS" type="Rule" title="Keep default values for compiler environment variables when running cargo">
233233

234234
The environment variables `RUSTC`, `RUSTC_WRAPPER` and `RUSTFLAGS` MUST NOT
235-
be overriden when using Cargo to build the project.
235+
be overridden when using Cargo to build the project.
236236

237237
</div>
238238

@@ -268,7 +268,7 @@ guidelines.
268268

269269
### Cargo fix
270270

271-
The `cargo fix` command is a tool dedicated in
271+
The `cargo fix` command is a tool dedicated to
272272
fixing compiler warnings as well as easing transitions between editions.
273273

274274
```shell
@@ -313,7 +313,7 @@ detect. The warnings should be re-checked by the programmer before committing
313313
the fix that is suggested by `clippy`, especially in the case of lints of the
314314
category `clippy::nursery` since those hints are still under development.
315315

316-
`clippy` now has similar `fix` tool as `rustfix`
316+
`clippy` now has a `fix` tool similar to `cargo fix`.
317317

318318
[clippy]: https://github.com/rust-lang/rust-clippy
319319

src/en/errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Stack unwinding from Rust code into foreign code results in undefined behavior.
9292
Rust code called from FFI MUST either:
9393

9494
* ensure the function cannot panic,
95-
* use `catch_unwind` or the `std::panic` module to ensure the rust code will not
95+
* use `catch_unwind` or the `std::panic` module to ensure the Rust code will not
9696
abort or return in an unstable state.
9797

9898
</div>

src/en/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Besides, static typing discipline, type inference, and ad hoc polymorphism (in
4040
the form of traits) are other ways Rust provides to build libraries and programs
4141
in a safe manner.
4242

43-
Finally, the toolchain (rustup, cargo) greatly facilitate the use of Rust by simplifying
43+
Finally, the toolchain (rustup, cargo) greatly facilitates the use of Rust by simplifying
4444
the configuration of the software construction, while giving priority to good compilation
4545
safety practices.
4646

@@ -94,7 +94,7 @@ Then, recommendations about the Rust language constructs are presented.
9494
tests for a project in Rust, and for using Rust fuzzing tools.-->
9595
We finally introduce some recommendations for established Rust libraries.
9696

97-
Note that *async* Rust is currently eluded from recommendations list.
97+
Note that *async* Rust is currently not addressed in this document.
9898

9999
A summary of recommendations presented throughout the document is listed at the
100100
end of this guide.

src/en/libraries.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ It is important to note that accurately tracking the versions of these libraries
99
### Crates
1010

1111
In addition to the standard library, Rust provides an easy way to import other
12-
libraries in a project, thanks to `cargo`. The libraries, known as *crates* in
13-
the Rust ecosystem, are imported from an open-source components central
14-
repository.
12+
libraries in a project, thanks to `cargo`.
13+
The libraries, known as *crates* in the Rust ecosystem, are imported from a central repository of open-source
14+
components.
1515

16-
An example of dependency declaration in the `Cargo.toml` file:
16+
An example of a dependency declaration in the `Cargo.toml` file:
1717

1818
```toml
1919
[dependencies]
@@ -63,15 +63,15 @@ Each third-party dependency SHOULD be properly validated, and each validation SH
6363

6464
### Cargo-outdated
6565

66-
[Cargo-outdated] tool allows one to easily manage dependencies' versions.
66+
[cargo-outdated] tool allows one to easily manage dependency versions.
6767

68-
For a given crate, it lists current dependencies' versions (using its
68+
For a given crate, it lists the current versions of dependencies (using
6969
`Cargo.toml`), and checks the latest compatible version and also the latest general
7070
version.
7171

72-
<div class="reco" id="LIBS-OUTDATED" type="Rule" title="Check for outdated dependencies versions (cargo-outdated)">
72+
<div class="reco" id="LIBS-OUTDATED" type="Rule" title="Check for outdated dependencies (cargo-outdated)">
7373

74-
The `cargo-outdated` tool MUST be used to check dependencies' status. Then,
74+
The `cargo-outdated` tool MUST be used to check the status of dependencies. Then,
7575
each outdated dependency SHOULD be updated or the choice of the version MUST be
7676
justified.
7777

@@ -84,7 +84,7 @@ justified.
8484
[Cargo-audit] tool allows one to easily check for security vulnerabilities
8585
reported to the RustSec Advisory Database.
8686

87-
<div class="reco" id="LIBS-AUDIT" type="Rule" title="Check for security vulnerabilities report on dependencies (cargo-audit)">
87+
<div class="reco" id="LIBS-AUDIT" type="Rule" title="Check for security vulnerability reports on dependencies (cargo-audit)">
8888

8989
The `cargo-audit` tool MUST be used to check for known vulnerabilities in
9090
dependencies.

src/en/macros.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
<!-- ## Macros -->
44

55
<!--
6-
<mark>TODO</mark>: cyclomatic complexity of the macro expanded code, recursion
6+
<mark>TODO</mark>: cyclomatic complexity of the macro-expanded code, recursion
77
limits, ...
88
-->

src/en/testfuzz.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88

99
### cargo-fuzz
1010

11-
<mark>TODO</mark>: good practices in fuzzing programs or part of programs.
11+
<mark>TODO</mark>: good practices in fuzzing programs or parts of programs.

src/en/unsafe.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
# Rust unsafe
2-
1+
# Unsafe Rust

0 commit comments

Comments
 (0)