Difference between revisions of "Haskell Platform"

From HaskellWiki
Jump to: navigation, search
(Adding ideas about test suite)
m (Changed link to haskell platform documentation - original link returned 404)
 
(72 intermediate revisions by 15 users not shown)
Line 1: Line 1:
'''Haskell: Batteries Included'''
 
  +
{{HP}}
   
__NOTOC__
 
  +
The Haskell Platform is a single, standard [[Haskell]] development environment for everyone. It offers a set of blessed libraries and tools, to save you the task of picking and choosing which core Haskell libraries to use.
   
The Haskell Platform (HP) is the name of a new "blessed" library suite on which to build further Haskell libraries and applications, by taking the best libraries from the nearly 800 libraries of [http://hackage.haskell.org haskell.org]. It provides a comprehensive, stable and quality tested base for Haskell projects to work from.
 
  +
[http://haskell.org/platform/contents.html Learn more about the Haskell Platform ⇒]
   
[[Image:Small-package-bubbles.png|Libraries in the platform, with area based on number of libraries that depend on it]] [[Image:Haskell-graph.png|Graph of library dependencies. The platform is the center of the graph]]
 
  +
__TOC__
   
The first image is a
 
  +
== What's in the platform ==
[http://blog.well-typed.com/wp-content/uploads/2008/09/package-sizes-all-crop.png bubble graph of hackage], with the "platform" indicated, to give a visual sense
 
of how the platform relates to the rest of hackage. The second image
 
shows a [http://galois.com/~dons/tmp/hackage.png graph of hackage dependencies], with a circle drawn around the densest part of the graph,
 
to give an idea of how the platform satisfies a large proportion of
 
dependencies.
 
   
== Resources ==
 
  +
See the [https://www.haskell.org/downloads/#platform Haskell Platform documentation] on [https://www.haskell.org haskell.org].
   
* '''[http://code.haskell.org/haskell-platform Haskell Platform project repository]'''
 
* '''[http://trac.haskell.org/haskell-platform/ Project bug tracker]''': candidates for inclusion
 
* '''[[/FAQ]]'''
 
   
== Community ==
+
== Trouble shooting ==
   
* Mailing list: libraries @ haskell.org
 
  +
Report bugs on GitHub:
* IRC channel: #ghc @ freenode.org
 
  +
[https://github.com/haskell/haskell-platform/issues Haskell Platform Issues].
   
== Documentation ==
 
   
* [http://cgi.cse.unsw.edu.au/~dons/blog/2008/07/29#batteries The Haskell Platform Proposal] for the 2008 Haskell Symposium
 
  +
=== Developers ===
* [http://blog.well-typed.com/2008/09/slides-from-the-haskell-platform-talk/ Slides from the Haskell Platform talk]
 
* [http://blog.well-typed.com/2008/09/hackage-hacking-and-demo/ Haskell Platform discussion]
 
* Bryan O'Sullivan's [http://www.serpentine.com/blog/2008/09/26/some-notes-on-the-future-of-haskell-and-fp/ writeup] of the future of Haskell discussion
 
* [http://thread.gmane.org/gmane.comp.lang.haskell.cvs.ghc/28062/focus=28807 A discussion] took place in June and July 2008 about the direction of the HLP.
 
* [http://haskell.org/~duncan/ghc/%23ghc-2008-07-16.log More occurred during the #ghc meeting]
 
   
===Quality Control===
 
  +
* New [https://github.com/haskell/haskell-platform/wiki/ Haskell Platform Wiki]
  +
* Old [http://trac.haskell.org/haskell-platform/ Trac wiki]
   
Inclusion or exclusion in the platform will be driven by metrics, objective measurements we can extract from code. Determining appropriate metrics is a milestone.
 
  +
== Buttons ==
   
* cabal-installable libraries with haddocks.
 
  +
We have some buttons to let your friends know about the Haskell Platform.
* The set of HP packages + core libs must be closed. In other words, all haskell dependencies must be from within the HP packages or core libs. Dependencies on C libs can be external.
 
* All packages in a particular HP version must have a consistent install plan.
 
   
That means only one version of each package and all dependencies on packages must be satisfied by the version in the HP package set.
 
  +
[http://haskell.org/platform http://raw.githubusercontent.com/haskell/haskell-platform/master/website/icons/button-100.png]
   
There is code in cabal-install to check the last two requirements.
 
  +
Use this html in your site:
   
Other possible ideas for quality standards we might want to require:
 
  +
<code>
  +
<nowiki>
  +
<a href="http://haskell.org/platform">
  +
<img src="http://raw.githubusercontent.com/haskell/haskell-platform/master/website/icons/button-100.png"></a>
  +
</nowiki>
  +
</code>
   
* Uses base library types, to force API standardisation
 
  +
[http://haskell.org/platform http://raw.githubusercontent.com/haskell/haskell-platform/master/website/icons/button-64.png]
* exposed module names must follow the hierarchical module name convention, meaning they must be in an appropriate place in the module namespace. In particular, no clash of module names should occur within the HP.
 
   
=== Other heuristics ===
 
  +
Use this html in your site:
   
Packages set for inclusion should:
 
  +
<code>
  +
<nowiki>
  +
<a href="http://hackage.haskell.org/platform">
  +
<img src="http://raw.githubusercontent.com/haskell/haskell-platform/master/website/icons/button-64.png"></a>
  +
</nowiki>
  +
</code>
   
* Have a maintainer
 
  +
SVG source for the button: http://haskell.org/haskellwiki/Image:Button.svg
* Have a bug tracker
 
* Use the correct versioning
 
* Build with cabal
 
* Work on all arches.
 
   
Further goals:
 
   
* -Wall clean
 
  +
=== Icons ===
* 100% coverage
 
* Have real world use.
 
* Answer a notable set of build dependencies.
 
* Have a declared correctness test suite.
 
* Have a declared performance test suite.
 
   
== Distribution format ==
 
  +
Icons for the platform installer and desktop.
   
* Source distribution
 
  +
[[Image:Platform-100.png]]
* .tar.gz bundle compatible with extra-libs
 
* Windows Installed
 
* Native distro packages
 
   
The HP will be the first '''meta-package''' on hackage, that depends on the platform library set. With this,
 
  +
[[Image:Platform-64.png]]
   
cabal install haskell-platform
 
   
will be possible.
 
  +
=== Legal ===
   
== Version policy ==
 
  +
* The cherry blossom image used in the 2011 HP release is [http://www.flickr.com/photos/28481088@N00/3291086383/ licensed CC by tanakawho]
   
yyyy.major.minor,
 
   
* odd major numbers indicate unstable branches
 
  +
[[Category:HaskellPlatform]]
* minor numbers indicate bug fixes only, no API changes.
 
 
Examples:
 
 
* 2008.0.0 -- first biannual major stable release
 
* 2008.0.1 -- minor release, bug fix only
 
* 2008.1 -- unstable branch leading to next major release
 
* 2008.2.0 -- second annual major release, API changes
 
* 2008.2.1 -- bug fixes
 
* 2008.3 -- unstable branch of 2008
 
* 2009.0.0 -- first release in 2009.
 
 
Additionally, if a library is accepted into the platform, it is suggested its version number be lifted to 1.0, if not already at 1.0.
 
 
== Licenses ==
 
 
The initial release is expected to include only BSD3 licensed software.
 
 
== Programs ==
 
 
The platform includes programs, such as haddock or cabal-install.
 
These aren't nicely tracked from the cabal meta package yet.
 
 
== Build system ==
 
 
Two ways to build the bundle:
 
 
* generate a sh script from the .cabal file
 
 
Or, build cabal-install, have the components of the platform
 
as a mini, local hackage archive, and then ask cabal install to satisfy
 
and install the dependencies from the platform meta-cabal file.
 
 
== Related projects ==
 
 
* [http://docs.python.org/lib/lib.html Python libraries]
 
* [http://live.gnome.org/ReleasePlanning Gnome's release process]
 
* [http://live.gnome.org/ReleasePlanning/ModuleProposing How to propose modules for GNOME]
 
* [http://forge.ocamlcore.org/projects/batteries/ OCaml Batteries]
 
 
== Developers ==
 
 
Haskell Platform core team:
 
 
* Duncan Coutts (Well Typed)
 
* Don Stewart (Galois)
 
 
[[Category:Community]]
 

Latest revision as of 13:28, 21 January 2020

Platform.png
The Haskell Platform


The Haskell Platform is a single, standard Haskell development environment for everyone. It offers a set of blessed libraries and tools, to save you the task of picking and choosing which core Haskell libraries to use.

Learn more about the Haskell Platform ⇒

What's in the platform

See the Haskell Platform documentation on haskell.org.


Trouble shooting

Report bugs on GitHub: Haskell Platform Issues.


Developers

Buttons

We have some buttons to let your friends know about the Haskell Platform.

button-100.png

Use this html in your site:

<a href="http://haskell.org/platform"> <img src="http://raw.githubusercontent.com/haskell/haskell-platform/master/website/icons/button-100.png"></a>

button-64.png

Use this html in your site:

<a href="http://hackage.haskell.org/platform"> <img src="http://raw.githubusercontent.com/haskell/haskell-platform/master/website/icons/button-64.png"></a>

SVG source for the button: http://haskell.org/haskellwiki/Image:Button.svg


Icons

Icons for the platform installer and desktop.

Platform-100.png

Platform-64.png


Legal