rzel / rudix

Automatically exported from code.google.com/p/rudix
Other
0 stars 0 forks source link

BuildSystem: Automatize the process of creating pmdocs #43

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
The process of create and update the pmdoc component shall be automatic, they 
can easily be reconstructed from the information contained in Makefiles.

A pmdoc has 3 parts:

1) The Index (index.xml)
2) The Package Reference (01xxx.xml)
3) Contents/manifest of files (01xxx-contents.xml)

* index.xml has title, organization, description, pkgref (id), license, readme, 
and reference to 01xxx.xml
* 01xxx.xml has identifier (pkgref) and reference to contents 
(01xxx-contents.xml).
* 01xxx-contens.xml contains files and attributes.

Part 1 and 2 can be easily automatize but part 3 is hard.

The port's Makefiles must include a new attribute, DESCRIPTION= to describe the 
package. This information is already defined as a comment in many ports (if not 
in all ports!).

Original issue reported on code.google.com by ruda.moura@gmail.com on 17 Mar 2011 at 1:28

GoogleCodeExporter commented 9 years ago
make pmdoc should be a part of the build system, so packagers never forget to 
generate it.

We should also create a pmdocfilescheck to check if there is any files in the 
install dir that aren't in the manifest xml (and is probably a bug). This could 
be a new step in the build system or part of the test step. 

I will turn this all into new issues when I have more time.

Original comment by santagada on 17 Mar 2011 at 9:23

GoogleCodeExporter commented 9 years ago

Original comment by ruda.moura@gmail.com on 7 Apr 2012 at 12:38