new chapter with examples of diagnostic translation PRs by tshepang · Pull Request #1621 · rust-lang/rustc-dev-guide

tshepang · 2023-02-25T20:13:38Z

I found other examples overwhelming, as they tend to handle large parts of rustc crates, so decided to point to these more simple ones I created.

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

It used to be a submodule. cf. rust-lang/rust#99603

#1406) Co-authored-by: Yuki Okushi <jtitor@2k36.org> Co-authored-by: Ridwan Abdilahi <riabdila@microsoft.com>

Signed-off-by: Yuki Okushi <jtitor@2k36.org>

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

Co-authored-by: Joshua Nelson <github@jyn.dev>

#1402 (comment)

* make date-check lightweight This avoids having to write the date twice when updating date-check. Before "As of <-- 2022-07 --> July 2022" After "As of July 2022" * please clippy * update date-check docs * accept review suggestion Co-authored-by: Noah Lev <camelidcamel@gmail.com> * address review comment #1394 (review) * accept review suggestion Co-authored-by: Noah Lev <camelidcamel@gmail.com> * address review comment #1394 (review) * address review comment #1394 (comment) * this breaks markdown * address review comment #1394 (comment) This led to a more robust regex, though making the tool more picky. It also found a wrong date format that was missed. * address review comment #1394 (comment) * address review comment #1394 (comment) * accept review suggestion This was reverted by mistake Co-authored-by: Noah Lev <camelidcamel@gmail.com> * address review comment #1394 (comment) * use a more simple fn * address review comment #1394 (comment) Much more clean * nit * accept review suggestion Co-authored-by: Noah Lev <camelidcamel@gmail.com> * avoid a failed regex Also, test new shape * adjust to new regex (which uses named groups) New regex was introduced by 456008c Co-authored-by: Noah Lev <camelidcamel@gmail.com>

Latest reference on it I could find on zulip: https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/Cursed.3A.20no_core.20Add.20on.20primitive.20int.20returning.20Option.3C.3E/near/287514393

This diagram is based on the diagram in Joshua Nelson's talk on bootstrapping at RustConf 2022 [1]. I converted it to Mermaid and made some tweaks to simplify it and bring it closer to bootstrap's terminology, and then Ralf Jung added nodes for copying artifacts. [1]: https://rustconf.com/schedule#bootstrapping-the-once-and-future-compiler Co-authored-by: Joshua Nelson <github@jyn.dev> Co-authored-by: Ralf Jung <post@ralfj.de>

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

Also, make link to upstream llvm repo clickable

Signed-off-by: Yuki Okushi <jtitor@2k36.org>

compiler-errors

Thanks for this. I think we could use this as an opportunity to provide a bit more "motivation" for the various parts of migrating these diagnostic structs if we add more information. Left a bunch of nits..

compiler-errors · 2023-03-07T02:55:20Z

+ecx.struct_span_err(span, "proc-macro derive produced unparseable tokens").emit();
+```
+
+> Note that `ecx.struct_span_err` is the [Session::struct_span_err].


Suggested change

> Note that `ecx.struct_span_err` is the [Session::struct_span_err].

> Note that `ecx.struct_span_err` calls [Session::struct_span_err].

This should also probably link to ecx.struct_span_err (https://doc.rust-lang.org/nightly/nightly-rustc/rustc_expand/base/struct.ExtCtxt.html#method.struct_span_err) so that users can attest this relationship themselves.

yeah, that should have been ultimately calls...

compiler-errors · 2023-03-07T02:56:00Z

+- Replace the code above with this:
+
+  ```rust
+  ecx.sess.emit_err(errors::ProcMacroDeriveTokens { span });


Should point to emit_err in rustdocs. Also, useful to point out that if the user wants to make a diagnostic, but not emit it, they can use create_err.

tough balance between adding useful info and avoiding the overwhelm... I should find a way to fit create_err in the reference

compiler-errors · 2023-03-07T02:56:21Z

