please package examples

[Peter Berry]

Binary package hint: drift

Making new rules with DrIFT involves writing a file UserRules.hs, and the DrIFT documentation, instead of showing how to write such a file, points the reader to an example file in the source distribution. Unfortunately this file is not packaged in Ubuntu, so the user has to go and get the source distribution even though he already has DrIFT ready to run.

The example rule files are src/UserRule*.hs. These should be included in the binary package, or otherwise packaged separately in a -doc package (along with the other docs). Without them, the documentation is incomplete.

[Peter Berry (pwberry)]

Note that these files import a library called Pretty, but in the GHC in Ubuntu this is called Text.PrettyPrint.HughesPJ.

[Peter Berry (pwberry)]

Oh, correction: Pretty is bundled with the source. It just reimplements Text.PrettyPrint.HughesPJ, except with a couple of new combinators.

[Jérôme Guelfucci (jerome-guelfucci-deactivatedaccount)]

Thank you for your bug report. I'm marking this as confirmed.

[Cesare Tirabassi (norsetto)]

I see one directory in the source tree which explicitly contains examples: example.
In example there are the following example files:

-rw-r--r-- 1 cesare cesare 222 2002-06-13 06:11 Artifical.hs
-rw-r--r-- 1 cesare cesare 99 2002-06-13 06:11 BTree.hs
-rw-r--r-- 1 cesare cesare 1242 2002-06-13 06:11 Example.hs
-rw-r--r-- 1 cesare cesare 51 2002-06-13 06:11 Foo.lhs
-rw-r--r-- 1 cesare cesare 125 2002-06-13 06:11 Xref.hs

I don't see any guidance on where to install these files, so I'm thinking about:

/usr/share/doc/drift/example

which requires the user to set DERIVEPATH as export DERIVEPATH=$DERIVEPATH:/usr/share/doc/drift/example

Would the above be acceptable?
Can you also please clarify why we should consider the src/UserRule*.hs files as examples?

[Peter Berry (pwberry)]

You're probably right, these would make more sense. But then the docs already included in the package should be changed to point to these instead of UserRules.hs.

[Cesare Tirabassi (norsetto)]

This Feisty patch adds the following examples in /usr/share/doc/drift/example/:

Artifical.hs
BTree.hs
Example.hs
Foo.lhs
TestTerm.hs
Xref.hs

and the following UserRule files in /usr/share/doc/drift/src/:

UserRuleXml.hs
UserRuleBinary.hs
UserRuleArbitrary.hs
UserRulesGeneric.hs
UserRules.hs
UserRuleGhcBinary.hs

I have subscribed u-u-s for review. If acceptable I can propose the same patch for Gutsy.

[Peter Berry (pwberry)]

I don't have any objection to putting this patch in Gutsy.

Incidentally, ghc6-libsrc installs gzipped source files, so (if I understand this correctly) there is a precedent for not excluding them from compression. If you leave that in, you should also add .lhs since there is one in the list (Foo.lhs).

[Daniel Holbach (dholbach)]

Chris: can you take a look at this?

[Chris Cheney (ccheney)]

Since this package is unmodified from the version in Debian I have submitted a bug report in Debian BTS.

So if I understand the bug correctly UserRule*.hs needs to be included along with perhaps some pretty library file, but which one if it is needed?

Thanks,

Chris Cheney

[Scott Kitterman (kitterman)]

Unsubscribing UUS since it looks like the patch is uncertain. Please resubscribe once it's worked out.

[Daniel Holbach (dholbach)]

Marking as 'Incomplete' as questions seem to be open.

[Cesare Tirabassi (norsetto)]

drift (2.2.3-2) unstable; urgency=low

  * Added README.Debian which explains how to rebuild DrIFT in case you
    want to add your own derivation rules. (Closes: #433412)
  * Fix lintian warning "doc-base-unknown-section drift-manual:6
    Apps/Programming"
  * debian/control:
    - Let the Vcs-* fields point to the trunk branch.
    - Add doc-base to the Suggests.
  * debian/rules:
    - Remove src/Rules.hs on clean which is generated during the build.

drift (2.2.3-1) unstable; urgency=low

  * New upstream release.
  * debian/control.in: Old cruft thus removed.
  * debian/patches/10_update-autotools.dpatch: Removed.
  * debian/watch: Don't execute svn-upgrade automatically after
    downloading a new upstream version of DrIFT.

drift (2.2.1-3) unstable; urgency=low

  * debian/control:
    - Update XS-Vcs-* fields as the packages has moved to the pkg-haskell
      subversion archive.
    - Remove Hompage from the long descriptions and a the new Homepage
      field.
    - Replace Xs-Vcs-* fields for the new official Vcs-* fields.
    - Bump Standards-Version to 3.7.3. No changes needed.
  * debian/drift.doc-base:
    - Fix lintian warning doc-base-file-separator-extra-whitespaces.

 -- Ubuntu Archive Auto-Sync < <email address hidden>> Fri, 02 May 2008 01:56:56 +0100