Mention git hooks in install documentation #5647
Conversation
|
I think this statement is too strong. You do not have to copy the git hooks, and it's perfectly reasonable not to. It's just a convenient way to check out submodules. For instance, if you are working on the submodules, the git hooks can get pretty annoying. |
|
@minrk I add instead sentence from the bottom of the main README.md file. Hope now it's more clear. |
| $ python setup.py submodule | ||
|
|
||
| Another option is to copy `git hooks <https://github.com/ipython/ipython/tree/master/git-hooks>`_ | ||
| to your ``./git`` directory to ensure that your submodules are up to date on each pull. |
There was a problem hiding this comment.
@Carreau Yes, sure. Will fix it, thanks!
|
|
||
| Another option is to copy `git hooks <https://github.com/ipython/ipython/tree/master/git-hooks>`_ | ||
| to your ``./git/hooks/`` directory to ensure that your submodules are up to date on each pull. | ||
|
|
There was a problem hiding this comment.
Prompted by #5587 there seem to be git-hoooks/install-hooks.sh do you want to mention it too ?
There was a problem hiding this comment.
@Carreau It's convenient, but not really necessary (simple copying will do the same). There is already quite a lot of details in this section, so I wouldn't add more.
|
Fair enough. +1 for me. |
Mention git hooks in install documentation
|
Thanks ! |
This addition is done to avoid problems similar to #5355
This addition is done to avoid problems similar to #5355
Mention git hooks in install documentation
This addition is done to avoid problems similar to #5355