Skip to content

Commit

Permalink
git-hooks: fix symbolic link command in README.rst
Browse files Browse the repository at this point in the history
The symbolic linking command previously used resulted in broken relative
links. Updated the instructions to use $PWD when creating the symbolic
links to git hooks to avoid this.
  • Loading branch information
jtriley committed Mar 26, 2012
1 parent 4f51c02 commit 3d1600c
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions git-hooks/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,23 @@
Using StarCluster Git Hooks
###########################
To enable StarCluster's git hooks that perform PEP8 formatting and pyflakes
validation::
validation prior to committing::

1. Check out the StarCluster repo::

1. First check out the repo::
$ git clone https://github.com/jtriley/StarCluster.git

2. Next change the current working directory to the root of the repo::

$ cd StarCluster
3. Install both ``pep8`` and ``pyflakes`` packages from PYPI::

3. Make symbolic links to the hooks in your ``<repo>/.git/hooks`` directory::

$ ln -s $PWD/git-hooks/pre-commit $PWD/.git/hooks/pre-commit

4. Install both ``pep8`` and ``pyflakes`` packages from PYPI::

$ easy_install pep8 pyflakes
4. Make symbolic links to the hooks in your ``<repo>/.git/hooks`` directory::
$ ln -s git-hooks/pre-commit .git/hooks/pre-commit

Now whenever you run ``git commit`` both PEP8 and PyFlakes will check the files
to be committed for errors, e.g.::
Expand Down

0 comments on commit 3d1600c

Please sign in to comment.