Tracking issue for `main` feature #29634

aturon · 2015-11-05T19:58:33Z

Tracks stabilzation of the #[main] attribute, which allows an arbitrary function to be tagged as main.

Status Update

Decision was reached to remove this feature and looking for someone to implement; here is a list of instructions, feel free to reach out to @nikomatsakis for more tips!

The text was updated successfully, but these errors were encountered:

SimonSapin · 2015-12-18T15:23:40Z

Is there a reason to do this other than cosmetic preference for another name?

nikomatsakis · 2016-11-11T21:03:11Z

@rfcbot fcp close

I propose that we just remove this feature altogether. I don't see a lot of clamoring for it. =) There are three users according to @brson's survey though -- @brson, was that just a grep that cratesio or what?

rfcbot · 2016-11-11T21:10:18Z

Team member @nikomatsakis has proposed to close this. The next step is review by the rest of the tagged teams:

No concerns currently listed.

Once these reviewers reach consensus, this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

steveklabnik · 2016-11-11T21:28:56Z

The only place that comes close to this for me is osdev, and there, you use no_main rather than main, so...

nrc · 2016-11-13T20:22:16Z

We still have start or whatever for doing this do we?

withoutboats · 2016-11-13T22:46:45Z

@rfcbot reviewed

nikomatsakis · 2016-11-14T20:28:05Z

@nrc I guess that is slightly different? I think that #[start] configures at a higher-level than main? Perhaps @alexcrichton or @brson can expound on that.

alexcrichton · 2016-11-14T23:27:14Z

Ah yes, we've got three entry points. I.. think this is how they work:

First, #[start], the receiver of int argc and char **argv. This is literally the symbol main (or what is called by that symbol generated in the compiler).
Next, there's #[lang = "start"]. If no #[start] exists in the crate graph then the compiler generates a main function that calls this. This functions receives argc/argv along with a third argument that is a function pointer to the #[main] function (defined below). Importantly, #[lang = "start"] can be located in a library. For example it's located in the standard library (libstd).
Finally, #[main], the main function for an executable. This is passed no arguments and is called by #[lang = "start"] (if it decides to). The standard library uses this to initialize itself and then call the Rust program. This, if not specified, defaults to fn main at the top.

So to answer your question, this isn't the same as #[start]. To answer your other (possibly not yet asked) question, yes we have too many entry points.

rfcbot · 2016-12-21T18:01:22Z

🔔 This is now entering its final comment period, as per the review above. 🔔

psst @nikomatsakis, I wasn't able to add the final-comment-period label, please do so.

rfcbot · 2017-01-23T08:25:38Z

The final comment period is now complete.

nikomatsakis · 2017-01-24T21:56:14Z

We have no officially decided to REMOVE the #[main] feature and would welcome any help from someone who wishes to do it!

Here are the steps to take:

remove the feature from the list src/libsyntax/feature_gate.rs:136 and add it to the list of removed features found around line 316
the attribute main should be removed from the list in BUILTIN_ATTRIBUTES at src/libsyntax/feature_gate.rs:443;
the code in src/librustc/middle/entry.rs:89 (and mirrored code in src/libsyntax/entry.rs:29) should be adjusted to remove the case covering else if attr::contains_name(&item.attrs, "main") {
the feature gate code from src/libsyntax/feature_gate.rs:1056 can be removed
presumably the code in and around src/libsyntax/test.rs:206 that references "main" can be removed too
write a test trying to use the feature and show that it errors out

These line numbers may drift over time. :/ For the records, I found them mostly by running ripgrep '"main"' =)

UPDATE: #39282 is a good example of how to do a generic stabilization PR.

cramertj · 2017-01-27T08:25:13Z

I'd like to take this!

nikomatsakis · 2017-01-27T15:25:56Z

@cramertj great! =)

cramertj · 2017-01-28T22:33:29Z

Something that's come up as I've been removing the feature that I don't see discussed here: the #[main] attribute allows you to specify main functions that aren't defined at crate-level. I'm not sure how useful/idiomatic this is, but it is used in the existing test harness and a couple other places.

cramertj · 2017-01-28T22:41:39Z

This is particularly useful when using #[cfg(...)]'d modules like in this intrinsic-alignment test.

cramertj · 2017-02-14T19:19:35Z

