gitignore settings files for Eclipse IDE

[jdlh]

BPO	29510
Nosy	@methane, @berkerpeksag, @JDLH
PRs	bpo-29548: Recommend PyObject_Call APIs over PyEval_Call APIs. #75 Add Pycharm's .idea directory to gitignore #6 Add .idea and .iml to .gitignore #1764

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2017-02-09.09:26:23.740>
created_at = <Date 2017-02-09.08:24:53.739>
labels = ['type-feature', '3.7']
title = 'gitignore settings files for Eclipse IDE'
updated_at = <Date 2017-05-24.17:24:05.617>
user = 'https://github.com/JDLH'

bugs.python.org fields:

activity = <Date 2017-05-24.17:24:05.617>
actor = 'gfyoung'
assignee = 'none'
closed = True
closed_date = <Date 2017-02-09.09:26:23.740>
closer = 'berker.peksag'
components = []
creation = <Date 2017-02-09.08:24:53.739>
creator = 'JDLH'
dependencies = []
files = []
hgrepos = []
issue_num = 29510
keywords = []
message_count = 8.0
messages = ['287388', '287389', '287391', '287392', '287393', '287395', '287396', '287454']
nosy_count = 3.0
nosy_names = ['methane', 'berker.peksag', 'JDLH']
pr_nums = ['75', '6', '1764']
priority = 'normal'
resolution = 'rejected'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue29510'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6', 'Python 3.7']

[jdlh]

The Eclipse IDE, and its relatives pydev and LiClipse, store settings in the root of a repository. It would be nice for the master .gitignore file to ignore these files, so that individual developers don't have to do this.

I am preparing a GitHub Pull Request that fixes this issue. It is a matter of adding 4 lines to the top-level .gitignore file.

[jdlh]

A fix is in GitHub cpython PR #75.

[jdlh]

I'm now looking at cpython as retrieved from Mercurial by Eclipse. It appears to be concerned by the presence of
.project
which is also an Eclipse settings file.

It might be reasonable to extend the scope of this issue to include telling Mercurial to ignore settings files. My pull request does not do this, because I haven't yet learned the right Mercurial action.

[methane]

We'll move to github soon. So no need for caring hgignore.

While there is .vscode in gitignore already, I'm not fan of
adding hundreds of IDE specific rule to gitignore.
Why don't you use gitignore_global?

[jdlh]

gitignore_global is a great idea. I had not heard of it before.

But here it is: https://help.github.com/articles/ignoring-files/ . This instruction also has a link to a gist with a lot of helpful global ignores.

I understand your reluctance to add entries for every IDE. Maybe a better solution would be to add something to the devguide about excluding IDE settings files, with a link to the Github instructions.

[berkerpeksag]

Thanks for the report and for the patch, Jim! I agree with Inada. global_gitignore is a better way to achieve this.

Maybe a better solution would be to add something to the devguide about
excluding IDE settings files, with a link to the Github instructions.

Our goal is to only cover CPython specific topics in devguide. There a lot of things that can be mentioned in devguide, but it would be hard to maintain all these information and keep devguide short at same time :)

[methane]

I agree with Berker.

But some git/github tips are very useful for CPython core developers while they aren't CPython specific.
And some of them are not in beginner's guide.

I think it's worth enough to add link to such tips.

• Use gitignore_global to ignore IDE/Editor specific files: https://help.github.com/articles/ignoring-files/
• Checkout pull request without adding remote: https://help.github.com/articles/checking-out-pull-requests-locally/
• Readable patch by git diff --indent-heuristic (git 2.11+) or --compact-heuristic (git 2.9+).
• Creating lightweight working tree by git-new-workdir (like hg share):
  https://github.com/git/git/blob/master/contrib/workdir/git-new-workdir

[jdlh]

I have set up a global gitignore, and it works for me.
% git config --global core.excludesfile ~/.gitignore_global
(Amusingly, I had _already- set a global gitignore, but I had forgotten it existed, and it didn't ignore these IDE files.)

I agree that we should not put IDE entries in the CPython .gitignore.

I also think it's a good idea to add the points Inada mentions in the developer doc somewhere. That should include the Git global ignore idea. I see Berker's point that the Devguide shouldn't get too big, but it also shouldn't leave out useful information. There's a balance to strike.

I think that's the topic of a different issue, however. I'll open that when I get back to this.

In the meantime, if someone searches the issue database for "gitignore", they will find this discussion. That's helpful.

Thank you both for your responses, Inada and Berker.