Skip to content

Commit 6c4d935

Browse files
committed
Add stable documentation for the [hints] table
1 parent 16d1fe6 commit 6c4d935

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

src/doc/src/reference/manifest.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ Every manifest file consists of the following sections:
5050
* [`[badges]`](#the-badges-section) --- Badges to display on a registry.
5151
* [`[features]`](features.md) --- Conditional compilation features.
5252
* [`[lints]`](#the-lints-section) --- Configure linters for this package.
53+
* [`[hints]`](#the-hints-section) --- Provide hints for compiling this package.
5354
* [`[patch]`](overriding-dependencies.md#the-patch-section) --- Override dependencies.
5455
* [`[replace]`](overriding-dependencies.md#the-replace-section) --- Override dependencies (deprecated).
5556
* [`[profile]`](profiles.md) --- Compiler settings and optimizations.
@@ -565,6 +566,25 @@ As for dependents, Cargo suppresses lints from non-path dependencies with featur
565566

566567
> **MSRV:** Respected as of 1.74
567568
569+
## The `[hints]` section
570+
571+
The `[hints]` section allows specifying hints for compiling this crate, which
572+
crates depending on this one will use by default but may override. Hints are,
573+
by design, always safe for Cargo to ignore; if Cargo encounters a hint it
574+
doesn't understand, or a hint it understands but with a value it doesn't
575+
understand, it will warn, but not error.
576+
577+
Individual hints may have an associated unstable feature gate that you need to
578+
pass in order to apply the configuration they specify, but if you don't specify
579+
that unstable feature gate, you will again get only a warning, not an error.
580+
581+
There are no stable hints at this time. See the [hint-mostly-unused
582+
documentation](unstable.md#profile-hint-mostly-unused-option) for information
583+
on an unstable hint.
584+
585+
> **MSRV:** Specifying hints does not impact MSRV. Older versions of Cargo will
586+
> ignore hints with a warning, but will not error.
587+
568588
## The `[badges]` section
569589

570590
The `[badges]` section is for specifying status badges that can be displayed

0 commit comments

Comments
 (0)