Re: suggestions for freesbie2

On Tue, 3 Jan 2006 04:28:01 +0100
Dario Freni <[email protected]> wrote:

> On Sat, Dec 31, 2005 at 04:34:32PM +0100, Marco Molteni wrote:

[..]

> > 1 each file under extra (and maybe also under scripts) should have
> >   a line like:
> >   DESC="short description of what this plugin does"

[..]

> Nice idea! We're trying to keep an updated documentation for each
> plugin on the wiki at the moment.

yes, I saw it; this gave me the idea actually.

> > 2 refactor common code.
> >   a lot of files have the same blurb:
> > if [ -z "${LOGFILE:-}" ]; then
> >     echo "This script can't run standalone."
> >     echo "Please use launch.sh to execute it."
> >     exit 1
> > fi
> > 
> >   this should go in a new file as a function, say common.sh, 
> >   and the existing files should source common.sh
> 
> This can go to scripts/launch.sh as other common functions already
> present. I didn't make it at first because I want developers to
> understand how the plugin system works. It is a must-do for the core
> scripts, instead.

Yeah, I realized today that launch.sh is the good place for this.

> > 3 I have the feeling that img.sh and flash.sh have a lot in
> >   common. They should be refactored to exploit the commonality.

[..]

> In conclusion I agree to their rewrite, but I want them to be easily
> understandable by a new developer who wants to learn how an image is
> formatted and customise their behaviour.
> 
> > I think I can do some of this, if we agree on the direction.
> 
> You're welcome, and we're honoured :) I think that 3) is perfect for
> you, so start with it if you can.

thanks :-) I'll let you know how it goes.

marco
-- 
He who receives an idea from me, receives instruction himself
without lessening mine; as he who lights his taper at mine,
receives light without darkening me. -- Thomas Jefferson
-- 
FreeSBIE mailing list (http://www.freesbie.org)