docs: spelling and grammar fixes

This commit is contained in:
Ville Skyttä 2025-03-09 10:29:48 +02:00
parent 0fe0d8938c
commit 3af2f12702
5 changed files with 9 additions and 9 deletions

View File

@ -15,7 +15,7 @@ Generally,
- Fields should only be present when needed, saving space and parse time
- Also, we can always switch to always outputting the fields but its harder to stop outputting them
- `#[serde(skip_serializing_if = "Default::default")]` should be applied liberally
- For output, prefer [jsonlines](https://jsonlines.org/) as it allows streaming output and flexibility to mix content (e.g. adding diagnostics to output that didn't prevously have it
- For output, prefer [jsonlines](https://jsonlines.org/) as it allows streaming output and flexibility to mix content (e.g. adding diagnostics to output that didn't previously have it
- `#[serde(deny_unknown_fields)]` should not be used to allow evolution of formats, including feature gating
## Schema Evolution Strategies

View File

@ -42,18 +42,18 @@ When adding a table to a manifest,
- Should it be inheritable?
- Ensure the package table and the inheritable table under `workspace` align
- Care is needed to ensure a `workspace = true` field doesn't conflict with other entries
- e.g. [RFC 3389] had to explicitly exclude ever supporing a `workspace` linter
- e.g. [RFC 3389] had to explicitly exclude ever supporting a `workspace` linter
When adding a field,
- Is it inheritable?
- Consider whether sharing of the field would be driven by requirements or is a manifestion of the current implementation.
- Consider whether sharing of the field would be driven by requirements or is a manifestation of the current implementation.
For example, in most cases, dependency sources (e.g. `version` field) should be aligned across a workspace
However, frequently dependency `features` will vary across a workspace.
- When inheriting, can specify it in your package?
- How does specifying a field in both `workspace` and a package interact?
- e.g. dependency sources cannot be overridden
- e.g. dependency `features` get merged
- e.g. depedency `default-features` has been hard to get right ([#12162][cargo#12162])
- e.g. dependency `default-features` has been hard to get right ([#12162][cargo#12162])
When working extending `dependencies` tables:
- How does this affect `cargo add` or `cargo remove`?

View File

@ -38,7 +38,7 @@ Roughly the steps are:
git commit
```
5. Create an PR on rust-lang/rust.
5. Create a PR on rust-lang/rust.
Push your submodule changes to GitHub and make a PR.
Start the PR title with `[EXPERIMENT]` to make it clear what the PR is for and assign yourself or @ghost.

View File

@ -950,7 +950,7 @@
[#14211](https://github.com/rust-lang/cargo/pull/14211)
- Use `std::fs::absolute` instead of reimplementing it
[#14075](https://github.com/rust-lang/cargo/pull/14075)
- Remove unecessary feature activations from cargo.
- Remove unnecessary feature activations from cargo.
[#14122](https://github.com/rust-lang/cargo/pull/14122)
[#14160](https://github.com/rust-lang/cargo/pull/14160)
- Revert #13630 as rustc ignores `-C strip` on MSVC.
@ -3172,7 +3172,7 @@
### Nightly only
- Implemented a initial support of asymmetric token authentication for registries.
- Implemented initial support of asymmetric token authentication for registries.
([RFC 3231](https://github.com/rust-lang/rfcs/blob/master/text/3231-cargo-asymmetric-tokens.md))
([docs](https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#registry-auth))
[#10771](https://github.com/rust-lang/cargo/pull/10771)
@ -3306,7 +3306,7 @@
[#11227](https://github.com/rust-lang/cargo/pull/11227)
- Added support for git dependencies having git submodules with relative paths.
[#11106](https://github.com/rust-lang/cargo/pull/11106)
- Cargo now sends requests with a `Accept-Encoding` header to registries.
- Cargo now sends requests with an `Accept-Encoding` header to registries.
[#11292](https://github.com/rust-lang/cargo/pull/11292)
- Cargo now forwards non-UTF8 arguments to external subcommands.
[#11118](https://github.com/rust-lang/cargo/pull/11118)

View File

@ -189,7 +189,7 @@ These incompatibilities usually manifest as a compile-time error, but
sometimes they will only appear as a runtime misbehavior. For example, let's
say there is a common library named `foo` that ends up appearing with both
version `1.0.0` and `2.0.0` in the resolve graph. If [`downcast_ref`] is used
on a object created by a library using version `1.0.0`, and the code calling
on an object created by a library using version `1.0.0`, and the code calling
`downcast_ref` is downcasting to a type from version `2.0.0`, the downcast
will fail at runtime.