Gentoo Archives: gentoo-dev

From: "Rémi Cardona" <remi@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] [RFC] Features and documentation
Date: Wed, 28 Nov 2007 07:02:30
Message-Id: 474D111A.9080102@gentoo.org
In Reply to: Re: [gentoo-dev] [RFC] Features and documentation by Alec Warner
1 Alec Warner wrote:
2 > On 11/27/07, Donnie Berkholz <dberkholz@g.o> wrote:
3 >> How the recent changes happened to allow USE flag descriptions in
4 >> metadata.xml (which I'm not taking any position on now) gave me an idea.
5 >> The Linux kernel requires that any needed documentation accompany all
6 >> changes requiring said documentation -- part of the source-code patch
7 >> must apply to the Documentation/ directory. Should we require that
8 >> before you commit any changes, you (or someone) write the documentation
9 >> for them and commit it or submit a patch at the same time?
10 >>
11 >> To sum up: No undocumented changes.
12 >
13 > No, because this is not a realistic requirement, it's an ideal case.
14 > People will just commit changes without documentation anyway.
15
16 What if Donnie had used s/changes/new features/ ? Then his proposal
17 makes much more sense.
18
19 For bugfix, we already have ChangeLogs.
20
21 My 2 euro ¢
22
23 Cheers,
24 Rémi
25 --
26 gentoo-dev@g.o mailing list

Replies

Subject Author
Re: [gentoo-dev] [RFC] Features and documentation Zhang Le <r0bertz@g.o>