Gentoo Archives: gentoo-dev

From: Jeroen Roovers <jer@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] Maintainer notes in metadata.xml?
Date: Mon, 06 Dec 2010 03:32:00
Message-Id: 20101206043113.0ef9d972@epia.jer-c2.orkz.net
In Reply to: Re: [gentoo-dev] Maintainer notes in metadata.xml? by Nirbheek Chauhan
1 On Wed, 1 Dec 2010 06:55:41 +0530
2 Nirbheek Chauhan <nirbheek@g.o> wrote:
3
4 > On Wed, Dec 1, 2010 at 6:30 AM, Diego Elio Pettenò
5 > > Comments?
6
7 +1
8
9 > Why don't we just encourage maintainers to add <!-- --> comments to
10 > metadata.xml?
11
12 Because XML is designed to not parse <!-- comments -->. If you want a
13 machine to spit out a nice summary based on XML, you define and use
14 something like a <comment> tag, not a language feature that was
15 designed not to be parsed like <!-- this -->.
16
17 The abuse of <!-- comment --> tags has already forced bug wranglers to
18 read the bare tags.
19
20
21 jer