OCaml Forge

Detail: [#700] Explanation of basic fields

Feature Requests: Browse | Download .csv | Monitor

[#700] Explanation of basic fields

Date:
2010-07-27 15:18
Priority:
3
State:
Open
Submitted by:
Dawid Toton (toton)
Assigned to:
Sylvain Le Gall (gildor-admin)
Resolution:
None
Due in version:
None
Product:
OASIS
Component:
OASIS
Operating System:
None
 
Summary:
Explanation of basic fields

Detailed description
I find the current documentation insufficient.

The ConfType field is described as "Configuration system" which is meaningless.
I suppose it should be "identifier of the configuration system to be used". But it should be explained what is the scope of "configuration system" in case of OASIS.

There is a related problem is the hints OASIS gives during -quickstart: some of them are useless. For example:

Value for field 'ConfType'? (default is 'internal (0.1.0)', type '?' for help)
Configuration system.

The hint doesn't explain what should be entered here.
My proposal is just to list all accepted values (with their description).

Followup

Message
Date: 2010-07-27 16:09
Sender: Sylvain Le Gall

Sorry "OASIS -documentation" (in v0.2.0 this "OASIS manual")
or the online manual
http://oasis.forge.ocamlcore.org/MANUAL.html

Date: 2010-07-27 15:58
Sender: Dawid Toton

I have installed OASIS from the available tarball. It has no -manual:
/usr/local/bin/OASIS: unknown option `-manual'.

Which revision is the more current but stable enough to play with?
Date: 2010-07-27 15:49
Sender: Sylvain Le Gall

Maybe being a little bit more verbose about what a configuration system is, could be helpful.

There is also the online documentation and the 'OASIS -manual' documentation that are more lengthy.

Attached Files:

Changes:

Field Old Value Date By
assigned_tonone2010-07-27 15:49gildor-admin
ProductNone2010-07-27 15:49gildor-admin
ComponentNone2010-07-27 15:49gildor-admin