Update on this, since it's been a while: I implemented the change, but it broke the test harness, which previously used the #[main] attribute in order to override the program's existing main fn. I explored a few other options, such as replacing/renaming the existing main function with the test harness, but it was pretty unwieldy. As I mentioned to @nikomatsakis over email, I think the best way forward is to either keep the #[main] feature around for internal use only (the easiest solution, but leaves the codebase cluttered with obsolete features), or to implement the test harness using #[start] (which, if I understand correctly, requires manually running some sort of initialization for std). What do you all think?

nikomatsakis · 2017-03-14T23:16:53Z

I'm removing the E-easy / E-mentor tags. Based on @cramertj's experience, I don't actually know what's the best way forward at the moment, so i wouldn't consider this easy.

Ericson2314 · 2017-05-08T17:31:30Z

Sorry to hijack a bit, but are any of the others currently stable? I'd like to get a definitive list of what would benefit from a general solution to the "needs provides" problem.

Oh and thanks for the list @alexcrichton. I don't recall all three described side-by-side elsewhere so that was handy.

nikomatsakis · 2017-05-08T18:47:52Z

@Ericson2314

are any of the others currently stable?

other whats?

cramertj · 2017-05-08T18:50:18Z

@nikomatsakis The entry points #[start], #[lang = "start"], and #[main]. I think @Ericson2314 was referencing this comment.

nikomatsakis · 2017-05-11T13:48:18Z

I see. I don't think any of them are stable, but not sure off the top of my head.

Ericson2314 · 2017-05-11T15:05:27Z

Thanks. I suppose at least the lang item definitely wouldn't be.

steveklabnik · 2019-03-12T17:44:32Z

Triage: pretty sure that this is still where it was back in 2017. Since the previous issue was with test harness stuff, I wonder if and when custom test harnesses happen, it will alleviate this or not.

cramertj · 2019-03-12T19:06:57Z

I've been meaning to start more chats about revamping the test harness anyways to work with panic = "abort"-- perhaps on an internals thread / mini-working-group?

Cerber-Ursi · 2019-11-23T09:25:43Z

Just run into the issue preparing this playground. Looks like the compiler error E0601 is currently misleading, since it recommends the main attribute, even on stable where it is unavailable at all. Probably we should drop the corresponding part from the error message at all, as it seems that this attribute is considered to be not for public use anyway.

…henkov Complete removal of #[main] attribute from compiler resolves rust-lang#93786 --- The `#[main]` attribute was mostly removed from the language in rust-lang#84217, but not completely. It is still recognized as a builtin attribute by the compiler, but it has no effect. However, this no-op attribute is no longer gated by `#[feature(main)]` (which no longer exists), so it's possible to include it in code *on stable* without any errors, which seems unintentional. For example, the following code is accepted ([playground link](https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&code=%23%5Bmain%5D%0Afn%20main()%20%7B%0A%20%20%20%20println!(%22hello%20world%22)%3B%0A%7D%0A)). ```rust #[main] fn main() { println!("hello world"); } ``` Aside from that oddity, the existence of this attribute causes code like the following to fail ([playground link](https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&code=use%20tokio%3A%3Amain%3B%0A%0A%23%5Bmain%5D%0Afn%20main()%20%7B%0A%20%20%20%20println!(%22hello%20world%22)%3B%0A%7D%0A)). According rust-lang#84062 (comment), the removal of `#[main]` was expected to eliminate this conflict (previously reported as rust-lang#62127). ```rust use tokio::main; #[main] fn main() { println!("hello world"); } ``` ``` error[E0659]: `main` is ambiguous --> src/main.rs:3:3 | 3 | #[main] | ^^^^ ambiguous name | = note: ambiguous because of a name conflict with a builtin attribute = note: `main` could refer to a built-in attribute ``` [This error message can be confusing](https://stackoverflow.com/q/71024443/1114), as the mostly-removed `#[main]` attribute is not mentioned in any documentation. Since the current availability of `#[main]` on stable seems unintentional, and to needlessly block use of the `main` identifier in the attribute namespace, this PR finishes removing the `#[main]` attribute as described in rust-lang#29634 (comment) by deleting it from `builtin_attrs.rs`, and adds two test cases to ensure that the attribute is no longer accepted and no longer conflicts with other attributes imported as `main`.

aturon added T-lang Relevant to the language team, which will review and decide on the PR/issue. B-unstable Blocker: Implemented in the nightly compiler and unstable. labels Nov 5, 2015

nikomatsakis added the E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. label Jan 24, 2017

