Update `derive` to use the attribute template #1883

ehuss · 2025-06-30T23:30:01Z

New rules:

❗ attributes.derive.allowed-positions
❗ attributes.derive.duplicates
❗ attributes.derive.stdlib
❗ attributes.derive.built-in
❗ attributes.derive.built-in-automatically_derived
❗ attributes.derive.behavior

Changed rules:

❗ names.preludes.lang.entities --- derive macros are in the macro namespace

Removed rules:

❌ attributes.derive.proc-macro --- moved to intro

This moves the text into the intro. I think it's fine to have this be more of a high-level introduction. The details and rules of derive proc-macros are covered in the proc-macro chapter, so there doesn't need to be an explicit rule here.

This is a slight rewording of attributes.derive.syntax. This drops the "list of traits" since these are really list of derive macros, of which there just happens to be several built-in ones that have the same name as their corresponding trait.

cc rust-lang#540

This adds a basic rule for the behavior of derive. I think there is more to be said here, this is just a starting point. See things like rust-lang#540 and rust-lang#1074.

I'm not sure if I should put it in as part of derive or part of automatically_derived.

Let's be a bit more clear about the purpose of the `derive` attribute being to invoke derive macros, and let's talk about "invoking" these macros rather than "processing" them.

Update books ## rust-lang/book 5 commits in b2d1a0821e12a676b496d61891b8e3d374a8e832..3e9dc46aa563ca0c53ec826c41b05f10c5915925 2025-08-02 01:33:29 UTC to 2025-07-14 21:23:38 UTC - Appendix B and Appendix D from tech review (rust-lang/book#4466) - Chapter 21 from tech review (rust-lang/book#4464) - Chapter 20 from tech review (rust-lang/book#4460) - Chapter 19 from tech review (rust-lang/book#4446) - Chapter 18 from tech review (rust-lang/book#4445) ## rust-lang/reference 12 commits in 1f45bd41fa6c17b7c048ed6bfe5f168c4311206a..1be151c051a082b542548c62cafbcb055fa8944f 2025-08-05 19:51:40 UTC to 2025-07-14 19:49:01 UTC - Fix build output directory in README (rust-lang/reference#1950) - Update `link_name` to use the attribute template (rust-lang/reference#1896) - Update `no_link` to use the attribute template (rust-lang/reference#1898) - Update `proc_macro_derive` to use the attribute template (rust-lang/reference#1888) - Update `automatically_derived` to use the attribute template (rust-lang/reference#1884) - Update `derive` to use the attribute template (rust-lang/reference#1883) - Fix and clarify CR LF normalization and CR in string literals (rust-lang/reference#1944) - glossary.md: tweak description of "dispatch" (rust-lang/reference#1938) - add missing id, r[asm.operand-type.supported-operands.const] (rust-lang/reference#1939) - &str and &[u8] have the same layout (rust-lang/reference#1848) - Rename and rewrite the "question mark operator" (rust-lang/reference#1931) - Change "allocated object" to "allocation". (rust-lang/reference#1930) ## rust-lang/rust-by-example 3 commits in e386be5f44af711854207c11fdd61bb576270b04..bd1279cdc9865bfff605e741fb76a0b2f07314a7 2025-08-04 13:41:04 UTC to 2025-08-02 15:41:59 UTC - Improve the activity instructions in `print_display` (rust-lang/rust-by-example#1948) - Minor fixes (whitespace, typo, i32->u32) (rust-lang/rust-by-example#1947) - Document drawbacks of alternatives to match binding (rust-lang/rust-by-example#1946)

Rollup merge of #145026 - rustbot:docs-update, r=ehuss Update books ## rust-lang/book 5 commits in b2d1a0821e12a676b496d61891b8e3d374a8e832..3e9dc46aa563ca0c53ec826c41b05f10c5915925 2025-08-02 01:33:29 UTC to 2025-07-14 21:23:38 UTC - Appendix B and Appendix D from tech review (rust-lang/book#4466) - Chapter 21 from tech review (rust-lang/book#4464) - Chapter 20 from tech review (rust-lang/book#4460) - Chapter 19 from tech review (rust-lang/book#4446) - Chapter 18 from tech review (rust-lang/book#4445) ## rust-lang/reference 12 commits in 1f45bd41fa6c17b7c048ed6bfe5f168c4311206a..1be151c051a082b542548c62cafbcb055fa8944f 2025-08-05 19:51:40 UTC to 2025-07-14 19:49:01 UTC - Fix build output directory in README (rust-lang/reference#1950) - Update `link_name` to use the attribute template (rust-lang/reference#1896) - Update `no_link` to use the attribute template (rust-lang/reference#1898) - Update `proc_macro_derive` to use the attribute template (rust-lang/reference#1888) - Update `automatically_derived` to use the attribute template (rust-lang/reference#1884) - Update `derive` to use the attribute template (rust-lang/reference#1883) - Fix and clarify CR LF normalization and CR in string literals (rust-lang/reference#1944) - glossary.md: tweak description of "dispatch" (rust-lang/reference#1938) - add missing id, r[asm.operand-type.supported-operands.const] (rust-lang/reference#1939) - &str and &[u8] have the same layout (rust-lang/reference#1848) - Rename and rewrite the "question mark operator" (rust-lang/reference#1931) - Change "allocated object" to "allocation". (rust-lang/reference#1930) ## rust-lang/rust-by-example 3 commits in e386be5f44af711854207c11fdd61bb576270b04..bd1279cdc9865bfff605e741fb76a0b2f07314a7 2025-08-04 13:41:04 UTC to 2025-08-02 15:41:59 UTC - Improve the activity instructions in `print_display` (rust-lang/rust-by-example#1948) - Minor fixes (whitespace, typo, i32->u32) (rust-lang/rust-by-example#1947) - Document drawbacks of alternatives to match binding (rust-lang/rust-by-example#1946)

