From 2640162cda31ba3ab16a3ade9badc4d508b468d6 2014-05-07 20:05:28
From: Thomas Kluyver <takowl@gmail.com>
Date: 2014-05-07 20:05:28
Subject: [PATCH] Backport PR #5647: Mention git hooks in install documentation

This addition is done to avoid problems similar to #5355

---

diff --git a/docs/source/install/install.rst b/docs/source/install/install.rst
index b8c4617..4ec5ff3 100644
--- a/docs/source/install/install.rst
+++ b/docs/source/install/install.rst
@@ -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/hooks/`` directory to ensure that your submodules are up to date on each pull.
+
 
 Basic optional dependencies
 ===========================