diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2023-08-28 08:13:58 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-28 08:13:58 +0200 |
| commit | 9fb586cb520cf1be9aa8e869da864c014fa2d6c2 (patch) | |
| tree | e7b2a686e457dd9bae2e49a4146771957262a160 | |
| parent | 81408561e0102a93214f4f5420cece718f4d1093 (diff) | |
| parent | 776466d6b75f9f08700a4a0d8c7de9638971e414 (diff) | |
| download | rust-9fb586cb520cf1be9aa8e869da864c014fa2d6c2.tar.gz rust-9fb586cb520cf1be9aa8e869da864c014fa2d6c2.zip | |
Rollup merge of #115278 - RalfJung:removed-error-codes, r=GuillaumeGomez
tell people what to do when removing an error code Currently tidy and CI send developers on a wild goose chase: - you edit the code - CI/tidy tells you that an error code is gone, so you remove it from the list - CI/tidy tells you that the markdown file is stale, so you remove that as well - CI (but not tidy) tells you not to remove an error description and copy what E0001 does Let's be nice to people and directly tell them what to do rather than making them follow misleading breadcrumbs. r? ``@GuillaumeGomez``
| -rw-r--r-- | compiler/rustc_error_codes/src/error_codes.rs | 3 | ||||
| -rw-r--r-- | src/tools/tidy/src/error_codes.rs | 7 |
2 files changed, 8 insertions, 2 deletions
diff --git a/compiler/rustc_error_codes/src/error_codes.rs b/compiler/rustc_error_codes/src/error_codes.rs index d104ff0891d..2daf591bd65 100644 --- a/compiler/rustc_error_codes/src/error_codes.rs +++ b/compiler/rustc_error_codes/src/error_codes.rs @@ -516,7 +516,8 @@ E0793: include_str!("./error_codes/E0793.md"), E0794: include_str!("./error_codes/E0794.md"), } -// Undocumented removed error codes. Note that many removed error codes are documented. +// Undocumented removed error codes. Note that many removed error codes are kept in the list above +// and marked as no-longer emitted with a note in the markdown file (see E0001 for an example). // E0006, // merged with E0005 // E0008, // cannot bind by-move into a pattern guard // E0019, // merged into E0015 diff --git a/src/tools/tidy/src/error_codes.rs b/src/tools/tidy/src/error_codes.rs index 417ace58c32..3e67bac499b 100644 --- a/src/tools/tidy/src/error_codes.rs +++ b/src/tools/tidy/src/error_codes.rs @@ -354,7 +354,12 @@ fn check_error_codes_used( for code in error_codes { if !found_codes.contains(code) && !no_longer_emitted.contains(code) { - errors.push(format!("Error code `{code}` exists, but is not emitted by the compiler!")) + errors.push(format!( + "Error code `{code}` exists, but is not emitted by the compiler!\n\ + Please mark the code as no longer emitted by adding the following note to the top of the `EXXXX.md` file:\n\ + `#### Note: this error code is no longer emitted by the compiler`\n\ + Also, do not forget to mark doctests that no longer apply as `ignore (error is no longer emitted)`." + )); } if found_codes.contains(code) && no_longer_emitted.contains(code) { |