How to include src/doc/ROADMAP in our web pages

Rui Paulo wrote:

> What about using NETBSDSRCDIR or BSDSRCDIR instead of
CURRENTSRCDIR.htdocs ?
> The rest looks pretty reasonable.

I already described my reason for that:

> > I did not use NETBSDSRCDIR (from bsd.own.mk)
because this may not be
> > a src tree for -current. On my machine it contains
netbsd-3.

ciao
     Klaus

At Sat, 10 Jun 2006 15:02:48 +0200,
Klaus Heinz wrote:
> 
> Rui Paulo wrote:
> 
> > What about using NETBSDSRCDIR or BSDSRCDIR instead
of CURRENTSRCDIR.htdocs ?
> > The rest looks pretty reasonable.
> 
> I already described my reason for that:
> 
> > > I did not use NETBSDSRCDIR (from bsd.own.mk)
because this may not be
> > > a src tree for -current. On my machine it
contains netbsd-3.

Sorry, my mistake.
I don't have objections on this, please go ahead if no one
objects.

On Sat, Jun 10, 2006 at 03:02:48PM +0200, Klaus Heinz wrote:
> > > I did not use NETBSDSRCDIR (from bsd.own.mk)
because this may not be
> > > a src tree for -current. On my machine it
contains netbsd-3.

How about defaulting your new variable to NETBSDSRCDIR
though?

(I think the right way would be to "cvs co" the
roadmap file in a temporary
directory, but that would probably cause too much other
complications)

Martin

Martin Husemann wrote:

> How about defaulting your new variable to NETBSDSRCDIR
though?
> 
> (I think the right way would be to "cvs co"
the roadmap file in a temporary
> directory, but that would probably cause too much other
complications)

I thought about this as well, but since roadmap.html is
_always_ built
this would need a net connection (for "cvs co")
only for building htdocs.

This whole concept of using a file in different CVS tree
from where it
lives opens a can of worms :-/. If I update htdocs I do not
necessarily
update current-src. I cannot use make's ability to track
outdated files
because CVS does not preserve timestamps. NETBSDSRCDIR does
not
necessarily point at current sources.

I actually think it would be better to duplicate the file
ROADMAP in
htdocs. If changes really happen rarely this should be
feasible, we
could even provide a make-target for this and put a short
note at the
top of the file.

ciao
     Klaus

At Sun, 11 Jun 2006 19:01:00 +0200,
Klaus Heinz wrote:
> I actually think it would be better to duplicate the
file ROADMAP in
> htdocs. If changes really happen rarely this should be
feasible, we
> could even provide a make-target for this and put a
short note at the
> top of the file.

Yes, this makes sense. Can you raise the question at
board or core,
please ?

Thanks.

I wrote:

> I actually think it would be better to duplicate the
file ROADMAP in
> htdocs. If changes really happen rarely this should be
feasible, we
> could even provide a make-target for this and put a
short note at the
> top of the file.

Next try (thanks to Rui Paulo for the hint about XInclude).

Apply the appended patch in htdocs/Goals, copy
src/docs/ROADMAP to
htdocs/Goals and "make roadmap.html". People who
do not have the
htdocs tools installed can take a look at:

  http://www.
NetBSD.org/~heinz/roadmap.html

ROADMAP will live in two places, (src/doc/ROADMAP,
htdocs/Goals/ROADMAP) but must only be changed in
src/doc/ROADMAP.

ROADMAP in htdocs will not have CVS tags of its own, because
it is only
a copy without a need for version history. The existing tags
get
automatically replaced for the HTML file roadmap.html and
people
updating ROADMAP in htdocs must be carefule to run
"make escape-cvs-tags"
before committing a new version.

ciao
     Klaus
Index: Makefile
============================================================
=======
RCS file: /cvsroot/htdocs/Goals/Makefile,v
retrieving revision 1.7
diff -u -r1.7 Makefile
--- Makefile	14 Oct 2005 08:59:56 -0000	1.7
+++ Makefile	5 Jul 2006 16:03:20 -0000
 -1,6
+1,15 
 #	$NetBSD: Makefile,v 1.7 2005/10/14 08:59:56 rillig Exp $
 
 XMLDOCS+=	index interop portability redistribution
-XMLDOCS+=	standards system
+XMLDOCS+=	standards system roadmap
+
+SRCS.roadmap+=	escape-cvs-tags
+
+ROADMAPTAGS=	NetBSD
+
+escape-cvs-tags:	ROADMAP
+.for tag in $
+	sed -e
's/^\(.*\)\$$\($.*\)\$$\(.*\)$$/\1%\2%\3/g
' ROADMAP > ROADMAP.tmp && mv -f ROADMAP.tmp
ROADMAP
+.endfor
 
 .include "../share/mk/web.site.mk"
--- /dev/null	2006-07-05 18:06:41.000000000 +0200
+++ roadmap.xml	2006-07-05 17:32:29.000000000 +0200
 -0,0
+1,19 
+<?xml version="1.0"?>
+<!DOCTYPE webpage
+  PUBLIC "-//NetBSD//DTD Website-based NetBSD
Extension//EN"
+	"http://www.NetBSD.org/XML/htdocs/lang/share/xm
l/website-netbsd.dtd">
+
+<webpage id="Goals-roadmap">
+<config param="desc" value="The NetBSD
Project's roadmap"/>
+<config param="cvstag"
value="$NetBSD$"/>
+<config param="rcsdate"
value="$Date$"/>
+<head>
+<title>The NetBSD Project's roadmap</title>
+</head>
+
+<screen>
+  <xi:include xmlnsi=&q
uot;http://www.w3.org/200
1/XInclude" href="ROADMAP"
+  parse="text" />
+</screen>
+
+</webpage>

At Wed, 5 Jul 2006 18:26:05 +0200,
Klaus Heinz wrote:
> 
> I wrote:
> 
> > I actually think it would be better to duplicate
the file ROADMAP in
> > htdocs. If changes really happen rarely this
should be feasible, we
> > could even provide a make-target for this and put
a short note at the
> > top of the file.
> 
> Next try (thanks to Rui Paulo for the hint about
XInclude).
> 
> Apply the appended patch in htdocs/Goals, copy
src/docs/ROADMAP to
> htdocs/Goals and "make roadmap.html".
People who do not have the
> htdocs tools installed can take a look at:
> 
>   http://www.
NetBSD.org/~heinz/roadmap.html
> 
> ROADMAP will live in two places, (src/doc/ROADMAP,
> htdocs/Goals/ROADMAP) but must only be changed in
src/doc/ROADMAP.
> 
> ROADMAP in htdocs will not have CVS tags of its own,
because it is only
> a copy without a need for version history. The existing
tags get
> automatically replaced for the HTML file roadmap.html
and people
> updating ROADMAP in htdocs must be carefule to run
"make escape-cvs-tags"
> before committing a new version.

This looks great. Thanks!