+  ecx.sess.emit_err(errors::ProcMacroDeriveTokens { span });
+  ```
+
+- Create the above type, `errors::ProcMacroDeriveTokens`,


Suggested change

- Create the above type, `errors::ProcMacroDeriveTokens`,

- Add a diagnostic struct, `errors::ProcMacroDeriveTokens`,

compiler-errors · 2023-03-07T02:56:46Z

+Referring to the [general comments](#general-comments) section above,
+follow these changes:
+
+- Replace the code above with this:


Suggested change

- Replace the code above with this:

- Replace the calls to `struct_span_err` and `emit` with:

compiler-errors · 2023-03-07T02:58:06Z

+  #[derive(Diagnostic)]
+  #[diag(expand_proc_macro_derive_tokens)]
+  pub struct ProcMacroDeriveTokens {
+      #[primary_span]


I think it may be useful to motivate the three important parts of this:

derive(Diagnostic)

diag(FLUENT_SLUG)

and primary_span

Maybe why we need these three components, what other components are common, etc?

I more wanted to have people see the pattern, than do wall-of-text which can overwhelm. The more complete details are in the reference chapters (earlier in the guide).

Co-authored-by: Michael Goulet <michael@errs.io>

See https://github.com/rust-lang/rustc-dev-guide/pull/1621/files#r1127288705

spastorino · 2023-10-26T14:23:20Z

@compiler-errors do you think this is fine to merge now?.

jieyouxu · 2024-11-02T07:33:32Z

Update: cf rust-lang/rust#132181 (diag infra currently in limbo, no longer mandatory usage, but examples/clarifications will still be very helpful)

Kobzol · 2025-01-05T17:27:58Z

Sorry, due to me messing up a git operation, we sadly had to force-push the whole commit history of rustc-dev-guide :( If you'd like to update this pull request, you will have to rebase it in a special way onto the new commit history (the new master):

git fetch origin --all
git checkout <pr-branch>
git rebase --onto origin/master origin/master-old
git push --force-with-lease

More context can be found here.

tshepang and others added 30 commits July 19, 2022 09:56

remove stray markup

2b87b31

Fix link to clippy sync docs

5c8febd

Link to rendered book directly

bac43d0

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

Debuginfo tests now also support revisions.

d5201cd

rust-analyzer is now a subtree

bcc1166

It used to be a submodule. cf. rust-lang/rust#99603

Add documentation about Microsoft provided debuggers and CodeView/PDB… (

c7637de

#1406) Co-authored-by: Yuki Okushi <jtitor@2k36.org> Co-authored-by: Ridwan Abdilahi <riabdila@microsoft.com>

Document how to build a cross-compiler

e5e5a9b

Add instructions to fix build errors in std after adding a new target

30a4d2b

Fix the link to Lazy<T>

c0b491e

Signed-off-by: Yuki Okushi <jtitor@2k36.org>

Fix the link to ProcMacro trait

18fa8fb

Signed-off-by: Yuki Okushi <jtitor@2k36.org>

Fix the link to ResolverAstLowering

bbbd60d

Signed-off-by: Yuki Okushi <jtitor@2k36.org>

Fix the link to clippy docs

637ebaa

Signed-off-by: Yuki Okushi <jtitor@2k36.org>

Prefer relative links

7955bb3

Signed-off-by: Yuki Okushi <jtitor@2k36.org>

minor fixes

ea7e58a

revamp doc-build chapter

67af5ca

Update src/building/compiler-documenting.md

6f97f45

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

summary of chapter

d9596c6

try address review comments

3389074

accept review suggestion

3678b50

Co-authored-by: Joshua Nelson <github@jyn.dev>

address review comment

04f3cf0

#1402 (comment)

date-check: be more strict

5c4b673

note is now too old to be relevant

e305a42

date-check: rustc_codegen_ssa is still alive

6964f75

Latest reference on it I could find on zulip: https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/Cursed.3A.20no_core.20Add.20on.20primitive.20int.20returning.20Option.3C.3E/near/287514393

Add colors to diagram

c1c84d6

Add color for downloaded nodes

81a4d04

Fix legend colors in dark mode

df17432

update date-check format on github issue (#1416)

1dee5f8

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

move references down to avoid clutter (#1420)

f979af6

Also, make link to upstream llvm repo clickable

tshepang and others added 9 commits February 21, 2023 23:12

this remains true (#1620)

9d76913

Fixed typing errors (#1622)

b06dab8

update error code docs to reflect recent changes (#1625)

2d0681e

Fixed typing error (#1623)

b684e35

Making the sentence more clear (#1624)

62f03c2

Add detail to contributing guide (#1628)

82e50a6

Update explnation about Body.basic_blocks

4597bb4

Signed-off-by: Yuki Okushi <jtitor@2k36.org>

Update date reference about infer context variables

d1d6ce8

Signed-off-by: Yuki Okushi <jtitor@2k36.org>

Remove mention to lexer/parser refactoring

7e50a6a

Signed-off-by: Yuki Okushi <jtitor@2k36.org>

JohnTitor added the S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content label Mar 4, 2023

new chapter with examples of diagnostic translation PRs

78c3edc

compiler-errors reviewed Mar 7, 2023

View reviewed changes

tshepang and others added 3 commits March 7, 2023 08:41

accept review suggestions

0650847

Co-authored-by: Michael Goulet <michael@errs.io>

address review comment

425b628

See https://github.com/rust-lang/rustc-dev-guide/pull/1621/files#r1127288705

improve

d95acf2

JohnTitor assigned compiler-errors Apr 3, 2023

update location of .ftl files

ca3e018

tshepang added S-waiting-on-author Status: this PR is waiting for additional action by the OP and removed S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content labels Jul 7, 2023

jieyouxu added A-diagnostics Area: diagnostics A-translation Area: diagnostics translation and other translations T-compiler Relevant to the compiler team labels Nov 4, 2024

Kobzol force-pushed the master branch from 340f758 to 885fd79 Compare January 5, 2025 17:10

jieyouxu added S-stale Status: this PR is stale, maybe it can be salvaged/revived? and removed S-waiting-on-author Status: this PR is waiting for additional action by the OP labels May 29, 2025

tshepang marked this pull request as draft November 29, 2025 00:02

tshepang closed this by deleting the head repository Jan 1, 2026

	> Note that `ecx.struct_span_err` is the [Session::struct_span_err].
	> Note that `ecx.struct_span_err` calls [Session::struct_span_err].

	- Create the above type, `errors::ProcMacroDeriveTokens`,
	- Add a diagnostic struct, `errors::ProcMacroDeriveTokens`,

	- Replace the code above with this:
	- Replace the calls to `struct_span_err` and `emit` with:

Conversation

tshepang commented Feb 25, 2023

Uh oh!

compiler-errors left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

compiler-errors Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

tshepang Mar 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

compiler-errors Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

tshepang Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

compiler-errors Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

compiler-errors Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

compiler-errors Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

tshepang Mar 7, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

spastorino commented Oct 26, 2023

Uh oh!

jieyouxu commented Nov 2, 2024

Uh oh!

Kobzol commented Jan 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants

tshepang Mar 7, 2023 •

edited

Loading