This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 16548 - Need documentation on NBM format
Summary: Need documentation on NBM format
Status: VERIFIED FIXED
Alias: None
Product: platform
Classification: Unclassified
Component: Autoupdate (show other bugs)
Version: 3.x
Hardware: PC Linux
: P2 blocker (vote)
Assignee: akemr
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2001-10-13 12:02 UTC by Jesse Glick
Modified: 2002-04-22 16:04 UTC (History)
0 users

See Also:
Issue Type: TASK
Exception Reporter:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Jesse Glick 2001-10-13 12:02:34 UTC 
There is a pressing need for clear and helpful documentation on NBMs and how
Auto Update uses them:

- introduction, why NBMs are more useful for distributing modules than bare
JARs, why they are safer than ad-hoc installer tools

- format of the NBM file, i.e. ZIP structure, meaning of info.xml elements, etc.

- how to build one: manually with a text editor and zip tool; using Ant task
<makenbm>

- format of update XML file

- how to make an update XML file: manually; using <makeupdatedesc>

- how to publish an update desc and NBMs on a server and make the URL available
to clients

- any information about localization of NBMs, etc.

Please create such documentation and publish it on
http://autoupdate.netbeans.org/. It can be linked to from the Modules API
(though NBMs are not officially part of the APIs), nbbuild pages, FAQs, etc.
Many people ask for this.
Comment 1 akemr 2001-10-22 08:10:31 UTC 
Assign to me.
Comment 2 Jan Chalupa 2001-11-27 10:51:39 UTC 
Target milestone -> 3.3.1.
Comment 3 akemr 2002-01-30 09:23:43 UTC 
First draft is on:
http://autoupdate.netbeans.org/nbm/nbm_package.html 

Thanks for comments.
Comment 4 Jaromir Uhrik 2002-04-22 16:04:12 UTC 
Verified.