Skip to content

Commit 9397d03

Browse files
ctzdjc
authored andcommitted
docs.rs: use unique cfg for enabling nightly doc options
1 parent 719cc88 commit 9397d03

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

.github/workflows/ci.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@ jobs:
5555
- name: cargo doc (ring)
5656
run: cargo doc --features ring,pem,x509-parser --document-private-items
5757
env:
58-
RUSTDOCFLAGS: ${{ matrix.toolchain == 'nightly' && '-Dwarnings --cfg=docsrs' || '-Dwarnings' }}
58+
RUSTDOCFLAGS: ${{ matrix.toolchain == 'nightly' && '-Dwarnings --cfg=rcgen_docsrs' || '-Dwarnings' }}
5959
- name: cargo doc (aws_lc_rs_unstable)
6060
run: cargo doc --features aws_lc_rs_unstable,pem,x509-parser --document-private-items
6161
env:
62-
RUSTDOCFLAGS: ${{ matrix.toolchain == 'nightly' && '-Dwarnings --cfg=docsrs' || '-Dwarnings' }}
62+
RUSTDOCFLAGS: ${{ matrix.toolchain == 'nightly' && '-Dwarnings --cfg=rcgen_docsrs' || '-Dwarnings' }}
6363
- name: cargo doc (fips)
6464
run: cargo doc --no-default-features --features fips --document-private-items
6565
env:
66-
RUSTDOCFLAGS: ${{ matrix.toolchain == 'nightly' && '-Dwarnings --cfg=docsrs' || '-Dwarnings' }}
66+
RUSTDOCFLAGS: ${{ matrix.toolchain == 'nightly' && '-Dwarnings --cfg=rcgen_docsrs' || '-Dwarnings' }}
6767

6868
check-external-types:
6969
name: Validate external types appearing in public API

rcgen/Cargo.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,14 @@ required-features = ["crypto", "pem"]
4545

4646
[package.metadata.docs.rs]
4747
features = ["aws_lc_rs", "aws_lc_rs_unstable", "crypto", "ring", "x509-parser"]
48+
rustdoc-args = ["--cfg", "rcgen_docsrs"]
4849

4950
[package.metadata.cargo_check_external_types]
5051
allowed_external_types = [
5152
"time::offset_date_time::OffsetDateTime",
5253
"zeroize::Zeroize",
5354
"rustls_pki_types::*",
5455
]
56+
57+
[lints.rust]
58+
unexpected_cfgs = { level = "warn", check-cfg = ["cfg(rcgen_docsrs)"] }

rcgen/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ println!("{}", signing_key.serialize_pem());
2929
#![forbid(unsafe_code)]
3030
#![forbid(non_ascii_idents)]
3131
#![deny(missing_docs)]
32-
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
32+
#![cfg_attr(rcgen_docsrs, feature(doc_cfg, doc_auto_cfg))]
3333
#![warn(unreachable_pub)]
3434

3535
use std::borrow::Cow;

0 commit comments

Comments
 (0)