Gentoo Archives: gentoo-dev

From: Josh Saddler <nightmorph@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] A few questions to our nominees
Date: Mon, 09 Jun 2008 10:28:23
Message-Id: 484D05B3.8000704@gentoo.org
In Reply to: Re: [gentoo-dev] A few questions to our nominees by Ciaran McCreesh
1 Ciaran McCreesh wrote:
2 > On Mon, 09 Jun 2008 11:49:35 +0200
3 > Luca Barbato <lu_zero@g.o> wrote:
4 >
5 >> Ciaran McCreesh wrote:
6 >>> On Mon, 09 Jun 2008 10:50:11 +0200
7 >>> Luca Barbato <lu_zero@g.o> wrote:
8 >>>>> So how, specifically, is PMS "wrongly written", and why hasn't
9 >>>>> anyone who thinks so bothered to provide details?
10 >>>> - rewrite it as an rfc using a markup among xmlrfc, docbook,
11 >>>> guidexml.
12 >>> What technical reason is there to use a markup that's more work for
13 >>> those of us doing the writing? Writing XML is a huge pain in the ass
14 >>> compared to latex.
15 >> More people can understand those markups
16 >
17 > I've yet to see anyone have any difficulties with Tex.
18 >
19 >> they are consistent with the gentoo documentation
20 >
21 > GuideXML can't even begin to cover our requirements. Simple example:
22 > try to rewrite the following in GuideXML:
23 >
24 > ---START---
25 > Global variables must only contain invariant values
26 > (see~\ref{metadata-invariance}). If a global variable's value is
27 > invariant, it may have the value that would be generated at any given
28 > point in the build sequence.
29 >
30 > This is demonstrated by code listing~\ref{lst:env-saving}.
31 >
32 > \lstinputlisting[float,caption=Environment state between
33 > functions,label=lst:env-saving]{env-saving.listing}
34 > ---END---
35
36 Let's change all that hideous, barely readable multiple brace/bracket
37 abuse into something more human-readable, shall we?
38
39 ---
40
41 <p>
42 Global variables must only contain invariant values (see <uri
43 link="#metadata-invariance">link</uri>). If a global variable's value is
44 invariant, it may have the value that would be generated at any given
45 point in the build sequence.
46 </p>
47
48 <p>
49 This is demonstrated by the following:
50 </p>
51
52 <pre caption="Environment state between functions" id="env-saving">
53 bunch o'neat code
54 </pre>
55
56 ---
57
58 Oh, and that "id" is entirely optional; GuideXML is smart enough to keep
59 track of successive code blocks, so you automatically have numerical
60 inter/intra document links, as I'll demonstrate at the end of this email.
61
62 GuideXML has moved on, while you seem to be stuck in the past. For
63 example, look at all the neat things we can do especially for ebuild
64 syntax highlighting.[1] Might want to read the rest of that document,
65 while you're at it.
66
67 Thanks for playing; you lose.
68
69
70 [1] http://www.gentoo.org/doc/en/xml-guide.xml#doc_chap2_sect7

Attachments

File name MIME type
signature.asc application/pgp-signature

Replies

Subject Author
Re: [gentoo-dev] A few questions to our nominees David Leverton <levertond@××××××××××.com>
Re: [gentoo-dev] A few questions to our nominees Ciaran McCreesh <ciaran.mccreesh@××××××××××.com>