Add miscellaneous, minor revision
authorAndrey Mokhov <andrey.mokhov@gmail.com>
Sat, 14 May 2016 17:33:55 +0000 (18:33 +0100)
committerAndrey Mokhov <andrey.mokhov@gmail.com>
Sat, 14 May 2016 17:33:55 +0000 (18:33 +0100)
[skip ci]

doc/user-settings.md

index e395ea2..dc718ed 100644 (file)
@@ -81,11 +81,11 @@ integerLibrary = integerGmp
 ```\r
 ## Build ways\r
 \r
-Libraries can be built in a number of ways, such as `vanilla`, `profiling` (with \r
-profiling information enabled), and many others as defined in `src/Way.hs`. To\r
-control which ways particular ways are built, set `userLibraryWays` and\r
-`userRtsWays`. As an example, below we remove `dynamic` from the list of library\r
-ways and keep `rts` package ways unchanged:\r
+Packages can be built in a number of ways, such as `vanilla`, `profiling` (with \r
+profiling information enabled), and many others as defined in `src/Way.hs`. You\r
+can change the default build ways using `userLibraryWays` and `userRtsWays` settings.\r
+As an example, below we remove `dynamic` from the list of library ways but keep\r
+`rts` package ways unchanged:\r
 ```haskell\r
 -- | Control which ways library packages are built.\r
 userLibraryWays :: Ways\r
@@ -99,9 +99,8 @@ userRtsWays = mempty
 ## Verbose command lines \r
 \r
 By default Hadrian does not print full command lines during the build process\r
-and instead prints short human readable digests for each executed command. It is\r
-possible to suppress this behaviour completely or partially using\r
-`verboseCommands` setting:\r
+and instead prints short human readable digests for each executed command. You\r
+can suppress this behaviour completely or partially using `verboseCommands` setting:\r
 ```haskell\r
 -- | Set to True to print full command lines during the build process. Note,\r
 -- this is a Predicate, hence you can enable verbose output for a chosen package\r
@@ -129,3 +128,19 @@ verboseCommands = file "//rts/sm/*" &&^ way threaded
 -- Print all commands:\r
 verboseCommands = return True\r
 ```\r
+\r
+## Miscellaneous\r
+\r
+Use the following settings to change the default behaviour of Hadrian with respect\r
+to building split objects and Haddock documentation.\r
+\r
+```haskell\r
+-- | Control when split objects are generated. Note, due to the GHC bug #11315\r
+-- it is necessary to do a full clean rebuild when changing this option.\r
+splitObjects :: Predicate\r
+splitObjects = (return cmdSplitObjects) &&^ defaultSplitObjects\r
+\r
+-- | Control when to build documentation.\r
+buildHaddock :: Predicate\r
+buildHaddock = return cmdBuildHaddock\r
+```\r