Re: DEP5: Extra fields without ‘X-’ prefix?

2010-11-22 Thread Craig Small
On Mon, Nov 22, 2010 at 10:53:55AM +, Philip Hands wrote:
>   Extra fields can be added to any paragraph.
>   Before introducing new field names you should request comments on the
>   wisdom of the new field. When introducing it please also record it on:
>  http://wiki.d.o/.../page-for-proposed-new-DEP5-fields
>   No ``X-'' prefix is required or desired in new field names.
I think it is a good idea to check. It will hopefully reduce the chances
of having lots of fields that mean the same thing, but have different
names.

 - Craig
-- 
Craig Small VK2XLZhttp://www.enc.com.au/   csmall at : enc.com.au
Debian GNU/Linux  http://www.debian.org/   csmall at : debian.org
GPG fingerprint:   1C1B D893 1418 2AF4 45EE  95CB C76C E5AC 12CA DFA5


-- 
To UNSUBSCRIBE, email to debian-project-requ...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org
Archive: http://lists.debian.org/20101122200455.gc12...@enc.com.au



Re: DEP5: Extra fields without ‘X-’ prefix?

2010-11-22 Thread Philip Hands
On Sat, 20 Nov 2010 09:22:48 +, Lars Wirzenius  wrote:
> On su, 2010-11-14 at 11:13 +, Lars Wirzenius wrote:
> > Extra fields can be added to any paragraph. No prefixing is
> > necessary. Future versions of the `debian/copyright`
> > specification will attempt to avoid conflicting specifications
> > for widely used extra fields.
> > 
> > Is that enough? This is a minor detail, I'd like to not start specifying
> > too much about how parsers are supposed to handle the fields, etc.
> 
> I ended up with this formulation, I hope that's acceptable to everyone:
> 
> -Extra fields can be added to any paragraph. Their name starts
> by **`X-`**.
> +Extra fields can be added to any paragraph. 
> +No prefixing is necessary or desired, but please avoid names
> similar
> +to standard ones so that mistakes are easier to catch. 
> +Future versions of the `debian/copyright`
> +specification will attempt to avoid conflicting specifications
> +for widely used extra fields.

It occurred to me before that this should also suggest that people ask
around before making up new names, but I thought that should probably go
without saying -- both that and this wording both read a little like
"don't be stupid" to me.

Not that I'm saying that we shouldn't say "Don't be stupid" if people
think that people need to be told that :-)

How about addressing this at a meta-level, by suggesting people consult
wider opinion:

  Extra fields can be added to any paragraph.
  Before introducing new field names you should request comments on the
  wisdom of the new field. When introducing it please also record it on:
 http://wiki.d.o/.../page-for-proposed-new-DEP5-fields
  No ``X-'' prefix is required or desired in new field names.

At least that should prevent people coming up with similar but different
solutions to the same problems, and a wiki page can act as something
like a lock.

Not that I think there's anything wrong with what you already have, so
go with whatever you prefer.

Cheers, Phil.
-- 
|)|  Philip Hands [+44 (0)20 8530 9560]http://www.hands.com/
|-|  HANDS.COM Ltd.http://www.uk.debian.org/
|(|  10 Onslow Gardens, South Woodford, London  E18 1NE  ENGLAND


pgpUykIA3VsUX.pgp
Description: PGP signature


Re: DEP5: Extra fields without ‘X-’ prefix?

2010-11-22 Thread Dominique Dumont
On Monday 15 November 2010 17:47:26 Jonas Smedegaard wrote:
> >Indeed. But people using extra fields will get warnings, so they will 
> >ignore them. Then, they will also ignore warnings triggered by typos in 
> >standard fields.
> 
> True. But I see it as a challenge of parsers rather than a flaw of the 
> format: it could be handled similar to lintian overrides (i.e. silence 
> specific non-standard fields you yourself choose to use).

How about calling DEP-5 parser from lintian and let lintian handle the 
overrides ?

> IMO this is sliding away from DEP5: feel free to move the conversation 
> to the Config::Model mailinglist if you agree (readers are hereby 
> warned). :-)

I'd suggest to nail the use case here. All other implementations details will 
be discussed in Config::Model mailinglist.

All the best

Dominique
--
http://config-model.wiki.sourceforge.net/ -o- http://search.cpan.org/~ddumont/
http://www.ohloh.net/accounts/ddumont -o- http://ddumont.wordpress.com/


-- 
To UNSUBSCRIBE, email to debian-project-requ...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org
Archive: http://lists.debian.org/201011221004.06823.dominique.dum...@hp.com