Marking Cargo.lock as generated

[dwijnand]

12 weeks have passed, let's mark lock files as generated!

Fixes #6180

[rust-highfive]

r? @alexcrichton

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

[alexcrichton]

Thanks!

I wonder if we could perhaps expand the comment a bit? Something along the lines of adding human-readable text about how it's a generated file and should not be edited, followed by @generated perhaps? I think it'd also be good to have a comment in the Cargo source indicating what @generated means and why we're emitting it.

[dwijnand]

Sure! I was a little unsure, so I pushed my attempt. WDYT? I'm happy to keep tweaking it.

[dwijnand]

I used https://github.com/github/linguist/blob/f1f4018d7a9950c1d9cf3d0887d994cf496d63c4/lib/linguist/generated.rb as inspiration (note Cargo.lock is already ignored there). Specifically, I preferred "Not intended for manual editing" over "Do not edit" (or "DO NOT EDIT").

[alexcrichton]

This is going to affect every single Rust project and likely surprise a lot of people. I think we're ready for this change though and the surprise is mostly going to be a result of change, not that it's a change that shouldn't have happened. Regardless I'd like to make sure we're all on board with this, so..

@rfcbot fcp merge

[rfcbot]

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

• @Eh2406
• @alexcrichton
• @dwijnand
• @ehuss
• @joshtriplett
• @nrc
• @withoutboats
• @wycats

No concerns currently listed.

Once a majority of reviewers approve (and none object), 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.

[ehuss]

This is going to affect every single Rust project

Just to be clear, the only effect is that if you check in the Cargo.lock into VCS, it will show up as dirty after the first build with a new cargo? If you don't check the lock file in, you probably won't even notice?

[alexcrichton]

@ehuss an excellent clarification, and spot on

[ghost]

Excuse me, why there is two spaces here?

[dwijnand]

https://en.wikipedia.org/wiki/Sentence_spacing

[rfcbot]

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

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

[lukaslueg]

Maybe nitpicking but could we have a full English sentence instead of "Not intended for manual editing" here? E.g. "This file is not intended for manual editing" or "It is not ...". Also, if this is an auto-generated egg, where is the chicken - who generated it?

This file was automatically @generated by Cargo. It is not intended for manual editing.

[alexcrichton]

@dwijnand want to follow up with @lukaslueg's thoughts and we can merge?

[dwijnand]

I thought it was fine, but I don't mind tweaking it. I dropped the "automatically" because I want to keep it one line, under 80 chars, as looking in https://github.com/github/linguist/blob/f1f4018d7a9950c1d9cf3d0887d994cf496d63c4/lib/linguist/generated.rb it's probably best, over multi-line markers.

[alexcrichton]

Hm I'm not sure I understand the restriction of one line, is that something that tools conventionally try to accept?

[dwijnand]

Yes, it would appear so, from that linguist file.

But I realised we can just call the first one the marker line. So it's now two lines:

# This file is automatically @generated by Cargo.
# It is not intended for manual editing.

[alexcrichton]

@bors: r+

[bors]

📌 Commit bd0e4a0 has been approved by alexcrichton

[bors]

⌛ Testing commit bd0e4a0 with merge 3de188f...

[bors]

☀️ Test successful - checks-travis, status-appveyor
Approved by: alexcrichton
Pushing 3de188f to master...