Add release notes about ghc-pkg change, and Cabal dep removal
authorDuncan Coutts <duncan@well-typed.com>
Thu, 28 Aug 2014 04:52:48 +0000 (05:52 +0100)
committerEdward Z. Yang <ezyang@cs.stanford.edu>
Fri, 29 Aug 2014 14:03:33 +0000 (15:03 +0100)
That ghc-pkg doesn't support single-file style databases, and that
the ghc library does not depend on Cabal any more.

We don't need to document the ghc-pkg change in the ghc-pkg section
itself, since ghc-pkg init is already described there, and that is the
right thing. The old deprecated approach was not documented.

docs/users_guide/7.10.1-notes.xml

index 0af4c31..404d239 100644 (file)
            </listitem>
        </itemizedlist>
     </sect3>
+
+    <sect3>
+        <title>Package system</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    TODO: cover module renaming, thinning, re-export etc
+               </para>
+            </listitem>
+            <listitem>
+                <para>
+                    ghc-pkg (and ghc) have dropped support for single-file style
+                    package databases. Since version 6.12, ghc-pkg has defaulted
+                    to a new database format (using a directory of files, one per
+                    package plus a binary cache).
+               </para>
+               <para>
+                    This change will not affect programs and scripts that use
+                    <literal>ghc-pkg init</literal> to create package databases.
+               </para>
+               <para>
+                    This will affect scripts that create package databases
+                    using tricks like
+<programlisting>
+echo "[]" > package.conf
+</programlisting>
+                    Such scripts will need to be modified to use
+                    <literal>ghc-pkg init</literal>, and to delete databases
+                    by directory removal, rather than simple file delete.
+               </para>
+           </listitem>
+       </itemizedlist>
+    </sect3>
   </sect2>
 
   <sect2>
                     package ID.
                </para>
            </listitem>
+            <listitem>
+                <para>
+                    The ghc library no longer depends on the Cabal library. This means
+                    that users of the ghc library are no longer forced to use the same
+                    version of Cabal as ghc did. It also means that Cabal is freed up
+                    to be able to depend on packages that ghc does not want to depend
+                    on (which for example may enable improvements to Cabal's parsing
+                    infrastructure).
+               </para>
+           </listitem>
        </itemizedlist>
     </sect3>