[commit: packages/Cabal] ghc-head: Revert "Add basic sandbox documentation" (aa0bd25)

git at git.haskell.org git at git.haskell.org
Wed Sep 4 23:58:28 CEST 2013


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

On branch  : ghc-head
Link       : http://git.haskell.org/?p=packages/Cabal.git;a=commit;h=aa0bd25a930dc7d61dc3b133bee1c64238e36d36

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

commit aa0bd25a930dc7d61dc3b133bee1c64238e36d36
Author: Mikhail Glushenkov <the.dead.shall.rise at gmail.com>
Date:   Sun Sep 1 00:54:40 2013 +0200

    Revert "Add basic sandbox documentation"
    
    This reverts commit 6bfb5a200c2202baa313903c95ced835316b23aa.
    
    The sandbox feature is already documented (see #1430).
    Additionally, the documentation added in this commit is misleading:
    'runhaskell Setup.hs sandbox CMD' doesn't work.


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

aa0bd25a930dc7d61dc3b133bee1c64238e36d36
 Cabal/doc/installing-packages.markdown |   39 --------------------------------
 1 file changed, 39 deletions(-)

diff --git a/Cabal/doc/installing-packages.markdown b/Cabal/doc/installing-packages.markdown
index c6d5528..909644b 100644
--- a/Cabal/doc/installing-packages.markdown
+++ b/Cabal/doc/installing-packages.markdown
@@ -928,45 +928,6 @@ This command takes the following option:
 :   Append today's date (in "YYYYMMDD" format) to the version number for
     the generated source package.  The original package is unaffected.
 
-## setup sandbox ##
-
-By default, any dependencies of the package are installed into the
-global or user package databases (e.g. using `cabal install
---only-dependencies`). If you're building several different packages
-that have incompatible dependencies, this can cause the build to fail.
-By installing all dependencies in a package database specific to each
-sandbox, these problems can be avoided.
-
-Typical usage:
-
-~~~~~~~~~~~~~~~~
-runhaskell Setup.hs sandbox init  # only once per directory
-runhaskell Setup.hs configure
-runhaskell Setup.hs build
-~~~~~~~~~~~~~~~~
-
-### setup sandbox init ###
-
-Create a sandbox. This command only needs to be run once per build
-directory (i.e. the directory in which the `.cabal` file resides).
-
-### setup sandbox delete ###
-
-Delete the sandbox and all package's installed into it.
-
-### setup sandbox add-source ###
-
-Make package source directory available to the sandbox. This lets you
-depend on yet unreleased packages while developing your current
-package.
-
-Example usage:
-
-~~~~~~~~~~~~~~~~
-runhaskell Setup.hs sandbox add-source ../otherpkg
-runhaskell Setup.hs configure
-~~~~~~~~~~~~~~~~
-
 
 [dist-simple]:  ../libraries/Cabal/Distribution-Simple.html
 [dist-make]:    ../libraries/Cabal/Distribution-Make.html





More information about the ghc-commits mailing list