darcs

Issue 1376 Cabal should build user manual and manpage

Title Cabal should build user manual and manpage
Priority wishlist Status given-up
Milestone Resolved in
Superseder Nosy List darcs-devel, dmitry.kurochkin, kowey, thorkilnaur, twb
Assigned To
Topics Devel, Documentation

Created on 2009-03-03.02:03:13 by twb, last changed 2017-07-30.23:17:55 by gh.

Messages
msg7389 (view) Author: twb Date: 2009-03-03.02:03:11
Currently the manual and manpage are treated as second-class citizens
because they have not kept up with the cabal transition (my fault).
This needs to be the top priority of the documentation team (i.e. me);
otherwise documentation will continue to fall further behind.
msg7408 (view) Author: twb Date: 2009-03-06.03:16:16
The first step is to merge darcsman.hs into the main Darcs binary, such that cabal can build dist/build/darcs/darcs and then just run it "dist/build/darcs/darcs help manual >darcs.1" at the end of "cabal build" and prior to "cabal install".  Once this is done, we can worry about the full LaTeX manual (which is harder, because the auto-generated parts are occur throughout .lhs and .tex files.)
msg7418 (view) Author: simon Date: 2009-03-07.21:21:14
Excuse my test for #1383.
msg7621 (view) Author: kowey Date: 2009-04-09.11:30:22
The darcs binary has the manpage built in.  Now what?
msg7684 (view) Author: twb Date: 2009-04-11.09:48:55
On Thu, Apr 09, 2009 at 11:30:24AM -0000, Eric Kow wrote:
> The darcs binary has the manpage built in.  Now what?

 - "cabal build" needs to create darcs.1 by running the (just built)
   darcs binary.

 - "cabal install" and "cabal copy" need to install the resulting
   darcs.1 into $mandir.

 - As above, but for the TeX manual.
msg7686 (view) Author: twb Date: 2009-04-11.09:52:10
On Sat, Apr 11, 2009 at 09:48:58AM -0000, Trent Buck wrote:
> 
> Trent Buck <trentbuck@gmail.com> added the comment:
> 
> On Thu, Apr 09, 2009 at 11:30:24AM -0000, Eric Kow wrote:
> > The darcs binary has the manpage built in.  Now what?
> 
>  - "cabal build" needs to create darcs.1 by running the (just built)
>    darcs binary.

I have a draft of this part, but it's not very "cabaly" -- it has lots
of hard-coded strings and calls to system(3) instead of using Cabal
functions.
msg8806 (view) Author: twb Date: 2009-09-14.02:04:08
I'm not interested in working on this right now.
History
Date User Action Args
2009-03-03 02:03:14twbcreate
2009-03-06 03:14:15twbsetassignedto: twb
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
2009-03-06 03:16:19twbsetstatus: unread -> unknown
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
messages: + msg7408
2009-03-07 21:21:17simonsetnosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
messages: + msg7418
2009-04-09 11:30:24koweysetpriority: wishlist
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
messages: + msg7621
2009-04-11 09:48:57twbsetnosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
messages: + msg7684
2009-04-11 09:52:12twbsetnosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
messages: + msg7686
2009-08-19 11:57:55koweysetstatus: unknown -> has-patch
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
topic: + Documentation, Devel
2009-08-25 17:41:31adminsetnosy: + darcs-devel, - simon
2009-08-27 14:28:12adminsetnosy: kowey, darcs-devel, twb, thorkilnaur, dmitry.kurochkin
2009-09-14 02:04:10twbsetassignedto: twb ->
messages: + msg8806
nosy: kowey, darcs-devel, twb, thorkilnaur, dmitry.kurochkin
2017-07-30 23:17:55ghsetstatus: has-patch -> given-up