Cabal-2.2.0.1: doc/API/Cabal/Distribution-Simple-Test-LibV09.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Distribution.Simple.Test.LibV09</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">Cabal-2.2.0.1: A framework for packaging Haskell software</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Distribution.Simple.Test.LibV09</p></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><a href="#v:runTest">runTest</a> :: <a href="Distribution-Types-PackageDescription.html#t:PackageDescription" title="Distribution.Types.PackageDescription">PackageDescription</a> -> <a href="Distribution-Types-LocalBuildInfo.html#t:LocalBuildInfo" title="Distribution.Types.LocalBuildInfo">LocalBuildInfo</a> -> <a href="Distribution-Types-ComponentLocalBuildInfo.html#t:ComponentLocalBuildInfo" title="Distribution.Types.ComponentLocalBuildInfo">ComponentLocalBuildInfo</a> -> <a href="Distribution-Simple-Setup.html#t:TestFlags" title="Distribution.Simple.Setup">TestFlags</a> -> <a href="Distribution-Types-TestSuite.html#t:TestSuite" title="Distribution.Types.TestSuite">TestSuite</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:IO" title="Distribution.Compat.Prelude.Internal">IO</a> <a href="Distribution-Simple-Test-Log.html#t:TestSuiteLog" title="Distribution.Simple.Test.Log">TestSuiteLog</a></li><li class="src short"><a href="#v:simpleTestStub">simpleTestStub</a> :: <a href="Distribution-ModuleName.html#t:ModuleName" title="Distribution.ModuleName">ModuleName</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a></li><li class="src short"><a href="#v:stubFilePath">stubFilePath</a> :: <a href="Distribution-Types-TestSuite.html#t:TestSuite" title="Distribution.Types.TestSuite">TestSuite</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:FilePath" title="Distribution.Compat.Prelude.Internal">FilePath</a></li><li class="src short"><a href="#v:stubMain">stubMain</a> :: <a href="Distribution-Compat-Prelude-Internal.html#t:IO" title="Distribution.Compat.Prelude.Internal">IO</a> [<a href="Distribution-TestSuite.html#t:Test" title="Distribution.TestSuite">Test</a>] -> <a href="Distribution-Compat-Prelude-Internal.html#t:IO" title="Distribution.Compat.Prelude.Internal">IO</a> ()</li><li class="src short"><a href="#v:stubName">stubName</a> :: <a href="Distribution-Types-TestSuite.html#t:TestSuite" title="Distribution.Types.TestSuite">TestSuite</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:FilePath" title="Distribution.Compat.Prelude.Internal">FilePath</a></li><li class="src short"><a href="#v:stubWriteLog">stubWriteLog</a> :: <a href="Distribution-Compat-Prelude-Internal.html#t:FilePath" title="Distribution.Compat.Prelude.Internal">FilePath</a> -> <a href="Distribution-Types-UnqualComponentName.html#t:UnqualComponentName" title="Distribution.Types.UnqualComponentName">UnqualComponentName</a> -> <a href="Distribution-Simple-Test-Log.html#t:TestLogs" title="Distribution.Simple.Test.Log">TestLogs</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:NoCallStackIO" title="Distribution.Compat.Prelude.Internal">NoCallStackIO</a> ()</li><li class="src short"><a href="#v:writeSimpleTestStub">writeSimpleTestStub</a> :: <a href="Distribution-Types-TestSuite.html#t:TestSuite" title="Distribution.Types.TestSuite">TestSuite</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:FilePath" title="Distribution.Compat.Prelude.Internal">FilePath</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:NoCallStackIO" title="Distribution.Compat.Prelude.Internal">NoCallStackIO</a> ()</li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:runTest" class="def">runTest</a> :: <a href="Distribution-Types-PackageDescription.html#t:PackageDescription" title="Distribution.Types.PackageDescription">PackageDescription</a> -> <a href="Distribution-Types-LocalBuildInfo.html#t:LocalBuildInfo" title="Distribution.Types.LocalBuildInfo">LocalBuildInfo</a> -> <a href="Distribution-Types-ComponentLocalBuildInfo.html#t:ComponentLocalBuildInfo" title="Distribution.Types.ComponentLocalBuildInfo">ComponentLocalBuildInfo</a> -> <a href="Distribution-Simple-Setup.html#t:TestFlags" title="Distribution.Simple.Setup">TestFlags</a> -> <a href="Distribution-Types-TestSuite.html#t:TestSuite" title="Distribution.Types.TestSuite">TestSuite</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:IO" title="Distribution.Compat.Prelude.Internal">IO</a> <a href="Distribution-Simple-Test-Log.html#t:TestSuiteLog" title="Distribution.Simple.Test.Log">TestSuiteLog</a> <a href="#v:runTest" class="selflink">#</a></p></div><div class="top"><p class="src"><a id="v:simpleTestStub" class="def">simpleTestStub</a> :: <a href="Distribution-ModuleName.html#t:ModuleName" title="Distribution.ModuleName">ModuleName</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a> <a href="#v:simpleTestStub" class="selflink">#</a></p><div class="doc"><p>Source code for library test suite stub executable</p></div></div><div class="top"><p class="src"><a id="v:stubFilePath" class="def">stubFilePath</a> :: <a href="Distribution-Types-TestSuite.html#t:TestSuite" title="Distribution.Types.TestSuite">TestSuite</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:FilePath" title="Distribution.Compat.Prelude.Internal">FilePath</a> <a href="#v:stubFilePath" class="selflink">#</a></p><div class="doc"><p>The filename of the source file for the stub executable associated with a
library <code>TestSuite</code>.</p></div></div><div class="top"><p class="src"><a id="v:stubMain" class="def">stubMain</a> :: <a href="Distribution-Compat-Prelude-Internal.html#t:IO" title="Distribution.Compat.Prelude.Internal">IO</a> [<a href="Distribution-TestSuite.html#t:Test" title="Distribution.TestSuite">Test</a>] -> <a href="Distribution-Compat-Prelude-Internal.html#t:IO" title="Distribution.Compat.Prelude.Internal">IO</a> () <a href="#v:stubMain" class="selflink">#</a></p><div class="doc"><p>Main function for test stubs. Once, it was written directly into the stub,
but minimizing the amount of code actually in the stub maximizes the number
of detectable errors when Cabal is compiled.</p></div></div><div class="top"><p class="src"><a id="v:stubName" class="def">stubName</a> :: <a href="Distribution-Types-TestSuite.html#t:TestSuite" title="Distribution.Types.TestSuite">TestSuite</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:FilePath" title="Distribution.Compat.Prelude.Internal">FilePath</a> <a href="#v:stubName" class="selflink">#</a></p><div class="doc"><p>The name of the stub executable associated with a library <code>TestSuite</code>.</p></div></div><div class="top"><p class="src"><a id="v:stubWriteLog" class="def">stubWriteLog</a> :: <a href="Distribution-Compat-Prelude-Internal.html#t:FilePath" title="Distribution.Compat.Prelude.Internal">FilePath</a> -> <a href="Distribution-Types-UnqualComponentName.html#t:UnqualComponentName" title="Distribution.Types.UnqualComponentName">UnqualComponentName</a> -> <a href="Distribution-Simple-Test-Log.html#t:TestLogs" title="Distribution.Simple.Test.Log">TestLogs</a> -> <a href="Distribution-Compat-Prelude-Internal.html#t:NoCallStackIO" title="Distribution.Compat.Prelude.Internal">NoCallStackIO</a> () <a href="#v:stubWriteLog" class="selflink">#</a></p><div class="doc"><p>From a test stub, write the <code><a href="Distribution-Simple-Test-Log.html#t:TestSuiteLog" title="Distribution.Simple.Test.Log">TestSuiteLog</a></code> to temporary file for the calling
Cabal process to read.</p></div></div><div class="top"><p class="src"><a id="v:writeSimpleTestStub" class="def">writeSimpleTestStub</a> <a href="#v:writeSimpleTestStub" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Distribution-Types-TestSuite.html#t:TestSuite" title="Distribution.Types.TestSuite">TestSuite</a></td><td class="doc"><p>library <code>TestSuite</code> for which a stub
is being created</p></td></tr><tr><td class="src">-> <a href="Distribution-Compat-Prelude-Internal.html#t:FilePath" title="Distribution.Compat.Prelude.Internal">FilePath</a></td><td class="doc"><p>path to directory where stub source
should be located</p></td></tr><tr><td class="src">-> <a href="Distribution-Compat-Prelude-Internal.html#t:NoCallStackIO" title="Distribution.Compat.Prelude.Internal">NoCallStackIO</a> ()</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Write the source file for a library <code>TestSuite</code> stub executable.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.19.0</p></div></body></html>