At 21:01 Uhr +0100 14.02.2002, Sylvain Cuaz wrote:
>Le jeudi 14 f�vrier 2002, � 07:35 PM, Max Horn a �crit :
>
>>Update of /cvsroot/fink/packages/dists/unstable/main/finkinfo/devel
>>In directory usw-pr-cvs1:/tmp/cvs-serv14033
>>
>>Modified Files:
>>      cccc-3.pre54-1.info cyclo-2.0-1.info metrics-1.0-1.info
>>Log Message:
>>cleanup, now validate
>
>well apart from the Description of cyclo, they was already valid :-)

Yeah, I know. Maybe I should have written: "Cleanup. Removed last
trace that prevented validation", but I tend to stick to rather short
cvs commit logs :) Sorry, didn't want to make it look as if you had
something bad (you certainly didn't).


>       I noticed that you changed Maintener of place, must the
>fields follow an order (if so which one, I haven't found one, apart
>from the order they are explained on the web site).

This is not a must, but as an informal rule, we try to keep a fixed
order of fields, matching the order they appear in the documentation.
That eases eyeball scanning of packages.


>       You also deleted empty lines and added a space before each
>line, is it a policy that I'm unaware of (on the web page the <<
>example is without spaces) ?

Again, an informal policy only. There shouldn't be empty lines in the
.info file; if you want to seperate a "section" of fields from
others, you should do so with an empty comment line (starting with a
#).
Inside of a multi line field, there should normally never be empty
lines. Also try to keep lines as short as (sanely) possible, since
the longer a line is, the harder it is for a human being to read it.

Finally, the indention makes the file easier to read, too. With it,
you can immediatly see where the next field begin. Without it, if you
have many multi line fields in a package, it is easy to miss parts
when visually checking the package.

All of this is certainly not required, but IMHO makes packages easier
to maintain.


Cheers,

Max


P.S.: I am CC'ing this to fink-devel since I believe it may be of
interest to others.
--
-----------------------------------------------
Max Horn
Software Developer

email: <mailto:[EMAIL PROTECTED]>
phone: (+49) 6151-494890

_______________________________________________
Fink-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/fink-devel

Reply via email to