docs(embedded): Note the shebang deviation by epage · Pull Request #15173 · rust-lang/cargo (original) (raw)

What does this PR try to resolve?

rustc considers the following valid and without a shebang:

// Hello

[allow(dead_code)]

fn main() { println!("Hello, world!"); }

and

[allow(dead_code)]

fn main() {
    println!("Hello, world!");
}

In both cases, we consider it to have a shebang. This commit documents that intention.

We could add our own heuristics
(e.g. #! with only whitespace is not a shebang)
but we should either be a subset or intentionally different than rustc (e.g. require a non [-prefixes interpreter)
rather than do both.

Fixes #15170

How should we test and review this PR?

This will be reflected in the tracking issue which will handle the final decision for the team on this matter.

Additional information