Project

General

Profile

Bug #4339

build system needs to provide more information on modules

Added by Chad Berkley over 9 years ago. Updated over 9 years ago.

Status:
New
Priority:
Normal
Assignee:
Category:
build system
Target version:
Start date:
08/26/2009
Due date:
% Done:

0%

Estimated time:
Bugzilla-Id:
4339

Description

The build system has a 'describe' task that will svn cat the description.txt file of any module. This is a good start, but only the ppod module has a description.txt file. Furthermore, the description.txt file is located in the root of the module instead of in the module-info directory where such metadata should probably reside.

To close this bug:
-The description.txt file needs to be redesigned to include the following fields (whoever works on this should evaluate and probably use the kepler documentation format for this):
1) Title
2) Description
3) Author*
4) Related Modules*
-The description.txt file should be located in module-info
-All modules should have a valid description file and all core modules must have a description.txt file
-Modify the list-modules task to print the description, name, etc of every module in the system.


Related issues

Blocked by Kepler - Bug #4009: kepler 2.0 must provide everything needed for modulesResolved04/21/2009

History

#1 Updated by Chad Berkley over 9 years ago

Not critical to the user experience in kepler, so moving to post 2.0

#2 Updated by Redmine Admin about 6 years ago

Original Bugzilla ID was 4339

Also available in: Atom PDF