suggestions for freesbie2

Marco Molteni <[email protected]>
Newsgroups gmane.os.freebsd.freesbie
Message-ID <[email protected]>
I am looking at the code to understand how it works, and I have a few
suggestions:

1 each file under extra (and maybe also under scripts) should have
  a line like:
  DESC="short description of what this plugin does"
  this would allow:
  1. to know what the plugin does ;-)
  2. to generate automatically a web page (or whatever format) with
     the description of each plugin. This would allow to have the
     documentation updated automatically

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

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


I think I can do some of this, if we agree on the direction.

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)
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.