[commit: ghc] wip/nfs-locking: Unix line endings, match Haddock comments in Settings/User.hs (3ff4183)

[git at git.haskell.org]

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

On branch  : wip/nfs-locking
Link       : http://ghc.haskell.org/trac/ghc/changeset/3ff4183c5741ca780fb4e4b7274b7d951430fdde/ghc

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

commit 3ff4183c5741ca780fb4e4b7274b7d951430fdde
Author: Andrey Mokhov <andrey.mokhov at gmail.com>
Date:   Sun May 15 00:11:25 2016 +0100

    Unix line endings, match Haddock comments in Settings/User.hs
    
    [skip ci]


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

3ff4183c5741ca780fb4e4b7274b7d951430fdde
 doc/user-settings.md | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/doc/user-settings.md b/doc/user-settings.md
index dc718ed..e6b81f8 100644
--- a/doc/user-settings.md
+++ b/doc/user-settings.md
@@ -8,7 +8,7 @@ You can customise Hadrian by specifying user build settings in file
 Hadrian puts build results into `_build` directory by default, which is
 specified by `buildRootPath`:
 ```haskell
--- | All build artefacts are stored in 'buildRootPath' directory.
+-- | All build results are put into 'buildRootPath' directory.
 buildRootPath :: FilePath
 buildRootPath = "_build"
 ```
@@ -22,7 +22,7 @@ affected build rules during the next build, without requiring a full rebuild.
 For example, here is how to pass an extra argument `-O0` to all invocations of
 GHC when compiling package `cabal`:
 ```haskell
--- | Control user-specific command line arguments.
+-- | Modify default build command line arguments.
 userArgs :: Args
 userArgs = builder Ghc ? package cabal ? arg "-O0"
 ```
@@ -52,7 +52,7 @@ To add or remove a package from a particular build stage, use `userPackages`. As
 an example, below we add package `base` to Stage0 and remove package `haskeline`
 from Stage1:
 ```haskell
--- | Control which packages get to be built.
+-- | Modify the set of packages that are built by default in each stage.
 userPackages :: Packages
 userPackages = mconcat
     [ stage0 ? append [base]
@@ -61,7 +61,7 @@ userPackages = mconcat
 If you are working on a new GHC package you need to let Hadrian know about it
 by setting `userKnownPackages`:
 ```haskell
--- | Add new user-defined packages.
+-- | Add user defined packages. Don't forget to add them to 'userPackages' too.
 userKnownPackages :: [Package]
 userKnownPackages = [myPackage]
 
@@ -73,9 +73,9 @@ Note, you will also need to add `myPackage` to a specific build stage by modifyi
 `userPackages` as otherwise it will not be built.
 
 You can choose which integer library to use when builing GHC by setting
-`integerLibrary`:
+`integerLibrary`. Possible values are: `integerGmp` (default) and `integerSimple`.
 ```haskell
--- | Choose the integer library: integerGmp or integerSimple.
+-- | Choose the integer library: 'integerGmp' or 'integerSimple'.
 integerLibrary :: Package
 integerLibrary = integerGmp
 ```
@@ -87,11 +87,11 @@ can change the default build ways using `userLibraryWays` and `userRtsWays` sett
 As an example, below we remove `dynamic` from the list of library ways but keep
 `rts` package ways unchanged:
 ```haskell
--- | Control which ways library packages are built.
+-- | Modify the set of ways in which library packages are built.
 userLibraryWays :: Ways
 userLibraryWays = remove [dynamic]
 
--- | Control which ways the 'rts' package is built.
+-- | Modify the set of ways in which the 'rts' package is built.
 userRtsWays :: Ways
 userRtsWays = mempty
 ```
@@ -103,8 +103,8 @@ and instead prints short human readable digests for each executed command. You
 can suppress this behaviour completely or partially using `verboseCommands` setting:
 ```haskell
 -- | Set to True to print full command lines during the build process. Note,
--- this is a Predicate, hence you can enable verbose output for a chosen package
--- only, e.g.: verboseCommands = package ghcPrim
+-- this is a Predicate, hence you can enable verbose output only for certain
+-- targets, e.g.: @verboseCommands = package ghcPrim at .
 verboseCommands :: Predicate
 verboseCommands = return False
 ```
@@ -140,7 +140,7 @@ to building split objects and Haddock documentation.
 splitObjects :: Predicate
 splitObjects = (return cmdSplitObjects) &&^ defaultSplitObjects
 
--- | Control when to build documentation.
+-- | Control when to build Haddock documentation.
 buildHaddock :: Predicate
 buildHaddock = return cmdBuildHaddock
 ```