Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[tests/rustdoc] Add @files command #112960

Merged
merged 2 commits into from
Jun 23, 2023

Conversation

GuillaumeGomez
Copy link
Member

The @!has checks is very problematic as it wouldn't catch if the file scheme is updated and the file is generated again. @files allows to ensure that the given folder contains exactly the provided entries (files and folders).

I'm wondering if we should forbid the @!has for files. To be discussed after this PR I suppose.

r? @notriddle

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 23, 2023
@jyn514 jyn514 changed the title [rustdoc] Add @files command [tests/rustdoc] Add @files command Jun 23, 2023
@jyn514 jyn514 added the A-testsuite Area: The testsuite used to check the correctness of rustc label Jun 23, 2023
@notriddle
Copy link
Contributor

!has is fine for HTML, since we shouldn't be breaking public links anyway. Just not /implementations/trait.Foo.js, which is allowed to change.

@GuillaumeGomez
Copy link
Member Author

Yes, that's what I meant when I wrote:

I'm wondering if we should forbid the @!has for files.

Sorry if it wasn't clear enough.

@notriddle
Copy link
Contributor

Sounds fine to me. Actually "forbidding" something should go through an FCP, but this change seems fine:

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jun 23, 2023

📌 Commit 752fb52 has been approved by notriddle

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 23, 2023
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jun 23, 2023
…, r=notriddle

[tests/rustdoc] Add @files command

The ``@!has`` checks is very problematic as it wouldn't catch if the file scheme is updated and the file is generated again. ``@files`` allows to ensure that the given folder contains exactly the provided entries (files and folders).

I'm wondering if we should forbid the ``@!has`` for files. To be discussed after this PR I suppose.

r? `@notriddle`
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 23, 2023
…, r=notriddle

[tests/rustdoc] Add @files command

The ```@!has``` checks is very problematic as it wouldn't catch if the file scheme is updated and the file is generated again. ```@files``` allows to ensure that the given folder contains exactly the provided entries (files and folders).

I'm wondering if we should forbid the ```@!has``` for files. To be discussed after this PR I suppose.

r? ``@notriddle``
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 23, 2023
…, r=notriddle

[tests/rustdoc] Add @files command

The ````@!has```` checks is very problematic as it wouldn't catch if the file scheme is updated and the file is generated again. ````@files```` allows to ensure that the given folder contains exactly the provided entries (files and folders).

I'm wondering if we should forbid the ````@!has```` for files. To be discussed after this PR I suppose.

r? ```@notriddle```
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 23, 2023
…, r=notriddle

[tests/rustdoc] Add @files command

The `````@!has````` checks is very problematic as it wouldn't catch if the file scheme is updated and the file is generated again. `````@files````` allows to ensure that the given folder contains exactly the provided entries (files and folders).

I'm wondering if we should forbid the `````@!has````` for files. To be discussed after this PR I suppose.

r? ````@notriddle````
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 23, 2023
…iaskrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#112616 (Improve tests on targets without unwinding)
 - rust-lang#112643 (Always register sized obligation for argument)
 - rust-lang#112740 (Add link to rustdoc book search chapter in help popover)
 - rust-lang#112810 (Don't ICE on unnormalized struct tail in layout computation)
 - rust-lang#112870 (Migrate `item_bounds` to `ty::Clause`)
 - rust-lang#112925 (Stop hiding const eval limit in external macros)
 - rust-lang#112960 ([tests/rustdoc] Add `@files` command)
 - rust-lang#112962 (Fix rustdoc gui tester)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 4821f80 into rust-lang:master Jun 23, 2023
@rustbot rustbot added this to the 1.72.0 milestone Jun 23, 2023
@GuillaumeGomez GuillaumeGomez deleted the rustdoc-files-check branch June 24, 2023 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-testsuite Area: The testsuite used to check the correctness of rustc S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants