Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 7 Mar 2003 21:56:28 +0100
From:      Jens Schweikhardt <schweikh@schweikhardt.net>
To:        Giorgos Keramidas <keramida@FreeBSD.org>
Cc:        docs@FreeBSD.org
Subject:   Re: New Article: FreeBSD From Scratch
Message-ID:  <20030307205628.GA6619@schweikhardt.net>
In-Reply-To: <20030307084423.GA1690@gothmog.gr>
References:  <20030305210228.GA61121@schweikhardt.net> <20030307084423.GA1690@gothmog.gr>

index | next in thread | previous in thread | raw e-mail

Giorgos et al,

On Fri, Mar 07, 2003 at 10:44:24AM +0200, Giorgos Keramidas wrote:
# -----BEGIN PGP SIGNED MESSAGE-----
# Hash: SHA1
# 
# On 2003-03-05 22:02, Jens Schweikhardt <schweikh@schweikhardt.net> wrote:
# > hello, world\n
# >
# > about two months ago I requested a review for my article "FreeBSD From
# > Scratch". I would like to thank all those who have given me invaluable
# > assistance in preparing this article. Thanks guys, you know who you are!
# > After some more polishing, testing and finally publication on daemonnews
# > last month, it is now time to hook it up to the article series (I have
# > an agreement with the daemonnews folks that it is okay after the 1 month
# > grace period to use my article in this way.)
# >
# > Please grab the SGML from http://www.schweikhardt.net/article.sgml
# > and be sure to also grab and fix the links for the three referenced files,
# > http://www.schweikhardt.net/stage_1.sh
# > http://www.schweikhardt.net/stage_2.sh
# > http://www.schweikhardt.net/stage_3.mk
# 
# I pulled myself a copy of this, and read it again.  It was great on
# daemonnews.  It still is.
# 
# A few changes that I made cann easily be seen in the RCS directory of
# http://www.FreeBSD.org/~keramida/files/scratch.tgz

Thanks, I incorporated the changes with minor tweaks (make evenmore instead of
universe, avoid contraction "you'd").

# It looks okay to me.  Commit it :)

Before I commit I want to resolve an issue that has the potential to make
some doc gurus jump up and down :-) I hope I am too pessimistic about that...

The article incorporates three nontrivial (read: more than just a few
lines) files. I want to have them appear verbatim in the article the way
I run them. Therefore I generate article.sgml with m4's include
mechanism from article.sgml.m4 and do some post processing for less-than
characters. Furthermore the three files are referenced by URLs in the
document and I don't want to have the links point to my private
homepage, but rather in the local doc tree and install them
appropriately at install time. This means stage_1.sh, stage_2.sh, and
stage_3.mk are in the same directory as article.sgml.m4 and article.sgml
and get copied to DESTDIR, e.g.
/usr/share/doc/en_US.ISO8859-1/articles/fbsd-from-scratch. The files to
commit would be

article.sgml.m4
stage_1.sh
stage_2.sh
stage_3.mk
Makefile

Here's the Makefile I came up with. Comments welcome:

#
# $FreeBSD:$
#
# Article: FreeBSD From Scratch

DOC?= article

FORMATS?= html

MAINTAINER= schweikh@FreeBSD.org

INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=

# SGML content
SRCS= article.sgml

article.sgml: article.sgml.m4 stage_1.sh stage_2.sh stage_3.mk
	${RM} -f ${.TARGET}
	m4 article.sgml.m4 | ${SED} -e '/cat.*EOF/s/</\&lt;/g' > ${.TARGET}

DOC_PREFIX?= ${.CURDIR}/../../..

afterinstall:
	${INSTALL_DOCS} stage_1.sh stage_2.sh stage_3.mk ${DESTDIR}

.include "${DOC_PREFIX}/share/mk/doc.project.mk"



This does the Right Thing for me when I run make or make install.
I'd like to use ${M4} instead of m4, but it's not available. Maybe
it can be added to some *.mk infrastructure? Let the bikeshed begin :-)


Regards,

	Jens
-- 
Jens Schweikhardt http://www.schweikhardt.net/
SIGSIG -- signature too long (core dumped)

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message



help

Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030307205628.GA6619>