Date: Sun, 16 May 1999 01:02:13 +0100 From: Nik Clayton <nik@nothing-going-on.demon.co.uk> To: Wolfram Schneider <wosch@panke.de.freebsd.org> Cc: nclayton@lehman.com, Satoshi - Ports Wraith - Asami <asami@FreeBSD.ORG>, doc@FreeBSD.ORG Subject: Re: Can't build handbook Message-ID: <19990516010213.A81732@catkin.nothing-going-on.org> In-Reply-To: <19990515190712.02032@panke.de.freebsd.org>; from Wolfram Schneider on Sat, May 15, 1999 at 07:07:12PM %2B0200 References: <19990508141141.A20366@holly.dyndns.org> <XFMail.990508212539.jesusr@ncsa.es> <19990508231333.45191@panke.de.freebsd.org> <19990510111306.I14492@lehman.com> <199905110749.AAA28713@silvia.hip.berkeley.edu> <19990513130423.49638@panke.de.freebsd.org> <19990513124039.N14492@lehman.com> <19990515190712.02032@panke.de.freebsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, May 15, 1999 at 07:07:12PM +0200, Wolfram Schneider wrote:
> On 1999-05-13 12:40:39 +0100, nclayton@lehman.com wrote:
> > Yes, if they check it out anywhere other than /usr/doc they will need
> > to set DOC_PREFIX. As I've already explained, this is a hack that will
> > (eventually) go away. In the meantime we can do one of two things;
>
> Some weeks ago it was possible to checkout the handbook
> and compile it:
>
> $ cvs co handbook; cd handbook; make
>
> No it is no longer possible. You have to checkout either the
> whole doc tree or know exactly which sub-directories you need:
Indeed. Much like the ports tree (try building anything in there without
ports/Mk/*).
> $ cvs co doc/en/handbook doc/sgml doc/share doc/en/share
> $ cd doc/en/handbook; make
You shouldn't need doc/sgml at all.
The idea is that you will be able to say
To build any piece of documentation you have to have the following;
doc/share/*
doc/<lang>.<charset>/share/*
doc/<lang>.<charset>/{books,articles}/document-to-build
> and set the DOC_PREFIX variable to $PWD/doc.
>
> I'm not surprised that we are getting complaints and the
> documentation pages are more often broken ;-(
I'm not sure. Yes, more people are asking for information on how to do
it, but we're also being more agressive in trying to get people to
contribute in the first place. More people contributing leads to more
people trying out the build system, and potentially not understanding.
I'll say for the record that post-directory reorganisation the DOC_PREFIX
hack will go.
> > 2. Stick in some code that checks for an empty DOC_PREFIX, and advises
> > the user on how to fix it. Or better yet, looks in DOC_PREFIX
> > first the make sure the appropriate files are there, and warns the
> > user if they aren't.
> >
> > I posted code that does this earlier on in this thread.
> >
> > I think option 2 is the best way to go. We can keep /usr/doc as the
> > default, and it will work if the user has been storing a checked out
> > copy in /usr/doc. If they haven't then the DOC_PREFIX test will discover
> > that, abort the build, and print instructions about what they should do.
>
> I prefer option 2).
I'll try and code this up tomorrow.
N
--
There's some milk in the fridge about to go off. . . and there it goes.
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19990516010213.A81732>