[commit: haddock] master: Refine hacking instructions slightly (a65953d)

git at git.haskell.org git at git.haskell.org
Wed Jul 8 08:39:05 UTC 2015


Repository : ssh://git@git.haskell.org/haddock

On branch  : master
Link       : http://git.haskell.org/haddock.git/commitdiff/a65953de929fd9488250f8e0257c918465193e43

>---------------------------------------------------------------

commit a65953de929fd9488250f8e0257c918465193e43
Author: Mateusz Kowalczyk <fuuzetsu at fuuzetsu.co.uk>
Date:   Mon Jun 8 15:08:36 2015 +0100

    Refine hacking instructions slightly


>---------------------------------------------------------------

a65953de929fd9488250f8e0257c918465193e43
 README.md | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index f6dd00d..31015e9 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,8 @@ Please create issues when you have any problems and pull requests if you have so
 
 ###### Hacking
 
-To get started you'll need a latest GHC release installed.
+To get started you'll need a latest GHC release installed. Below is an
+example setup using cabal sandboxes.
 
 ```bash
   git clone https://github.com/haskell/haddock.git
@@ -64,5 +65,8 @@ To get started you'll need a latest GHC release installed.
   cabal test
 ```
 
-If you want to build against `GHC HEAD`, `ghc-head` is the corresponding branch.
-Note that it doesn't have to be up to date. 
+If you're a GHC developer and want to update Haddock to work with your
+changes, you should be working on `ghc-head` branch instead of master.
+See instructions at
+https://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/Git/Submodules
+for an example workflow.



More information about the ghc-commits mailing list