Simplify doc meta mode#159473
Conversation
Since we're getting rid of the ability to do finalize and document at the same time, we can't actually do this in the rustdoc-html test build system and need to do it this way instead.
rustbot
added
A-run-make
|
r? @folkertdev rustbot has assigned @folkertdev. Use Why was this reviewer chosen?The reviewer was selected based on:
|
|
r? @camelid |
|
|
There was a problem hiding this comment.
I don't fully understand the purpose of the changes in this commit. Did --enable-index-page not work at all when CCI was enabled, prior to this change? Could you explain a bit?
| htmldocck().arg(&out_dir).arg("tango.rs").run(); | ||
| htmldocck().arg(&out_dir).arg("quebec.rs").run(); | ||
| htmldocck().arg(&out_dir).arg("sierra.rs").run(); | ||
| htmldocck().arg(&out_dir).arg("indigo.rs").run(); | ||
| htmldocck().arg(&out_dir).arg("romeo.rs").run(); |
There was a problem hiding this comment.
Unless I'm mistaken, it doesn't seem like there are any actual htmldocck @ has checks in these files? In particular, it seems like we should be testing for the presence/content of the index page (either in the form of htmldocck assertions or here in the rmake).
There was a problem hiding this comment.
Where is the check that errors when both --read... and --write... are passed?
|
|
||
| If both `--write-doc-meta-dir` and `--read-doc-meta-dir` are specified, the crate metadata will be | ||
| written to both the HTML `--out-dir` and to the supplied `--write-doc-meta-dir`. | ||
| Both `--write-doc-meta-dir` and `--read-doc-meta-dir` can't be supplied at once. |
There was a problem hiding this comment.
| Both `--write-doc-meta-dir` and `--read-doc-meta-dir` can't be supplied at once. | |
| `--write-doc-meta-dir` and `--read-doc-meta-dir` cannot both be passed to the same rustdoc invocation. |
| When `--read-doc-meta-dir` is supplied, rustdoc runs in *finalize mode*. It will read the data from | ||
| the supplied directory, and will write it to the doc output directory in the form that the web | ||
| frontend will use. | ||
| When `--read-doc-meta-dir` is supplied, it runs it in *finalize mode*. No crate source code is |
There was a problem hiding this comment.
| When `--read-doc-meta-dir` is supplied, it runs it in *finalize mode*. No crate source code is | |
| When `--read-doc-meta-dir` is supplied, rustdoc runs in *finalize mode*. No crate source code is |
camelid
added
S-waiting-on-author
4 participants
Follow up #159415 (comment)
Get rid of the mode where you can finalize the CCI and generate more docs at the same time. It isn't used in Cargo, and probably won't be used elsewhere?