-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi all you goons and minions,

While this may seem relatively simple, it's one of those "Don't judge
a book by the cover".  While documenting, it was brough up the idea of
naming conventions so as not to have:

function_name()
functionName()
FunctionName()

and wondering what was going on while reading the documentation.  The
actual recommendation to naming convetions was:

variable = foo_bar
function = foo_bar()
class = FooBar
class method = fooBar()

However, here's where the fun part comes in.  Renaming stuff may seem
relatively simple (sed is your friend here), but the main fun is people
that are using the existing portage calls in their scripts, or in
official portage tools.  The scripts here will simply break, and there
will be lots of frowning/"I'm going to kill you, start running" types.
This said, the following are recommendations:

1) Create aliases to the new functions, then at some
yet-to-be-determined point, kill the aliases and bomb on the scripts
(this suffers from procrastination).

2) Make an official release with the new function names and no aliases,
as well as the soon to come docs.  I sort of like this method because
those with official portage tools can adjust their scripts, and simply
alter the depend atoms for >= (new API versions) and <= (old versions),
effectively forcing/preventing upgrades.

So please, throw your .02 $currencies in on this.

Chris White
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2.2 (GNU/Linux)

iD8DBQFEwS5XFdQwWVoAgN4RAukzAKCl6Tqevv3m5xSn8TH7U4o8v8SiUgCffiQ/
FpgEBfczut17wRuai8EHAS8=
=Fz+f
-----END PGP SIGNATURE-----

-- 
gentoo-portage-dev@gentoo.org mailing list

Reply via email to