Gentoo Archives: gentoo-dev

From: "Diego 'Flameeyes' Pettenò" <flameeyes@g.o>
To: gentoo-dev@l.g.o
Subject: [gentoo-dev] QA guides
Date: Tue, 31 Jan 2006 00:04:35
Message-Id: 200601310059.27438@enterprise.flameeyes.is-a-geek.org
1 Hi everybody,
2 I think this is worth to be told here (and maybe also in next week's GWN
3 wouldn't be bad, if I'm able to finish what I'm going to promise later in
4 this mail). As people could have read on my blog, today I've added a new
5 guide under the qa project and added a link from the project page to the
6 asneeded fixing guide.
7 The qa project can be found at http://www.gentoo.org/proj/en/qa/ , and from
8 there it's possible to read the two guides, the aforementioned --as-needed
9 fixing guide and the automagic dependency guide.
10
11 Why I've started writing those guides? Well mainly because I think we can't
12 actually start enforcing some qa if we don't have documented practice; the
13 DevManual was a good starting point, but AFAIK it's temporaly unmaintained
14 and something more official would be needed to actually start enforcing it.
15
16 I'm trying to stick with practical problems and solutions, not going on things
17 that are more policy-related, as policies has the bad habit of fleeing out of
18 control if not decided with lot of discussions.
19 Following the two guides that I already put there, I want to write something
20 about solving parallel make issues and autotools failures (how many times we
21 had bugs stuck with a missing m4 file?).
22 Of course, enhancement and extensions to those guides are really welcome; devs
23 can commit there directly (adding themselves as authors if they add
24 substantial doc), but please don't just change them entirely because you
25 don't agree with what is written there, if there's something you strongly
26 disagree, I'd see better a discussion on gentoo-dev so that all can be
27 informed of what it's decided. Users that are wanting to precise something
28 because they know the topic (wouldn't be so strange) can send me the
29 corrections by mail; I don't think bugzilla is a good place for it because
30 the docs product is for user documentation rather than project documentation,
31 but if GDP wouldn't mind finding in that product bugs assigned to me about
32 those guides, it can be arranged.
33
34 I would also ask someone, wither from GDP or not, to please revise the grammar
35 and spelling, possibly sending me the correction before committing if they
36 seem to change substantial parts of the text.
37
38 I really hope those guides can be helpful to people; IMHO the first step to
39 have a QA is to provide enough documentation on how things has to be done, or
40 people wouldn't know how to do them.
41
42 --
43 Diego "Flameeyes" Pettenò - http://dev.gentoo.org/~flameeyes/
44 Gentoo/ALT lead, Gentoo/FreeBSD, Video, AMD64, Sound, PAM, KDE