Skip to content

docs: Use mdbook admonitions - #17384

Merged
weihanglo merged 3 commits into
rust-lang:masterfrom
epage:admonition
Aug 22, 2026
Merged

docs: Use mdbook admonitions#17384
weihanglo merged 3 commits into
rust-lang:masterfrom
epage:admonition

Conversation

@epage

@epage epage commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

What does this PR try to resolve?

Establishing a pattern of their use which should reduce needing review feedback like #17382 (comment)

See https://rust-lang.github.io/mdBook/format/markdown.html#admonitions

How to test and review this PR?

@rustbot rustbot added the A-documenting-cargo-itself Area: Cargo's documentation label Aug 22, 2026
@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 22, 2026
@rustbot

rustbot commented Aug 22, 2026

Copy link
Copy Markdown
Collaborator

r? @weihanglo

rustbot has assigned @weihanglo.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

  • Owners of files modified in this PR: @epage, @weihanglo
  • @epage, @weihanglo expanded to epage, weihanglo

@weihanglo

weihanglo commented Aug 22, 2026

Copy link
Copy Markdown
Member

I was planning to do it tonight as well. I am glad I haven't yet started

weihanglo
weihanglo reviewed Aug 22, 2026
View reviewed changes
Comment thread doc/book/src/reference/features.md Outdated
weihanglo
weihanglo approved these changes Aug 22, 2026
View reviewed changes

@weihanglo weihanglo left a comment •
edited by rustbot
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably don't want to spend too much time debating where to use which kind of admonitions.

Feel free to merge this when it is ready

View changes since this review

@epage

epage commented Aug 22, 2026

Copy link
Copy Markdown
Contributor Author

Been meaning to do this ever since it came up

@epage
epage enabled auto-merge August 22, 2026 01:21
@epage
epage added this pull request to the merge queue Aug 22, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 22, 2026
@weihanglo
weihanglo added this pull request to the merge queue Aug 22, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 22, 2026
weihanglo
weihanglo reviewed Aug 22, 2026
View reviewed changes

@weihanglo weihanglo left a comment •
edited by rustbot
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some other "tips" need to update:

  • cargo/doc/book/src/reference/environment-variables.md

    Lines 387 to 390 in 9243bb7

    > **Tip:** For a typed API to read these values, consider using the [`build-rs`]
    > crate instead of parsing environment variables manually. Also note that
    > `CARGO_CFG_*` variables should be used instead of the `cfg!` macro or `#[cfg]`
    > attribute in build scripts, those check the *host* platform, not the *target*.

  • cargo/doc/contrib/src/process/working-on-cargo.md

    Lines 133 to 135 in 9243bb7

    > **tip:** Prefer atomic commits where each commit is a single, complete, and coherent unit of work.
    > For example, if your feature work leads to renaming a module, make the rename its own commit.
    > However, adding an internal function that is unused is not complete or coherent.

View changes since this review

Comment thread doc/book/src/appendix/git-authentication.md Outdated
Comment thread doc/book/src/reference/manifest.md Outdated
Comment thread doc/book/src/reference/config.md Outdated
Comment thread doc/book/src/reference/config.md Outdated
@weihanglo
weihanglo enabled auto-merge August 22, 2026 13:11
@weihanglo

weihanglo commented Aug 22, 2026

Copy link
Copy Markdown
Member

So looks like https://github.com/rust-lang/cargo/actions/runs/32574966922/job/97041213022?pr=17384 continue failing because it runs on nightly.

# fine
cargo +stable doc --workspace --document-private-items --no-deps --keep-going
# stuck at `varisat`
cargo ++nightly-2026-08-22 doc --workspace --document-private-items --no-deps --keep-going

And the memory usage seems to go unbound.

@weihanglo

weihanglo commented Aug 22, 2026

Copy link
Copy Markdown
Member

So

# works
env RUSTFLAGS=-Znext-solver=coherence cargo +nightly-2026-08-22 check -p varisat

# stuck
env RUSTFLAGS=-Znext-solver=globally cargo +nightly-2026-08-22 check -p varisat

so something worth reporting to rust-lang/rust#160895.

@weihanglo weihanglo mentioned this pull request Aug 22, 2026
Merged
pull Bot pushed a commit to weiyilai/cargo that referenced this pull request Aug 22, 2026
@epage
chore(ci): exclude resolver-tests from intra doc link checks (rust-la…
af373f7 
…ng#17385)

### What does this PR try to resolve?

next trait resolver might have bugs dealing with it,
but anyway we care less about intra doclinks for resolver-tests,
and it anyway builds in clippy jobs.

### How to test and review this PR?

See
<rust-lang#17384 (comment)>:

```
# works
env RUSTFLAGS=-Znext-solver=coherence cargo +nightly-2026-08-22 check -p varisat

# stuck
env RUSTFLAGS=-Znext-solver=globally cargo +nightly-2026-08-22 check -p varisat
```
@weihanglo weihanglo mentioned this pull request Aug 22, 2026
Open
@rustbot

rustbot commented Aug 22, 2026

Copy link
Copy Markdown
Collaborator

This PR was rebased onto a different master commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

@weihanglo
weihanglo added this pull request to the merge queue Aug 22, 2026
Merged via the queue into rust-lang:master with commit ed4cb4f Aug 22, 2026
29 checks passed
@rustbot rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 22, 2026
@rustbot rustbot mentioned this pull request Aug 22, 2026
Draft
@lcnr lcnr mentioned this pull request Aug 23, 2026
Open
@weihanglo weihanglo mentioned this pull request Aug 25, 2026
Open
rust-bors Bot pushed a commit to rust-lang/rust that referenced this pull request Aug 26, 2026
@bors
Auto merge of #161789 - weihanglo:update-cargo, r=weihanglo
4b7a1b9 
Update cargo submodule

7 commits in e8cb624d5701824f46a2ec5873cfd59ee3d2f66c..94ba974179df2adb3c911fadf361f03b84aa8f14
2026-08-22 00:23:45 +0000 to 2026-08-25 18:16:11 +0000
- feat(diag): Stabilize cargo-lints  (rust-lang/cargo#17298)
- chore(deps): Update partial_ref to v0.3.4 (rust-lang/cargo#17392)
- refactor: remove ad-hoc `subslice_range` (rust-lang/cargo#17390)
- docs(changelog): move build-dir new layout to Changed (rust-lang/cargo#17387)
- chore(deps): update msrv (1 version) to v1.98 (rust-lang/cargo#17386)
- docs: Use mdbook admonitions (rust-lang/cargo#17384)
- chore(ci): exclude resolver-tests from intra doc link checks (rust-lang/cargo#17385)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@weihanglo weihanglo weihanglo approved these changes

Assignees

@weihanglo weihanglo

Labels

A-documenting-cargo-itself Area: Cargo's documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@epage @rustbot @weihanglo