Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gitignore: add comment explaining policy #63373

Merged
merged 7 commits into from
Aug 9, 2019
Merged

Conversation

RalfJung
Copy link
Member

@RalfJung RalfJung commented Aug 8, 2019

Based on #63307 (comment), I added a comment what I think should be gitignored and what not. This is just a proposal, obviously. Also see #53768 for some more discussion.

The summary is that if there are junk files that you create locally and are fine leaving around (such as mir_dump), git has the option for you to add them to .git/info/exclude. Others might prefer to keep their working dir clean of those same junk files, so we shouldn't just ignore them for everyone.

I then also cleaned up a few more things, but there were many things that I had no idea where they came from so I didn't touch them.

@rust-highfive
Copy link
Collaborator

r? @alexcrichton

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

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 8, 2019
Session.vim
src/etc/dl
tmp.*.rs
version.md
version.ml
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like it is from the OCaml bootstrap days. ;)

.gitignore Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
RalfJung and others added 2 commits August 8, 2019 11:19
Co-Authored-By: Vadim Petrochenkov <vadim.petrochenkov@gmail.com>
.gitignore Outdated Show resolved Hide resolved
@alexcrichton
Copy link
Member

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Aug 8, 2019

📌 Commit 798767c has been approved by alexcrichton

@bors 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 Aug 8, 2019
Centril added a commit to Centril/rust that referenced this pull request Aug 8, 2019
gitignore: add comment explaining policy

Based on rust-lang#63307 (comment), I added a comment what I think should be gitignored and what not. This is just a proposal, obviously.  Also see rust-lang#53768 for some more discussion.

The summary is that if there are junk files that you create locally and are fine leaving around (such as `mir_dump`), git has the option for you to add them to `.git/info/exclude`. Others might prefer to keep their working dir clean of those same junk files, so we shouldn't just ignore them for everyone.

I then also cleaned up a few more things, but there were many things that I had no idea where they came from so I didn't touch them.
Centril added a commit to Centril/rust that referenced this pull request Aug 8, 2019
gitignore: add comment explaining policy

Based on rust-lang#63307 (comment), I added a comment what I think should be gitignored and what not. This is just a proposal, obviously.  Also see rust-lang#53768 for some more discussion.

The summary is that if there are junk files that you create locally and are fine leaving around (such as `mir_dump`), git has the option for you to add them to `.git/info/exclude`. Others might prefer to keep their working dir clean of those same junk files, so we shouldn't just ignore them for everyone.

I then also cleaned up a few more things, but there were many things that I had no idea where they came from so I didn't touch them.
bors added a commit that referenced this pull request Aug 8, 2019
Rollup of 6 pull requests

Successful merges:

 - #63162 (Miri tests: use xargo to build separate libstd)
 - #63289 (Don't recommend `extern crate` syntax)
 - #63373 (gitignore: add comment explaining policy)
 - #63374 (move of packed fields might or might not occur when they actually are sufficiently aligned)
 - #63381 (reduce visibility)
 - #63387 (Test interaction between `async { ... }` and `?`, `return`, and `break`)

Failed merges:

r? @ghost
@bors bors merged commit 798767c into rust-lang:master Aug 9, 2019
@RalfJung RalfJung deleted the gitignore branch August 9, 2019 16:43
@@ -14,20 +18,16 @@ __pycache__/
.valgrindrc
.vscode
.favorites.json
/*-*-*-*/
/*-*-*/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was using this to have dirs git would ignore :(
However, it looks like I can maybe use the # prefix instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just edit your .git/info/exclude to ignore whatever you want.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I keep forgetting why I don't use that more often.

Centril added a commit to Centril/rust that referenced this pull request Oct 21, 2019
…um,Centril

keep the root dir clean from debugging

We landed this before with rust-lang#63307 but recently in rust-lang#65630 the IMO bad ignore crept back in.

If you regularly do graphviz-based debugging and you are fine leaving junk in the rustc root dir, please configure your local `.git/info/exclude`. But most people working on rustc don't work with graphciz all that often (I for once never did), and not everyone likes to have stray generated files in their source dirs.

Also Cc rust-lang#63373 rust-lang#53768 @ecstatic-morse @Mark-Simulacrum
Centril added a commit to Centril/rust that referenced this pull request Oct 21, 2019
…um,Centril

keep the root dir clean from debugging

We landed this before with rust-lang#63307 but recently in rust-lang#65630 the IMO bad ignore crept back in.

If you regularly do graphviz-based debugging and you are fine leaving junk in the rustc root dir, please configure your local `.git/info/exclude`. But most people working on rustc don't work with graphciz all that often (I for once never did), and not everyone likes to have stray generated files in their source dirs.

Also Cc rust-lang#63373 rust-lang#53768 @ecstatic-morse @Mark-Simulacrum
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants