-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
Mention git hooks in install documentation #5647
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -174,13 +174,31 @@ step by: | |
$ python setupegg.py develop | ||
|
||
This creates links in the right places and installs the command line script to | ||
the appropriate places. Then, if you want to update your IPython at any time, | ||
the appropriate places. | ||
|
||
Then, if you want to update your IPython at any time, | ||
just do: | ||
|
||
.. code-block:: bash | ||
|
||
$ git pull | ||
|
||
IPython now uses git submodules to ship its javascript dependencies. If you run | ||
IPython from git master, you may need to update submodules once in a while with: | ||
|
||
.. code-block:: bash | ||
|
||
$ git submodule update | ||
|
||
or | ||
|
||
.. code-block:: bash | ||
|
||
$ 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Prompted by #5587 there seem to be There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @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. |
||
|
||
Basic optional dependencies | ||
=========================== | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to your
.git/hooks/
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Carreau Yes, sure. Will fix it, thanks!