Add CI test for documentation of hidden items in std

[ChrisDenton]

Fixes #87844

r? @jyn514

[rustbot]

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

• Stabilizing library features
• Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
• Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
• Changing public documentation in ways that create new stability guarantees
• Changing observable runtime behavior of library APIs

[jyn514]

@ChrisDenton docker seems to be messing with the quotes.

; cat Dockerfile 
FROM alpine:latest
ENV SCRIPT RUSTDOCFLAGS="--document-private-items --document-hidden-items" env | grep RUSTDOC
RUN sh -c "$SCRIPT"
; docker build .
Sending build context to Docker daemon  79.49MB
Step 1/3 : FROM alpine:latest
 ---> 49176f190c7e
Step 2/3 : ENV SCRIPT RUSTDOCFLAGS="--document-private-items --document-hidden-items" env | grep RUSTDOC
 ---> Using cache
 ---> cb827fc459ad
Step 3/3 : RUN sh -c "$SCRIPT"
 ---> Running in 94860e857d3b
sh: --document-hidden-items: not found
The command '/bin/sh -c sh -c "$SCRIPT"' returned a non-zero code: 1

[jyn514]

Escaping the backslashes seems to work:

; docker build .
Sending build context to Docker daemon  79.49MB
Step 1/3 : FROM alpine:latest
 ---> 49176f190c7e
Step 2/3 : ENV SCRIPT RUSTDOCFLAGS=\"--document-private-items --document-hidden-items\" env
 ---> Running in bd1af3f1d278
Removing intermediate container bd1af3f1d278
 ---> efaf4a9fafd7
Step 3/3 : RUN sh -c "$SCRIPT"
 ---> Running in c07667c971ce
RUSTDOCFLAGS=--document-private-items --document-hidden-items
SCRIPT=RUSTDOCFLAGS="--document-private-items --document-hidden-items" env

[ChrisDenton]

Oh eck. Fixed.

[jyn514]

Thanks!

@bors r+

[bors]

📌 Commit 8534fd3 has been approved by jyn514

It is now in the queue for this repository.

[bors]

⌛ Testing commit 8534fd3 with merge fde3000...

[bors]

☀️ Test successful - checks-actions
Approved by: jyn514
Pushing fde3000 to master...

[rust-timer]

Finished benchmarking commit (fde3000): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	2.6%	[2.6%, 2.6%]	1
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-4.0%	[-5.8%, -2.2%]	3
All ❌✅ (primary)	-	-	0

Cycles

This benchmark run did not return any relevant results for this metric.