Update books ## rust-lang/book 5 commits in b2d1a0821e12a676b496d61891b8e3d374a8e832..3e9dc46aa563ca0c53ec826c41b05f10c5915925 2025-08-02 01:33:29 UTC to 2025-07-14 21:23:38 UTC - Appendix B and Appendix D from tech review (rust-lang/book#4466) - Chapter 21 from tech review (rust-lang/book#4464) - Chapter 20 from tech review (rust-lang/book#4460) - Chapter 19 from tech review (rust-lang/book#4446) - Chapter 18 from tech review (rust-lang/book#4445) ## rust-lang/reference 12 commits in 1f45bd41fa6c17b7c048ed6bfe5f168c4311206a..1be151c051a082b542548c62cafbcb055fa8944f 2025-08-05 19:51:40 UTC to 2025-07-14 19:49:01 UTC - Fix build output directory in README (rust-lang/reference#1950) - Update `link_name` to use the attribute template (rust-lang/reference#1896) - Update `no_link` to use the attribute template (rust-lang/reference#1898) - Update `proc_macro_derive` to use the attribute template (rust-lang/reference#1888) - Update `automatically_derived` to use the attribute template (rust-lang/reference#1884) - Update `derive` to use the attribute template (rust-lang/reference#1883) - Fix and clarify CR LF normalization and CR in string literals (rust-lang/reference#1944) - glossary.md: tweak description of "dispatch" (rust-lang/reference#1938) - add missing id, r[asm.operand-type.supported-operands.const] (rust-lang/reference#1939) - &str and &[u8] have the same layout (rust-lang/reference#1848) - Rename and rewrite the "question mark operator" (rust-lang/reference#1931) - Change "allocated object" to "allocation". (rust-lang/reference#1930) ## rust-lang/rust-by-example 3 commits in e386be5f44af711854207c11fdd61bb576270b04..bd1279cdc9865bfff605e741fb76a0b2f07314a7 2025-08-04 13:41:04 UTC to 2025-08-02 15:41:59 UTC - Improve the activity instructions in `print_display` (rust-lang/rust-by-example#1948) - Minor fixes (whitespace, typo, i32->u32) (rust-lang/rust-by-example#1947) - Document drawbacks of alternatives to match binding (rust-lang/rust-by-example#1946)

ehuss added 8 commits June 27, 2025 14:41

Unwrap derive

324bc6b

Move derive example into an example block

55d9464

Remove attributes.derive.proc-macro

1596141

This moves the text into the intro. I think it's fine to have this be more of a high-level introduction. The details and rules of derive proc-macros are covered in the proc-macro chapter, so there doesn't need to be an explicit rule here.

Reword attributes.derive.syntax

6b2a4af

This is a slight rewording of attributes.derive.syntax. This drops the "list of traits" since these are really list of derive macros, of which there just happens to be several built-in ones that have the same name as their corresponding trait.

Add attribute template rules for derive

fa6fc39

Add attributes.derive.built-in

c520969

cc rust-lang#540

Add attributes.derive.behavior

176c79b

This adds a basic rule for the behavior of derive. I think there is more to be said here, this is just a starting point. See things like rust-lang#540 and rust-lang#1074.

Add attributes.derive.built-in-automatically_derived

b9a4f3c

I'm not sure if I should put it in as part of derive or part of automatically_derived.

rustbot added the S-waiting-on-review Status: The marked PR is awaiting review from a maintainer label Jun 30, 2025

traviscross approved these changes Aug 2, 2025

View reviewed changes

traviscross enabled auto-merge August 2, 2025 23:01

traviscross disabled auto-merge August 2, 2025 23:02

Revise editorially

46f5c66

Let's be a bit more clear about the purpose of the `derive` attribute being to invoke derive macros, and let's talk about "invoking" these macros rather than "processing" them.

traviscross force-pushed the derive branch from 509fdee to 46f5c66 Compare August 2, 2025 23:02

traviscross enabled auto-merge August 2, 2025 23:03

traviscross added this pull request to the merge queue Aug 2, 2025

Merged via the queue into rust-lang:master with commit a2406f5 Aug 2, 2025
5 checks passed

rustbot removed the S-waiting-on-review Status: The marked PR is awaiting review from a maintainer label Aug 2, 2025

rustbot mentioned this pull request Aug 6, 2025

Update books rust-lang/rust#145026

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update `derive` to use the attribute template #1883

Update `derive` to use the attribute template #1883

Uh oh!

ehuss commented Jun 30, 2025

Uh oh!

Uh oh!

Uh oh!

Update derive to use the attribute template #1883

Update derive to use the attribute template #1883

Uh oh!

Conversation

ehuss commented Jun 30, 2025

Uh oh!

Uh oh!

Uh oh!

Update `derive` to use the attribute template #1883

Update `derive` to use the attribute template #1883