darcs

Issue 1312 build dependencies should be specified properly

Title build dependencies should be specified properly
Priority wishlist Status resolved
Milestone 2.3.x Resolved in
Superseder Nosy List darcs-devel, dmitry.kurochkin, fx, kowey, thorkilnaur, twb
Assigned To twb
Topics Confirmed, Documentation

Created on 2009-01-11.18:11:42 by fx, last changed 2010-06-15.21:51:39 by admin.

Messages
msg7045 (view) Author: fx Date: 2009-01-11.18:11:39
I've just had a struggle to build darcs for the first time in a while.
It would be helpful to have a proper list of requirements documented
either in the manual (maybe not so good if you can't build the manual)
or in README, or at least on the web page.

The major difficulty I had was getting the required version of
Quickcheck (on Ubuntu 8.04/8.10, for what it's worth).  However, I think
there are other things you need which I already had installed from
previous goes, but which aren't listed.
msg7209 (view) Author: twb Date: 2009-01-26.08:16:10
On Sun, Jan 11, 2009 at 07:11:39AM +0000, Dave Love wrote:
> It would be helpful to have a proper list of requirements documented
> either in the manual (maybe not so good if you can't build the manual)
> or in README, or at least on the web page.

This information is codified in darcs.cabal, by the build-depends:
entries.  It is not easy to read this file unless you already have
some cabal-fu, so I agree that this should be addressed.

> The major difficulty I had was getting the required version of
> Quickcheck (on Ubuntu 8.04/8.10, for what it's worth).

Fortunately this is not longer a problem in the Darcs 2.2.0 release,
as the optional QuickCheck dependency (which is only useful for
developers) is now truly optional.  Sorry about the inconvenience
there.
msg7257 (view) Author: fx Date: 2009-02-01.19:05:56
Trent Buck <bugs@darcs.net> writes:

> This information is codified in darcs.cabal, by the build-depends:
> entries.  It is not easy to read this file unless you already have
> some cabal-fu, so I agree that this should be addressed.

I don't know cabal, but as far as I remember, that was a problematic
dependency anyhow.

I'm now a bit confused about what actually worked on my Ubuntu 8.04
system since I messed it up trying to install the latest ghc, but I
think I had to import packages from the 8.10 version to build darcs
recently.  That's doubtless not your problem, but it's probably a useful
sort of thing to document.  If it's useful, I can purge everything and
check.
msg7790 (view) Author: twb Date: 2009-05-07.02:49:28
The following patch updated the status of issue1312 to be resolved:

* Resolve issue1312: update and reduce build notes. 
Ignore-this: 1097926092b457e090ad4870aedb4cc9
Recommend using pre-built binaries, or cabal-install.
Explain how to use cabal without cabal-install.
Update the list of build dependencies.
Keep the dependency list (against my better judgement), but be very
clear that this list is only a copy, and will grow stale over time.

Explain autotools, but mention that it is deprecated.
Remove lengthy discussion of Windows madness, on the basis that
Windows users will generally use pre-built binaries or cabal-install.

Remove out-of-place, stale-ish "darcs send" discussion.  It can be
reinserted elsewhere if it's really necessary (a HACKING file in the
source tree would be easier to discover).
History
Date User Action Args
2009-01-11 18:11:42fxcreate
2009-01-26 08:16:14twbsettopic: + Confirmed
status: unread -> unknown
messages: + msg7209
nosy: + twb
2009-01-26 08:16:21twbsetassignedto: twb
nosy: kowey, fx, simon, twb, thorkilnaur, dmitry.kurochkin
2009-02-01 19:05:59fxsetnosy: kowey, fx, simon, twb, thorkilnaur, dmitry.kurochkin
messages: + msg7257
2009-04-09 12:02:10koweysetpriority: wishlist
nosy: kowey, fx, simon, twb, thorkilnaur, dmitry.kurochkin
topic: + Target-2.3
title: build dependencies should be specified properly -> documentation: build dependencies should be specified properly
2009-04-09 16:08:24koweysetnosy: kowey, fx, simon, twb, thorkilnaur, dmitry.kurochkin
title: documentation: build dependencies should be specified properly -> docs: build dependencies should be specified properly
2009-04-09 16:09:12koweylinkissue1225 superseder
2009-05-05 05:54:34twbsetnosy: kowey, fx, simon, twb, thorkilnaur, dmitry.kurochkin
2009-05-07 02:49:31twbsetstatus: unknown -> resolved
nosy: kowey, fx, simon, twb, thorkilnaur, dmitry.kurochkin
messages: + msg7790
2009-08-10 01:50:17twbsettopic: + Documentation
nosy: kowey, fx, simon, twb, thorkilnaur, dmitry.kurochkin
2009-08-10 01:52:19twbsetnosy: kowey, fx, simon, twb, thorkilnaur, dmitry.kurochkin
title: docs: build dependencies should be specified properly -> build dependencies should be specified properly
2009-08-25 17:38:39adminsetnosy: + darcs-devel, - simon
2009-08-27 14:21:30adminsetnosy: kowey, fx, darcs-devel, twb, thorkilnaur, dmitry.kurochkin
2010-06-15 21:51:37adminsetmilestone: 2.3.x
2010-06-15 21:51:39adminsettopic: - Target-2.3