Improve documentation for built-in macros #62243

petrochenkov · 2019-06-29T22:32:10Z

This is the libcore part of #62086.
Right now the only effect is improved documentation.

The changes in the last few commits are required to make the libcore change compile successfully.

rust-highfive · 2019-06-29T22:32:14Z

r? @aidanhs

(rust_highfive has picked a reviewer for you, use r? to override)

petrochenkov · 2019-06-29T22:35:56Z

r? @eddyb

eddyb · 2019-07-01T10:10:07Z

src/librustc/hir/lowering.rs

@@ -4008,7 +4008,7 @@ impl<'a> LoweringContext<'a> {
        let attrs = self.lower_attrs(&i.attrs);
        if let ItemKind::MacroDef(ref def) = i.node {
            if !def.legacy || attr::contains_name(&i.attrs, sym::macro_export) ||
-                              attr::contains_name(&i.attrs, sym::rustc_doc_only_macro) {
+                              attr::contains_name(&i.attrs, sym::rustc_builtin_macro) {


Is this needed anymore? The macro_rules! -> macro change would mean !def.legacy is now true.

No, this is no longer needed (UPD: for libcore, it's still needed for libstd).

src/librustc_resolve/macros.rs

eddyb · 2019-07-01T10:14:25Z

src/libstd/macros.rs

@@ -410,7 +410,7 @@ mod builtin {
    ///
    /// [`panic!`]: ../std/macro.panic.html
    #[stable(feature = "compile_error_macro", since = "1.20.0")]
-    #[rustc_doc_only_macro]
+    #[rustc_builtin_macro]
    macro_rules! compile_error {


Oh, these are unchanged. What needs to happen before these can just be reexports of the libcore ones?

rustc_builtin_macro stubs acting like the real macros.

#62086 removes the duplicate macros from libstd, but also pub uses their libcore versions from libstd's root (for documentation).
...And stub macros pub used in libstd root break all the dependent crates that inject #[macro_use] extern crate std during rustdoc build.

Alternatively, some doc attribute for selectively documenting private items would also solve the problem (pub use could be replaced with #[doc(force)] use then).

eddyb · 2019-07-01T10:15:35Z

src/libsyntax/feature_gate.rs

+    (sym::rustc_allow_const_fn_ptr, Whitelisted, template!(Word), Gated(Stability::Unstable,
+                                                sym::rustc_attrs,
+                                                "internal implementation detail",
+                                                cfg_fn!(rustc_attrs))),


Oh, you whitelisted all the existing rustc_* attributes?

Yep.
If an attribute is not defined/registered in any way, then it goes through the "feature(custom_attribute) fallback" (#29642), something I want to remove from resolve (#61660, #57921).

Also, it's just useful for documentation.
#62133 does the same thing.

eddyb · 2019-07-01T12:42:32Z

@bors r+

bors · 2019-07-01T12:42:33Z

📌 Commit c959d7338b3f47bcbdc89f75cdf357c6b3e2f0df has been approved by eddyb

bors · 2019-07-05T21:57:57Z

☔ The latest upstream changes (presumably #62419) made this pull request unmergeable. Please resolve the merge conflicts.

petrochenkov · 2019-07-05T22:36:05Z

@bors r=eddyb

bors · 2019-07-05T22:36:06Z

📌 Commit 848b2d2 has been approved by eddyb

petrochenkov · 2019-07-06T14:50:29Z

Failed in #62442 (comment)

Ugh, unstable diagnostic output.

petrochenkov · 2019-07-06T15:43:33Z

unstable diagnostic output.

Order in which mir_const_qualif visits items somehow depends on macro loading order.
I didn't investigate that in detail, but I changed the last commit to not load macros in check_reserved_macro_name unless absolutely necessary instead, thus restoring the old macro loading order.

@bors r=eddyb

bors · 2019-07-06T15:43:34Z

📌 Commit 3274507 has been approved by eddyb

Improve documentation for built-in macros This is the `libcore` part of rust-lang#62086. Right now the only effect is improved documentation. The changes in the last few commits are required to make the `libcore` change compile successfully.

@ghost

Rollup of 6 pull requests Successful merges: - #60081 (Refactor unicode.py script) - #61862 (Make the Weak::{into,as}_raw methods) - #62243 (Improve documentation for built-in macros) - #62422 (Remove some uses of mem::uninitialized) - #62432 (Update rustfmt to 1.3.2) - #62436 (normalize use of backticks/lowercase in compiler messages for librustc_mir) Failed merges: r? @ghost

Improve documentation for built-in macros This is the `libcore` part of rust-lang#62086. Right now the only effect is improved documentation. The changes in the last few commits are required to make the `libcore` change compile successfully.

@ghost

Rollup of 5 pull requests Successful merges: - #60081 (Refactor unicode.py script) - #61862 (Make the Weak::{into,as}_raw methods) - #62243 (Improve documentation for built-in macros) - #62422 (Remove some uses of mem::uninitialized) - #62436 (normalize use of backticks/lowercase in compiler messages for librustc_mir) Failed merges: r? @ghost

bors · 2019-07-07T01:14:38Z

⌛ Testing commit 3274507 with merge b0bd5f2...

pietroalbini · 2019-07-15T16:07:45Z

@bors r-

pietroalbini · 2019-07-15T16:08:01Z

@bors retry

rust-highfive assigned aidanhs Jun 29, 2019

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 29, 2019

rust-highfive assigned eddyb and unassigned aidanhs Jun 29, 2019

eddyb reviewed Jul 1, 2019

View reviewed changes

src/librustc_resolve/macros.rs Outdated Show resolved Hide resolved

eddyb reviewed Jul 1, 2019

View reviewed changes

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 1, 2019

Manishearth mentioned this pull request Jul 2, 2019

Rollup of 16 pull requests #62294

Closed

Mark-Simulacrum mentioned this pull request Jul 3, 2019

Rollup of 20 pull requests #62333

Closed

Centril mentioned this pull request Jul 4, 2019

Rollup of 7 pull requests #62363

Closed

Mark-Simulacrum mentioned this pull request Jul 4, 2019

Rollup of 8 pull requests #62372

Closed

Mark-Simulacrum mentioned this pull request Jul 4, 2019

Rollup of 10 pull requests #62378

Closed

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jul 5, 2019

petrochenkov force-pushed the macrodoc branch from c959d73 to 848b2d2 Compare July 5, 2019 22:35

bors removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Jul 5, 2019

petrochenkov added 5 commits July 6, 2019 16:59

#[rustc_doc_only_macro] -> #[rustc_builtin_macro]

15042a3

#[rustc_transparent_macro] -> #[rustc_macro_transparency = ...]

22d6d8a

Improve documentation for built-in macros

ab112ca

Fix tidy issues

987be89

privacy: Only opaque macros leak private things

920a17a

resolve: Reserve cfg/cfg_attr/derive only in attribute sub-namespace

3274507

petrochenkov force-pushed the macrodoc branch from 848b2d2 to 3274507 Compare July 6, 2019 15:37

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 6, 2019

Centril mentioned this pull request Jul 6, 2019

Rollup of 6 pull requests #62449

Closed

Centril mentioned this pull request Jul 6, 2019

Rollup of 5 pull requests #62452

Merged

bors merged commit 3274507 into rust-lang:master Jul 7, 2019

petrochenkov deleted the macrodoc branch July 8, 2019 13:34

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jul 15, 2019

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 15, 2019

SimonSapin mentioned this pull request Jul 16, 2019

ICE "no ImplicitCtxt stored in tls" in Servo on Windows and macOS #62717

Closed

Undin mentioned this pull request Jul 27, 2019

Builtin macro pattern separator #63039

Closed

dtolnay mentioned this pull request Dec 6, 2021

Add rustversion::cfg! macro dtolnay/rustversion#30

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve documentation for built-in macros #62243

Improve documentation for built-in macros #62243

petrochenkov commented Jun 29, 2019

rust-highfive commented Jun 29, 2019

petrochenkov commented Jun 29, 2019

eddyb Jul 1, 2019

petrochenkov Jul 1, 2019 •

edited

Loading

eddyb Jul 1, 2019

petrochenkov Jul 1, 2019

eddyb Jul 1, 2019

petrochenkov Jul 1, 2019

eddyb commented Jul 1, 2019

bors commented Jul 1, 2019

bors commented Jul 5, 2019

petrochenkov commented Jul 5, 2019

bors commented Jul 5, 2019

petrochenkov commented Jul 6, 2019

petrochenkov commented Jul 6, 2019

bors commented Jul 6, 2019

bors commented Jul 7, 2019

pietroalbini commented Jul 15, 2019

pietroalbini commented Jul 15, 2019

Improve documentation for built-in macros #62243

Improve documentation for built-in macros #62243

Conversation

petrochenkov commented Jun 29, 2019

rust-highfive commented Jun 29, 2019

petrochenkov commented Jun 29, 2019

eddyb Jul 1, 2019

Choose a reason for hiding this comment

petrochenkov Jul 1, 2019 • edited Loading

Choose a reason for hiding this comment

eddyb Jul 1, 2019

Choose a reason for hiding this comment

petrochenkov Jul 1, 2019

Choose a reason for hiding this comment

eddyb Jul 1, 2019

Choose a reason for hiding this comment

petrochenkov Jul 1, 2019

Choose a reason for hiding this comment

eddyb commented Jul 1, 2019

bors commented Jul 1, 2019

bors commented Jul 5, 2019

petrochenkov commented Jul 5, 2019

bors commented Jul 5, 2019

petrochenkov commented Jul 6, 2019

petrochenkov commented Jul 6, 2019

bors commented Jul 6, 2019

bors commented Jul 7, 2019

pietroalbini commented Jul 15, 2019

pietroalbini commented Jul 15, 2019

petrochenkov Jul 1, 2019 •

edited

Loading