Skip to content

tidy: check for invalid file names #143957

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 16, 2025
Merged

tidy: check for invalid file names #143957

merged 1 commit into from
Jul 16, 2025

Conversation

samueltardieu
Copy link
Member

@samueltardieu samueltardieu commented Jul 15, 2025 •
edited by rustbot
Loading

Check for file names added to git with:

  • non-UTF8 filenames (this would fail "fmt check" with a decoding error for the moment, but maybe we should not count on it as it is an accidental failure)
  • control characters (such as "\n" or "\r" in file names)
  • ":" (which is a special character on Windows, made rustdoc-json: Structured attributes #142936 fail in bors while it could have be caught earlier)

It only checks files known by git as a developer might want to have "strange" file names alongside their local repository as long as they don't check them in.

r? jieyouxu
as he stumbled upon such a file in #142936

@rustbot
Copy link
Collaborator

rustbot commented Jul 15, 2025

jieyouxu is currently at their maximum review capacity.
They may take a while to respond.

@rustbot rustbot added A-tidy Area: The tidy tool S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Jul 15, 2025
@rustbot
Copy link
Collaborator

rustbot commented Jul 15, 2025

There are changes to the tidy tool.

cc @jieyouxu

@Kobzol
Copy link
Member

Kobzol commented Jul 15, 2025

Just out of curiosity, how long does it take to run this on your machine?

@samueltardieu
Copy link
Member Author

To run git ls-files in my working directory, around 16ms wall time. Timing x test tidy gives no perceivable difference in walltime (4.22s vs. 4.26s, but it can vary in both directions – 24 virtual cores laptop):

with this PR:

Executed in    4.26 secs    fish           external
   usr time   14.15 secs    3.70 millis   14.15 secs
   sys time    5.47 secs    1.12 millis    5.47 secs

without this PR:

Executed in    4.22 secs    fish           external
   usr time   14.35 secs    0.79 millis   14.35 secs
   sys time    5.40 secs    1.13 millis    5.40 secs

@Kobzol
Copy link
Member

Kobzol commented Jul 15, 2025

Okay, that should be fine. Hopefully it won't be sluggish e.g. on Windows, but I think that tidy does so much I/O anyway that this won't be bad.

@samueltardieu
Copy link
Member Author

Yeah, since it uses only file names and not even file contents, there is a good chance that the cache is primed already (or that this primes it for other parts of tidy). If it gets r+, maybe rollup=never would make it easier to roll it back in case it is heavier than expected on some platforms.

@Kobzol
Copy link
Member

Kobzol commented Jul 15, 2025

I think it will be fine, I realized that it won't even read all the filenames from disk, which I first wrongly assumed, just return the filenames from the internal git DB, that should be fine.

The git -C argument wouldn't work on some of our CI runners with old OS, but I think these should be just the dist builders that don't run tests anyway. Let's see.

@bors r+

@bors
Copy link
Collaborator

bors commented Jul 15, 2025

📌 Commit cbaaf15 has been approved by Kobzol

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 Jul 15, 2025
samueltardieu added a commit to samueltardieu/rust that referenced this pull request Jul 16, 2025
@samueltardieu
Rollup merge of rust-lang#143957 - samueltardieu:tidy-filenames, r=Ko…
5131130 
…bzol

tidy: check for invalid file names

Check for file names added to git with:
- non-UTF8 filenames (this would fail "fmt check" with a decoding error for the moment, but maybe we should not count on it as it is an accidental failure)
- control characters (such as "\n" or "\r" in file names)
- ":" (which is a special character on Windows, made rust-lang#142936 fail in bors while it could have be caught earlier)

It only checks files known by git as a developer might want to have "strange" file names alongside their local repository as long as they don't check them in.

r? jieyouxu
as he stumbled upon such a file in rust-lang#142936
@samueltardieu samueltardieu mentioned this pull request Jul 16, 2025
Closed
bors added a commit that referenced this pull request Jul 16, 2025
@bors
Auto merge of #144017 - samueltardieu:rollup-wm6jjdj, r=samueltardieu
15863f2 
Rollup of 13 pull requests

Successful merges:

 - #142936 (rustdoc-json: Structured attributes)
 - #143355 (wrapping shift: remove first bitmask and table)
 - #143448 (remote-test-client: Exit code `128 + <signal-number>` instead of `3`)
 - #143692 (miri: fix out-of-bounds error for ptrs with negative offsets)
 - #143719 (Emit warning when there is no space between `-o` and arg)
 - #143738 (Move several float tests to floats/mod.rs)
 - #143920 (Make more of codegen_llvm safe)
 - #143921 (Constify `Index` traits)
 - #143939 (Add 0323pin as maintainer of NetBSD targets, fix link to pkgsrc-wip and explain.)
 - #143948 (Update mdbook to 0.4.52)
 - #143957 (tidy: check for invalid file names)
 - #143968 (Add tracing to `InterpCx::fn_abi_of_instance/fn_abi_of_fn_ptr`)
 - #143990 (Add LocalKey<Cell>::update)

r? `@ghost`
`@rustbot` modify labels: rollup
@samueltardieu samueltardieu mentioned this pull request Jul 16, 2025
Merged
bors added a commit that referenced this pull request Jul 16, 2025
@bors
Auto merge of #144028 - samueltardieu:rollup-x6f9h8n, r=samueltardieu
5795086 
Rollup of 12 pull requests

Successful merges:

 - #142936 (rustdoc-json: Structured attributes)
 - #143355 (wrapping shift: remove first bitmask and table)
 - #143448 (remote-test-client: Exit code `128 + <signal-number>` instead of `3`)
 - #143692 (miri: fix out-of-bounds error for ptrs with negative offsets)
 - #143738 (Move several float tests to floats/mod.rs)
 - #143920 (Make more of codegen_llvm safe)
 - #143921 (Constify `Index` traits)
 - #143939 (Add 0323pin as maintainer of NetBSD targets, fix link to pkgsrc-wip and explain.)
 - #143948 (Update mdbook to 0.4.52)
 - #143957 (tidy: check for invalid file names)
 - #143968 (Add tracing to `InterpCx::fn_abi_of_instance/fn_abi_of_fn_ptr`)
 - #143990 (Add LocalKey<Cell>::update)

r? `@ghost`
`@rustbot` modify labels: rollup
@jieyouxu jieyouxu assigned Kobzol and unassigned jieyouxu Jul 16, 2025
@bors bors merged commit 19470bc into rust-lang:master Jul 16, 2025
11 checks passed
@rustbot rustbot added this to the 1.90.0 milestone Jul 16, 2025
rust-timer added a commit that referenced this pull request Jul 16, 2025
@rust-timer
Unrolled build for #143957
d9d43c7 
Rollup merge of #143957 - samueltardieu:tidy-filenames, r=Kobzol

tidy: check for invalid file names

Check for file names added to git with:
- non-UTF8 filenames (this would fail "fmt check" with a decoding error for the moment, but maybe we should not count on it as it is an accidental failure)
- control characters (such as "\n" or "\r" in file names)
- ":" (which is a special character on Windows, made #142936 fail in bors while it could have be caught earlier)

It only checks files known by git as a developer might want to have "strange" file names alongside their local repository as long as they don't check them in.

r? jieyouxu
as he stumbled upon such a file in #142936
@matthiaskrgr matthiaskrgr mentioned this pull request Jul 16, 2025
Closed
github-actions bot pushed a commit to rust-lang/miri that referenced this pull request Jul 17, 2025
@bors
Auto merge of #144028 - samueltardieu:rollup-x6f9h8n, r=samueltardieu
f34b41a 
Rollup of 12 pull requests

Successful merges:

 - rust-lang/rust#142936 (rustdoc-json: Structured attributes)
 - rust-lang/rust#143355 (wrapping shift: remove first bitmask and table)
 - rust-lang/rust#143448 (remote-test-client: Exit code `128 + <signal-number>` instead of `3`)
 - rust-lang/rust#143692 (miri: fix out-of-bounds error for ptrs with negative offsets)
 - rust-lang/rust#143738 (Move several float tests to floats/mod.rs)
 - rust-lang/rust#143920 (Make more of codegen_llvm safe)
 - rust-lang/rust#143921 (Constify `Index` traits)
 - rust-lang/rust#143939 (Add 0323pin as maintainer of NetBSD targets, fix link to pkgsrc-wip and explain.)
 - rust-lang/rust#143948 (Update mdbook to 0.4.52)
 - rust-lang/rust#143957 (tidy: check for invalid file names)
 - rust-lang/rust#143968 (Add tracing to `InterpCx::fn_abi_of_instance/fn_abi_of_fn_ptr`)
 - rust-lang/rust#143990 (Add LocalKey<Cell>::update)

r? `@ghost`
`@rustbot` modify labels: rollup
Muscraft pushed a commit to Muscraft/rust that referenced this pull request Jul 21, 2025
@samueltardieu @Muscraft
Rollup merge of rust-lang#143957 - samueltardieu:tidy-filenames, r=Ko…
a8c192a 
…bzol

tidy: check for invalid file names

Check for file names added to git with:
- non-UTF8 filenames (this would fail "fmt check" with a decoding error for the moment, but maybe we should not count on it as it is an accidental failure)
- control characters (such as "\n" or "\r" in file names)
- ":" (which is a special character on Windows, made rust-lang#142936 fail in bors while it could have be caught earlier)

It only checks files known by git as a developer might want to have "strange" file names alongside their local repository as long as they don't check them in.

r? jieyouxu
as he stumbled upon such a file in rust-lang#142936
Muscraft pushed a commit to Muscraft/rust that referenced this pull request Jul 21, 2025
@bors @Muscraft
Auto merge of rust-lang#144028 - samueltardieu:rollup-x6f9h8n, r=samu…
06b4b93 
…eltardieu

Rollup of 12 pull requests

Successful merges:

 - rust-lang#142936 (rustdoc-json: Structured attributes)
 - rust-lang#143355 (wrapping shift: remove first bitmask and table)
 - rust-lang#143448 (remote-test-client: Exit code `128 + <signal-number>` instead of `3`)
 - rust-lang#143692 (miri: fix out-of-bounds error for ptrs with negative offsets)
 - rust-lang#143738 (Move several float tests to floats/mod.rs)
 - rust-lang#143920 (Make more of codegen_llvm safe)
 - rust-lang#143921 (Constify `Index` traits)
 - rust-lang#143939 (Add 0323pin as maintainer of NetBSD targets, fix link to pkgsrc-wip and explain.)
 - rust-lang#143948 (Update mdbook to 0.4.52)
 - rust-lang#143957 (tidy: check for invalid file names)
 - rust-lang#143968 (Add tracing to `InterpCx::fn_abi_of_instance/fn_abi_of_fn_ptr`)
 - rust-lang#143990 (Add LocalKey<Cell>::update)

r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@Kobzol Kobzol

Labels
A-tidy Area: The tidy tool S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Milestone
1.90.0
Development

Successfully merging this pull request may close these issues.
5 participants
@samueltardieu @rustbot @Kobzol @bors @jieyouxu