Skip to content

{json|html}docck: catch and error on deprecated syntax #137103

New issue

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

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

Already on GitHub? # to your account

Merged
merged 3 commits into from
Mar 3, 2025

Conversation

yotamofek
Copy link
Contributor

@rustbot
Copy link
Collaborator

rustbot commented Feb 15, 2025

r? @Mark-Simulacrum

rustbot has assigned @Mark-Simulacrum.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added A-rustdoc-json Area: Rustdoc JSON backend 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 Feb 15, 2025
@yotamofek
Copy link
Contributor Author

I think r? @fmease should make more sense? and maybe @aDotInTheVoid as the rustdoc json person

@rustbot rustbot assigned fmease and unassigned Mark-Simulacrum Feb 15, 2025
@yotamofek
Copy link
Contributor Author

(this will cause tests to fail on CI until #137099 is merged)

@fmease fmease added the S-blocked Status: Blocked on something else such as an RFC or other implementation work. label Feb 15, 2025
@rust-log-analyzer

This comment has been minimized.

@aDotInTheVoid
Copy link
Member

I like the idea of erroring on this, but haven’t reviewed the impl yet.

CC @jieyouxu, as this does part of #125813, and can be removed if compiletest itself does this.

@jieyouxu
Copy link
Member

Yeah, I wouldn't be too worried about the duplicate effort, because the compiletest one won't be any time soon. So getting this check for htmldocck in would still be beneficial.

@aDotInTheVoid
Copy link
Member

r? @aDotInTheVoid

r=me after #137099 is merged

@bors rollup=always

@bors delegate

@rust-log-analyzer

This comment has been minimized.

jieyouxu added a commit to jieyouxu/rust that referenced this pull request Feb 28, 2025
…directives, r=notriddle

Fix (more) test directives that were accidentally ignored

Continuation of rust-lang#137099 , caught by rust-lang#137103 (and needed to unblock that one).
These test directives were accidentally using the old (`// `@`)` syntax
jieyouxu added a commit to jieyouxu/rust that referenced this pull request Feb 28, 2025
…directives, r=notriddle

Fix (more) test directives that were accidentally ignored

Continuation of rust-lang#137099 , caught by rust-lang#137103 (and needed to unblock that one).
These test directives were accidentally using the old (`// ``@`)`` syntax
jieyouxu added a commit to jieyouxu/rust that referenced this pull request Feb 28, 2025
…directives, r=notriddle

Fix (more) test directives that were accidentally ignored

Continuation of rust-lang#137099 , caught by rust-lang#137103 (and needed to unblock that one).
These test directives were accidentally using the old (`// ```@`)``` syntax
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Mar 1, 2025
Rollup merge of rust-lang#137540 - yotamofek:pr/more-deprecated-test-directives, r=notriddle

Fix (more) test directives that were accidentally ignored

Continuation of rust-lang#137099 , caught by rust-lang#137103 (and needed to unblock that one).
These test directives were accidentally using the old (`// ```@`)``` syntax
@yotamofek yotamofek force-pushed the pr/jsonhtmldocck-deprecated-syntax branch from 48283aa to 797ef64 Compare March 1, 2025 10:32
@yotamofek
Copy link
Contributor Author

@aDotInTheVoid I think the bors incantation was wrong, it should be "delegate+" or "delegate=yotamofek" (according to the docs..)

Anyways, CI is green now, so care to approve? Thanks! 😊

@aDotInTheVoid
Copy link
Member

@bors r+

@bors
Copy link
Collaborator

bors commented Mar 1, 2025

📌 Commit 797ef64 has been approved by aDotInTheVoid

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. S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Mar 1, 2025
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 1, 2025
…ted-syntax, r=aDotInTheVoid

{json|html}docck: catch and error on deprecated syntax

rust-lang#137099 (review)
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 2, 2025
…iaskrgr

Rollup of 9 pull requests

Successful merges:

 - rust-lang#136865 (Perform deeper compiletest path normalization for `$TEST_BUILD_DIR` to account for compare-mode/debugger cases, and normalize long type file filename hashes)
 - rust-lang#136922 (Pattern types: Avoid having to handle an Option for range ends in the type system or the HIR)
 - rust-lang#137081 (change config.toml to bootstrap.toml)
 - rust-lang#137103 ({json|html}docck: catch and error on deprecated syntax)
 - rust-lang#137632 (rustdoc: when merging target features, keep the highest stability)
 - rust-lang#137684 (Add rustdoc support for `--emit=dep-info[=path]`)
 - rust-lang#137794 (make qnx pass a test)
 - rust-lang#137801 (tests: Unignore target modifier tests on all platforms)
 - rust-lang#137826 (test(codegen): add looping_over_ne_bytes test for rust-lang#133528)

Failed merges:

 - rust-lang#137147 (Add exclude to config.toml)

r? `@ghost`
`@rustbot` modify labels: rollup
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 2, 2025
…ted-syntax, r=aDotInTheVoid

{json|html}docck: catch and error on deprecated syntax

rust-lang#137099 (review)
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 2, 2025
…iaskrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#136865 (Perform deeper compiletest path normalization for `$TEST_BUILD_DIR` to account for compare-mode/debugger cases, and normalize long type file filename hashes)
 - rust-lang#137081 (change config.toml to bootstrap.toml)
 - rust-lang#137103 ({json|html}docck: catch and error on deprecated syntax)
 - rust-lang#137632 (rustdoc: when merging target features, keep the highest stability)
 - rust-lang#137684 (Add rustdoc support for `--emit=dep-info[=path]`)
 - rust-lang#137794 (make qnx pass a test)
 - rust-lang#137801 (tests: Unignore target modifier tests on all platforms)
 - rust-lang#137826 (test(codegen): add looping_over_ne_bytes test for rust-lang#133528)

r? `@ghost`
`@rustbot` modify labels: rollup
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 2, 2025
…ted-syntax, r=aDotInTheVoid

{json|html}docck: catch and error on deprecated syntax

rust-lang#137099 (review)
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 3, 2025
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#136865 (Perform deeper compiletest path normalization for `$TEST_BUILD_DIR` to account for compare-mode/debugger cases, and normalize long type file filename hashes)
 - rust-lang#137103 ({json|html}docck: catch and error on deprecated syntax)
 - rust-lang#137632 (rustdoc: when merging target features, keep the highest stability)
 - rust-lang#137684 (Add rustdoc support for `--emit=dep-info[=path]`)
 - rust-lang#137794 (make qnx pass a test)
 - rust-lang#137801 (tests: Unignore target modifier tests on all platforms)
 - rust-lang#137826 (test(codegen): add looping_over_ne_bytes test for rust-lang#133528)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 3, 2025
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#137103 ({json|html}docck: catch and error on deprecated syntax)
 - rust-lang#137632 (rustdoc: when merging target features, keep the highest stability)
 - rust-lang#137684 (Add rustdoc support for `--emit=dep-info[=path]`)
 - rust-lang#137794 (make qnx pass a test)
 - rust-lang#137801 (tests: Unignore target modifier tests on all platforms)
 - rust-lang#137826 (test(codegen): add looping_over_ne_bytes test for rust-lang#133528)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 3, 2025
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#137103 ({json|html}docck: catch and error on deprecated syntax)
 - rust-lang#137632 (rustdoc: when merging target features, keep the highest stability)
 - rust-lang#137684 (Add rustdoc support for `--emit=dep-info[=path]`)
 - rust-lang#137794 (make qnx pass a test)
 - rust-lang#137801 (tests: Unignore target modifier tests on all platforms)
 - rust-lang#137826 (test(codegen): add looping_over_ne_bytes test for rust-lang#133528)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 3, 2025
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#137103 ({json|html}docck: catch and error on deprecated syntax)
 - rust-lang#137632 (rustdoc: when merging target features, keep the highest stability)
 - rust-lang#137684 (Add rustdoc support for `--emit=dep-info[=path]`)
 - rust-lang#137794 (make qnx pass a test)
 - rust-lang#137801 (tests: Unignore target modifier tests on all platforms)
 - rust-lang#137826 (test(codegen): add looping_over_ne_bytes test for rust-lang#133528)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 3, 2025
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#137103 ({json|html}docck: catch and error on deprecated syntax)
 - rust-lang#137632 (rustdoc: when merging target features, keep the highest stability)
 - rust-lang#137684 (Add rustdoc support for `--emit=dep-info[=path]`)
 - rust-lang#137794 (make qnx pass a test)
 - rust-lang#137801 (tests: Unignore target modifier tests on all platforms)
 - rust-lang#137826 (test(codegen): add looping_over_ne_bytes test for rust-lang#133528)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 3, 2025
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#137103 ({json|html}docck: catch and error on deprecated syntax)
 - rust-lang#137632 (rustdoc: when merging target features, keep the highest stability)
 - rust-lang#137684 (Add rustdoc support for `--emit=dep-info[=path]`)
 - rust-lang#137794 (make qnx pass a test)
 - rust-lang#137801 (tests: Unignore target modifier tests on all platforms)
 - rust-lang#137826 (test(codegen): add looping_over_ne_bytes test for rust-lang#133528)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 0447829 into rust-lang:master Mar 3, 2025
6 checks passed
@rustbot rustbot added this to the 1.87.0 milestone Mar 3, 2025
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Mar 3, 2025
Rollup merge of rust-lang#137103 - yotamofek:pr/jsonhtmldocck-deprecated-syntax, r=aDotInTheVoid

{json|html}docck: catch and error on deprecated syntax

rust-lang#137099 (review)
@yotamofek yotamofek deleted the pr/jsonhtmldocck-deprecated-syntax branch March 5, 2025 06:09
@aDotInTheVoid
Copy link
Member

This just caught an error I made. Thanks <3

--- stderr -------------------------------
Invalid command: Deprecated command syntax, replace `// @` with `//@ ` on line 1
Invalid command: Deprecated command syntax, replace `// @` with `//@ ` on line 2
Jsondocck failed for /home/gh-aDotInTheVoid/rust2/tests/rustdoc-json/attrs/deprecated.rs
----------------------

@yotamofek
Copy link
Contributor Author

yotamofek commented Mar 16, 2025

Yay 🥰

jhpratt added a commit to jhpratt/rust that referenced this pull request Apr 21, 2025
…aumeGomez

jsondocck: Require command is at start of line

In one place we use `///`@`` instead of `//`@`.` The test-runner allowed it, but it probably shouldn't. Ran into by `@lolbinarycat` in rust-lang#132748 (comment):

```
error: unknown disambiguator `?(`
##[error] --> /checkout/tests/rustdoc-json/fns/return_type_alias.rs:3:25
  |
3 | ///@ set foo = "$.index[?(`@.name=='Foo')].id"`
  |                         ^^
  |
```

Maybe it's also worth erroring on this like we added in rust-lang#137103

r? `@GuillaumeGomez`
jieyouxu added a commit to jieyouxu/rust that referenced this pull request Apr 21, 2025
…aumeGomez

jsondocck: Require command is at start of line

In one place we use `///`@`` instead of `//`@`.` The test-runner allowed it, but it probably shouldn't. Ran into by `@lolbinarycat` in rust-lang#132748 (comment):

```
error: unknown disambiguator `?(`
##[error] --> /checkout/tests/rustdoc-json/fns/return_type_alias.rs:3:25
  |
3 | ///@ set foo = "$.index[?(`@.name=='Foo')].id"`
  |                         ^^
  |
```

Maybe it's also worth erroring on this like we added in rust-lang#137103

r? `@GuillaumeGomez`
ChrisDenton added a commit to ChrisDenton/rust that referenced this pull request Apr 21, 2025
…aumeGomez

jsondocck: Require command is at start of line

In one place we use `///``@``` instead of `//``@`.`` The test-runner allowed it, but it probably shouldn't. Ran into by ``@lolbinarycat`` in rust-lang#132748 (comment):

```
error: unknown disambiguator `?(`
##[error] --> /checkout/tests/rustdoc-json/fns/return_type_alias.rs:3:25
  |
3 | ///@ set foo = "$.index[?(``@.name=='Foo')].id"``
  |                         ^^
  |
```

Maybe it's also worth erroring on this like we added in rust-lang#137103

r? ``@GuillaumeGomez``
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Apr 21, 2025
Rollup merge of rust-lang#140076 - aDotInTheVoid:jsondocline, r=GuillaumeGomez

jsondocck: Require command is at start of line

In one place we use `///``@``` instead of `//``@`.`` The test-runner allowed it, but it probably shouldn't. Ran into by ``@lolbinarycat`` in rust-lang#132748 (comment):

```
error: unknown disambiguator `?(`
##[error] --> /checkout/tests/rustdoc-json/fns/return_type_alias.rs:3:25
  |
3 | ///@ set foo = "$.index[?(``@.name=='Foo')].id"``
  |                         ^^
  |
```

Maybe it's also worth erroring on this like we added in rust-lang#137103

r? ``@GuillaumeGomez``
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-rustdoc-json Area: Rustdoc JSON backend 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.

8 participants