Module Submission

(Difference between revisions)
Jump to: navigation, search
m (added note about new submit functionality in theedge)
(Updated to reflect new submission system)
Line 27: Line 27:
 
Even if they don't, your module will still be available to interested parties via the mailing list archive.
 
Even if they don't, your module will still be available to interested parties via the mailing list archive.
  
====So what do you need to be able to submit a module?====
+
====So what do you need to update and submit a module?====
  
* '''You need to be subscribed to the [http://lunar-linux.org/mailman/listinfo/lunar Lunar Mailing-List].''' Why not do it now anyway?
+
Let's assume that you have found the ''theModule'' no longer downloads and installs properly and you want to fix it.
  
* '''If you have a working out-going mail connection.'''
+
* '''subscribe to the [http://lunar-linux.org/mailman/listinfo/lunar Lunar Mailing-List].''' Not sure if this is still required, but why not do it now anyway? Other users might have feedback about the module.
** Maybe you haven't yet got or don't want to have a full mail installation on your system. Then you could install a minimal out-going mail only system. Download the [http://modules.lunar-linux.org/index.php?option=module&module=esmtp esmtp] module from the [[Moonbase]] and configure the ''/etc/esmtprc'' or ''$HOME/.esmtprc'' file as described in the [http://esmtp.sourceforge.net/manual.html on-line manual]. That's all there is to it.
+
** Simply run '''lvu submit myModule'''. You will see a submission template in the editor of your choice. Fill in the blanks: email address, some module details, and some explanatory text about your submission. Are you happy with the BUILD file? What options have you tackled? How much testing have you done? Write the template and submit. It's as easy as that.
+
  
* '''If you don't have sendmail or esmtp installed''', you can still send updates as patches.  
+
* run '''lvu edit''' '''''theModule''''' to copy the existing ''theModule'' files to [[zlocal]].
** Creating a patch is as easy as '''lvu diff myModule > myModule.patch'''. Send the patch file as an attachment to the mailinglist and it will be picked up as a normal submission.
+
* run '''lvu cd''' '''''theModule''''' or manually change into the directory given by ''lvu edit''
 +
* edit the [http://wiki.lunar-linux.org/index.php/Module_Basics#The_DETAILS_script DETAILS] file and modify the version number to the latest one available
 +
* edit the ''UPDATED'' date to today's date
 +
* run '''lget''' '''''theModule''''' and see if the new version downloads OK
 +
* run '''sha1sum /var/spool/lunar/theModule-(whatever the new file name is)'''
 +
* insert this checksum in the ''SOURCE_VFY'' field in the [http://wiki.lunar-linux.org/index.php/Module_Basics#The_DETAILS_script DETAILS] file
  
* '''Remember to watch the mailing list for feedback.''' It might show up as a new module in the Weekly Overview without further comment. You might not hear anything more because the developers are all busy with mainstream infrastructure and modules, but at least you have contributed and your contribution is available in the archives for other interested users.
+
* run '''lin''' '''''theModule''''' and test, test and test again
  
'''Note''': the above currently applies to submitting a module using '''lunar'''. ''Sofar'' has just released a version of '''theedge''' that contains new code so that '''lvu submit module''' sends the relevant information using http. All you need to do is fill in a submit message, in the same style as a cvs/svn commit.
+
* if you haven't already done so, you will need run '''lunar set ADMIN''' '''''your@e-mail.adress''''', or run '''lunar''' and follow the menus, before the next step in order for the submission script to work (it requires a valid e-mail address).
 +
 
 +
* if it all works, run '''lvu submit''' '''''theModule''''' and provide a meaningful message (see Note).
 +
* you should receive e-mail feedback whether your submission was accepted or the reasons for rejection but remember that the devs have real lives too and might not have chance to look at your module immediately.
 +
 
 +
'''Note''': The first line of the message will be visible on the on-line [http://foo-projects.org/~sofar/queue.php Submission queue]. Give the reasons why the module has been updated, and what you have changed. This message can then be used directly when submitting the changes to the central [[moonbase]].

Revision as of 16:46, 28 October 2007

Submitting modules to the official Moonbase

Why would I want to?

The official Moonbase is maintained and updated by the Lunar Linux developers. But what if there isn't a module in the Moonbase for the package that you want, or it is not the latest version, or it is out-of-date in some other way?

Well obviously you can report the problem via the Bug Tracker, the Forums, the Lunar Mailing-List, or discuss it on the #Lunar IRC channel on Freenode.net and hope that someone can help you.

Or you can scratch your itch the open source way and create or update the module yourself using the information in the articles: A basic module outline and Writing Lunar-Linux Modules. Remember to work in the zlocal section so that your updates are not lost the next time you download a new Moonbase.

And then what? Maybe other people could benefit from your module. Maybe other people could improve your module. So why not submit it to the Lunar Mailing-List so that the others can see it and the Lunar developers can decide whether to include it in the Moonbase? Even if they don't, your module will still be available to interested parties via the mailing list archive.

So what do you need to update and submit a module?

Let's assume that you have found the theModule no longer downloads and installs properly and you want to fix it.

  • subscribe to the Lunar Mailing-List. Not sure if this is still required, but why not do it now anyway? Other users might have feedback about the module.
  • run lvu edit theModule to copy the existing theModule files to zlocal.
  • run lvu cd theModule or manually change into the directory given by lvu edit
  • edit the DETAILS file and modify the version number to the latest one available
  • edit the UPDATED date to today's date
  • run lget theModule and see if the new version downloads OK
  • run sha1sum /var/spool/lunar/theModule-(whatever the new file name is)
  • insert this checksum in the SOURCE_VFY field in the DETAILS file
  • run lin theModule and test, test and test again
  • if you haven't already done so, you will need run lunar set ADMIN your@e-mail.adress, or run lunar and follow the menus, before the next step in order for the submission script to work (it requires a valid e-mail address).
  • if it all works, run lvu submit theModule and provide a meaningful message (see Note).
  • you should receive e-mail feedback whether your submission was accepted or the reasons for rejection but remember that the devs have real lives too and might not have chance to look at your module immediately.

Note: The first line of the message will be visible on the on-line Submission queue. Give the reasons why the module has been updated, and what you have changed. This message can then be used directly when submitting the changes to the central moonbase.

Personal tools
Namespaces
Variants
Actions
Wiki Navigation
Project Sites
Toolbox