nikomatsakis added the E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. label Jan 25, 2017

cramertj mentioned this issue Jan 27, 2017

Remove alternative main feature #39337

Closed

SimonSapin mentioned this issue Feb 19, 2017

Tracking issue for 1.0.0 tracking issues #39954

Closed

38 tasks

nikomatsakis removed E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. labels Mar 14, 2017

Mark-Simulacrum added the C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. label Jul 22, 2017

idubrov mentioned this issue May 8, 2019

Support running on stable commure/datatest#4

Closed

camelid assigned camelid and unassigned camelid Nov 23, 2020

This was referenced Apr 10, 2021

Remove #[main] attribute and add #[rustc_main] attribute. #84062

Closed

Remove #[main] attribute. #84217

Merged

bors closed this as completed in d4bc912 Apr 16, 2021

crlf0710 removed the B-unstable Blocker: Implemented in the nightly compiler and unstable. label May 10, 2021

jeremyBanks mentioned this issue Feb 8, 2022

Complete removal of #[main] attribute from compiler #93753

Merged

kkysen mentioned this issue Sep 13, 2022

Can't compile c2rust-generated program using rustc immunant/c2rust#661

Closed

kkysen mentioned this issue Sep 25, 2022

Don't generate #[main] and #![feature(main)] as it was removed immunant/c2rust#678

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tracking issue for `main` feature #29634

Tracking issue for `main` feature #29634

aturon commented Nov 5, 2015 •

edited by nikomatsakis

Loading

SimonSapin commented Dec 18, 2015

nikomatsakis commented Nov 11, 2016

rfcbot commented Nov 11, 2016 •

edited

Loading

steveklabnik commented Nov 11, 2016

nrc commented Nov 13, 2016

withoutboats commented Nov 13, 2016

nikomatsakis commented Nov 14, 2016

alexcrichton commented Nov 14, 2016

rfcbot commented Dec 21, 2016

rfcbot commented Jan 23, 2017

nikomatsakis commented Jan 24, 2017 •

edited

Loading

cramertj commented Jan 27, 2017

nikomatsakis commented Jan 27, 2017

cramertj commented Jan 28, 2017

cramertj commented Jan 28, 2017

cramertj commented Feb 14, 2017 •

edited

Loading

nikomatsakis commented Mar 14, 2017

Ericson2314 commented May 8, 2017 •

edited

Loading

nikomatsakis commented May 8, 2017

cramertj commented May 8, 2017

nikomatsakis commented May 11, 2017

Ericson2314 commented May 11, 2017

steveklabnik commented Mar 12, 2019

cramertj commented Mar 12, 2019

Cerber-Ursi commented Nov 23, 2019

Tracking issue for main feature #29634

Tracking issue for main feature #29634

Comments

aturon commented Nov 5, 2015 • edited by nikomatsakis Loading

Status Update

SimonSapin commented Dec 18, 2015

nikomatsakis commented Nov 11, 2016

rfcbot commented Nov 11, 2016 • edited Loading

steveklabnik commented Nov 11, 2016

nrc commented Nov 13, 2016

withoutboats commented Nov 13, 2016

nikomatsakis commented Nov 14, 2016

alexcrichton commented Nov 14, 2016

rfcbot commented Dec 21, 2016

rfcbot commented Jan 23, 2017

nikomatsakis commented Jan 24, 2017 • edited Loading

cramertj commented Jan 27, 2017

nikomatsakis commented Jan 27, 2017

cramertj commented Jan 28, 2017

cramertj commented Jan 28, 2017

cramertj commented Feb 14, 2017 • edited Loading

nikomatsakis commented Mar 14, 2017

Ericson2314 commented May 8, 2017 • edited Loading

nikomatsakis commented May 8, 2017

cramertj commented May 8, 2017

nikomatsakis commented May 11, 2017

Ericson2314 commented May 11, 2017

steveklabnik commented Mar 12, 2019

cramertj commented Mar 12, 2019

Cerber-Ursi commented Nov 23, 2019

Tracking issue for `main` feature #29634

Tracking issue for `main` feature #29634

aturon commented Nov 5, 2015 •

edited by nikomatsakis

Loading

rfcbot commented Nov 11, 2016 •

edited

Loading

nikomatsakis commented Jan 24, 2017 •

edited

Loading

cramertj commented Feb 14, 2017 •

edited

Loading

Ericson2314 commented May 8, 2017 •

edited

Loading