Skip to content

Commit da80677

Browse files
committed
Fix typos and grammar in top-level and src/doc documentation
- CONTRIBUTING.md: add missing verb "is" - INSTALL.md: fix subject-verb agreement ("requires" → "require") - RELEASES.md: fix 4 issues (previous → previously, remove extra "is", add hyphen in Rust-for-Linux, results → result) - src/doc/not_found.md: fix misspelling ("Standary" → "Standard") - src/doc/index.md: fix awkward grammar in Embedded Rust Book description
1 parent f21b4c0 commit da80677

File tree

5 files changed

+9
-10
lines changed

5 files changed

+9
-10
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ the Zulip stream is the best place to *ask* for help.
1010

1111
Documentation for contributing to the compiler or tooling is located in the [Guide to Rustc
1212
Development][rustc-dev-guide], commonly known as the [rustc-dev-guide]. Documentation for the
13-
standard library in the [Standard library developers Guide][std-dev-guide], commonly known as the [std-dev-guide].
13+
standard library is in the [Standard library developers Guide][std-dev-guide], commonly known as the [std-dev-guide].
1414

1515
## Making changes to subtrees and submodules
1616

INSTALL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ itself back on after some time).
233233

234234
### MSVC
235235

236-
MSVC builds of Rust additionally requires an installation of:
236+
MSVC builds of Rust additionally require an installation of:
237237

238238
- Visual Studio 2022 (or later) build tools so `rustc` can use its linker. Older
239239
Visual Studio versions such as 2019 *may* work but aren't actively tested.

RELEASES.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1546,7 +1546,7 @@ Compatibility Notes
15461546
- [Check well-formedness of the source type's signature in fn pointer casts.](https://github.com/rust-lang/rust/pull/129021) This partly closes a soundness hole that comes when casting a function item to function pointer
15471547
- [Use equality instead of subtyping when resolving type dependent paths.](https://github.com/rust-lang/rust/pull/129073)
15481548
- Linking on macOS now correctly includes Rust's default deployment target. Due to a linker bug, you might have to pass `MACOSX_DEPLOYMENT_TARGET` or fix your `#[link]` attributes to point to the correct frameworks. See <https://github.com/rust-lang/rust/pull/129369>.
1549-
- [Rust will now correctly raise an error for `repr(Rust)` written on non-`struct`/`enum`/`union` items, since it previous did not have any effect.](https://github.com/rust-lang/rust/pull/129422)
1549+
- [Rust will now correctly raise an error for `repr(Rust)` written on non-`struct`/`enum`/`union` items, since it previously did not have any effect.](https://github.com/rust-lang/rust/pull/129422)
15501550
- The future incompatibility lint `deprecated_cfg_attr_crate_type_name` [has been made into a hard error](https://github.com/rust-lang/rust/pull/129670). It was used to deny usage of `#![crate_type]` and `#![crate_name]` attributes in `#![cfg_attr]`, which required a hack in the compiler to be able to change the used crate type and crate name after cfg expansion.
15511551
Users can use `--crate-type` instead of `#![cfg_attr(..., crate_type = "...")]` and `--crate-name` instead of `#![cfg_attr(..., crate_name = "...")]` when running `rustc`/`cargo rustc` on the command line.
15521552
Use of those two attributes outside of `#![cfg_attr]` continue to be fully supported.
@@ -1722,7 +1722,7 @@ Cargo
17221722
Compatibility Notes
17231723
-------------------
17241724
- We now [disallow setting some built-in cfgs via the command-line](https://github.com/rust-lang/rust/pull/126158) with the newly added [`explicit_builtin_cfgs_in_flags`](https://doc.rust-lang.org/rustc/lints/listing/deny-by-default.html#explicit-builtin-cfgs-in-flags) lint in order to prevent incoherent state, eg. `windows` cfg active but target is Linux based. The appropriate [`rustc` flag](https://doc.rust-lang.org/rustc/command-line-arguments.html) should be used instead.
1725-
- The standard library has a new implementation of `binary_search` which is significantly improves performance ([#128254](https://github.com/rust-lang/rust/pull/128254)). However when a sorted slice has multiple values which compare equal, the new implementation may select a different value among the equal ones than the old implementation.
1725+
- The standard library has a new implementation of `binary_search` which significantly improves performance ([#128254](https://github.com/rust-lang/rust/pull/128254)). However when a sorted slice has multiple values which compare equal, the new implementation may select a different value among the equal ones than the old implementation.
17261726
- [illumos/Solaris now sets `MSG_NOSIGNAL` when writing to sockets](https://github.com/rust-lang/rust/pull/128259). This avoids killing the process with SIGPIPE when writing to a closed socket, which matches the existing behavior on other UNIX targets.
17271727
- [Removes a problematic hack that always passed the --whole-archive linker flag for tests, which may cause linker errors for code accidentally relying on it.](https://github.com/rust-lang/rust/pull/128400)
17281728
- The WebAssembly target features `multivalue` and `reference-types` are now
@@ -1872,7 +1872,7 @@ These changes do not affect any public interfaces of Rust, but they represent
18721872
significant improvements to the performance or internals of rustc and related
18731873
tools.
18741874

1875-
- [Add a Rust-for Linux `auto` CI job to check kernel builds.](https://github.com/rust-lang/rust/pull/125209/)
1875+
- [Add a Rust-for-Linux `auto` CI job to check kernel builds.](https://github.com/rust-lang/rust/pull/125209/)
18761876

18771877
Version 1.80.1 (2024-08-08)
18781878
===========================
@@ -4510,7 +4510,7 @@ Compatibility Notes
45104510
saturating to `0` instead][89926]. In the real world the panic happened mostly
45114511
on platforms with buggy monotonic clock implementations rather than catching
45124512
programming errors like reversing the start and end times. Such programming
4513-
errors will now results in `0` rather than a panic.
4513+
errors will now result in `0` rather than a panic.
45144514
- In a future release we're planning to increase the baseline requirements for
45154515
the Linux kernel to version 3.2, and for glibc to version 2.17. We'd love
45164516
your feedback in [PR #95026][95026].

src/doc/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,9 +194,8 @@ resources maintained by the [Embedded Working Group] useful.
194194

195195
#### The Embedded Rust Book
196196

197-
[The Embedded Rust Book] is targeted at developers familiar with embedded
198-
development and familiar with Rust, but have not used Rust for embedded
199-
development.
197+
[The Embedded Rust Book] is targeted at developers who are familiar with embedded
198+
development and Rust, but who have not used Rust for embedded development.
200199

201200
[The Embedded Rust Book]: embedded-book/index.html
202201
[Rust project]: https://www.rust-lang.org

src/doc/not_found.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Some things that might be helpful to you though:
4141
<input type="submit" value="Search" id="search-but">
4242
<!--
4343
Don't show the options by default,
44-
since "From the Standary Library" doesn't work without JavaScript
44+
since "From the Standard Library" doesn't work without JavaScript
4545
-->
4646
<fieldset id="search-from" style="display:none">
4747
<label><input name="from" value="library" type="radio"> From the Standard Library</label>

0 commit comments

Comments
 (0)