[commit: packages/process] master, wip/issue15: Build Haddock documentation for System.Process.Internals (ef81bea)

git at git.haskell.org git at git.haskell.org
Thu Mar 19 11:36:53 UTC 2015


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

On branches: master,wip/issue15
Link       : http://ghc.haskell.org/trac/ghc/changeset/ef81bea4153b64637356c70947c67165c72747fe/process

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

commit ef81bea4153b64637356c70947c67165c72747fe
Author: Simon Hengel <sol at typeful.net>
Date:   Sat Nov 1 11:03:00 2014 +0800

    Build Haddock documentation for System.Process.Internals
    
    From my perspective the module name already clearly states that this is
    internal stuff + currently we have a 404 on Hackage for this one + I
    actually want to read the Haddocks.
    
    Fixes #7


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

ef81bea4153b64637356c70947c67165c72747fe
 System/Process/Internals.hs | 6 ++++--
 changelog.md                | 2 ++
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/System/Process/Internals.hs b/System/Process/Internals.hs
index 9dc2af7..4cf6b1a 100644
--- a/System/Process/Internals.hs
+++ b/System/Process/Internals.hs
@@ -1,5 +1,5 @@
 {-# LANGUAGE CPP, RecordWildCards, BangPatterns #-}
-{-# OPTIONS_HADDOCK hide #-}
+{-# OPTIONS_HADDOCK not-home #-}
 #ifdef __GLASGOW_HASKELL__
 {-# LANGUAGE Trustworthy #-}
 {-# LANGUAGE InterruptibleFFI #-}
@@ -15,7 +15,9 @@
 -- Stability   :  experimental
 -- Portability :  portable
 --
--- Operations for creating and interacting with sub-processes.
+-- __Note:__ This module exports internal implementation details that may
+-- change anytime.  If you want a more stable API, use "System.Process"
+-- instead.
 --
 -----------------------------------------------------------------------------
 
diff --git a/changelog.md b/changelog.md
index b361dea..86b04df 100644
--- a/changelog.md
+++ b/changelog.md
@@ -4,6 +4,8 @@
 
   * Add support for `base-4.8.0.0`
 
+  * Expose documentation for `System.Process.Internals`
+
 ## 1.2.0.0  *Dec 2013*
 
   * Update to Cabal 1.10 format



More information about the ghc-commits mailing list