Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 362840 - update cdoc for the config section to be more user friendly
Summary: update cdoc for the config section to be more user friendly
Status: CLOSED FIXED
Alias: None
Product: RTSC
Classification: Technology
Component: Tools (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Joseph Cusano CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 362855 (view as bug list)
Depends on:
Blocks:
 
Reported: 2011-11-03 16:36 EDT by Karl Wechsler CLA
Modified: 2014-03-10 22:27 EDT (History)
2 users (show)

See Also:

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 Karl Wechsler CLA 2011-11-03 16:36:29 EDT 
Feedback from customer meeting ...

cdoc currently uses:

"XDCscript usage meta-domain"

to describe the .cfg file settings.  

This should be changed to

"Configuration (.cfg) Settings"
Comment 1 Dave Russo CLA 2011-11-03 20:29:53 EDT 
*** Bug 362855 has been marked as a duplicate of this bug. ***
Comment 2 Dave Russo CLA 2011-11-03 20:33:06 EDT 
From the dup 362855 description:

configuration parameter documentation can be reformatted to be more easily
understood by the Grace user (show the description _before_ the script usage,
for example).

We should also look to eliminate/minimize/rename "XDCscript" and "meta-domain";
e.g., use "JavaScript" and "development host", as needed.

Perhaps less use of color in the docs might also be welcome.  IMO the use of
red causes should reserved for errors or very important notes.  If a color
difference is deemed necessary, I'd prefer something more subtle (e.g., use of
black for meta-domain and dark blue for target-domain).
Comment 3 Joseph Cusano CLA 2011-12-22 16:06:47 EST 
Implemented in xdc-z03
Comment 4 Dave Russo CLA 2014-03-10 22:27:09 EDT 
delivered in xdctools 3.25.0