docs: swap doc_auto_cfg with doc_cfg
#1305
Merged
+101
−26
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In rust-lang/rust#138907, the `doc_auto_cfg` feature was subsumed by `doc_cfg`. This does overall look like we're on a path toward stabilization, which is great. One problem here though is that a bunch of crates use the `cfg` `docsrs` to enable `doc_auto_cfg`. So if we enable it, then it causes those crates to stop compiling. This is overall very annoying, and I don't know how to unfuck things. So I changed the `cfg` knob to `docsrs_regex` which, doesn't quite provide a guarantee, but gets us closer to being masters of our own destiny.
BurntSushi
force-pushed
the
ag/doc-cfg
branch
from
1cb9e5d to
2df724f
Compare
BurntSushi
added a commit
to BurntSushi/jiff
that referenced
this pull request
Oct 13, 2025
In rust-lang/rust#138907, the `doc_auto_cfg` feature was subsumed by `doc_cfg`. This does overall looks like we're on a path toward stabilization, which is great. One problem here though is that a bunch of crates use the `cfg` `docsrs` to enable `doc_auto_cfg`. So if we enable it, then it causes those crates to emit hard errors. This is overall very annoying, and I don't know how to unfuck things. So I changed the `cfg` knob to `docsrs_jiff` which, doesn't quite provide a guarantee, but gets us closer to being masters of our own destiny. See also a similar change made to `regex`: rust-lang/regex#1305
BurntSushi
added a commit
to BurntSushi/jiff
that referenced
this pull request
Oct 13, 2025
In rust-lang/rust#138907, the `doc_auto_cfg` feature was subsumed by `doc_cfg`. This does overall looks like we're on a path toward stabilization, which is great. One problem here though is that a bunch of crates use the `cfg` `docsrs` to enable `doc_auto_cfg`. So if we enable it, then it causes those crates to emit hard errors. This is overall very annoying, and I don't know how to unfuck things. So I changed the `cfg` knob to `docsrs_jiff` which, doesn't quite provide a guarantee, but gets us closer to being masters of our own destiny. See also a similar change made to `regex`: rust-lang/regex#1305
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In rust-lang/rust#138907, the
doc_auto_cfgfeature was subsumed by
doc_cfg. This does overall look like we're ona path toward stabilization, which is great.
One problem here though is that a bunch of crates use the
cfgdocsrsto enable
doc_auto_cfg. So if we enable it, then it causes thosecrates to stop compiling. This is overall very annoying, and I don't
know how to unfuck things. So I changed the
cfgknob todocsrs_regexwhich, doesn't quite provide a guarantee, but gets us closer to being
masters of our own destiny.