[Pkg-haskell-commits] darcs: policy: manpages/documentation

[Ian Lynagh]

Sun Sep  5 21:36:20 UTC 2004  Ian Lynagh <igloo at earth.li>
  * manpages/documentation

    M ./haskell-policy.sgml -1 +29

Sun Sep  5 21:36:20 UTC 2004  Ian Lynagh <igloo at earth.li>
  * manpages/documentation
diff -rN -u old-policy/haskell-policy.sgml new-policy/haskell-policy.sgml
--- old-policy/haskell-policy.sgml	2010-11-05 15:02:44.005675293 +0000
+++ new-policy/haskell-policy.sgml	2010-11-05 15:02:44.013675716 +0000
@@ -1,6 +1,6 @@
 <!doctype debiandoc public "-//DebianDoc//DTD DebianDoc//EN"
 [
-<!entity version "0.1.2">
+<!entity version "0.1.3">
 <!entity must      "<em>must</em>">
 <!entity mustnot   "<em>must not</em>">
 <!entity should    "<em>should</em>">
@@ -299,6 +299,28 @@
             reverse dependencies, too. However, you can upload libraries
             built against unreleased compilers to &haskellunsafe;.
         </p>
+
+        <p>
+            For each cabal package <filename>cp</filename>, a manual
+            page <filename>cp.3haskell</filename> describing the purpose
+            of the package and the list of modules it includes &should;
+            be installed into <filename>/usr/share/man/man3</filename>.
+            Additionally, for each module
+            <filename>Hierarchial.Module</filename>, a manual page
+            <filename>cp.Hierarchial.Module.3haskell</filename>
+            dsecribing the purpose and interface of the module &should;
+            be installed into <filename>/usr/share/man/man3</filename>.
+            XXX We'd like to mention haddock here, but it can't output
+            manual pages yet, can it?
+        </p>
+
+        <p>
+            Additionally, you &should; provide documentation in other
+            formats such as, but not limited to, plain text and HTML in
+            <filename>/usr/share/doc/package</filename>. It is expected
+            that most libraries will provide documentation in the form
+            accepted by haddock, making this easy.
+        </p>
     </chapt>
 
     <chapt id="programs">
@@ -314,6 +336,12 @@
             your package should build-depend on suitable compilers,
             prefering those that produce better code.
         </p>
+
+        <p>
+            As normal, each executable should install a Manual page with
+            the extension <filename>.1</filename> into
+            <filename>/usr/share/man/man1</filename>.
+        </p>
     </chapt>
 
     <chapt id="testsuites">