Minor issues in the SCA doc/CPPComponents.html
----------------------------------------------
Key: TUSCANY-850
URL: http://issues.apache.org/jira/browse/TUSCANY-850
Project: Tuscany
Issue Type: Bug
Components: C++ SCA
Affects Versions: Cpp-M2
Reporter: Jean-Sebastien Delfino
Priority: Minor
Fix For: Cpp-M2
A few minor issues in CPPComponents.html:
The overview starting with "Each SCA C++ component needs:" says that each C++
component requires a composite file, a composite and another composite file
describing the configuration... this is a little misleading.
I think we should describe the following steps, (with any wording you like):
- To turn your C++ implementation into a component, you need to write an SCDL
component declaration. To do this you write an SCDL composite file. Usually
this composite file will contain multiple components configured and assembled
together.
- Then you need to deploy this composite to your SCA system. In this release we
are leveraging the SCA recursive composition model to do this. You simply
create an SCDL component representing this composite in the SCA system, in
another composite file.
A side comment, I find this pretty difficult to describe in generic terms
without using a specific example like Calculator, now that everything is a
composite, it not always obvious to distinguish between (module) composites and
(subsystem) composites.
The text in step (8) should be adjusted as well. We should add that
sample.calculator.solution.composite is used to include the Calculator
composite in the SCA system. Also the text "The composite component definition
should specify the service name used in the componentType" should be removed as
there is no service and componentType file here.
In step 9, the .h files are not needed under the deploy directory. Only the
binaries and SCDL files are needed.
In step 11, we should describe what these environment variables are used for:
TUSCANY_SCACPP_SYSTEM_ROOT: the directory where the SCA runtime will look for
.composite files
TUSCANY_SCACPP_DEFAULT_COMPONENT: the component used to set the
CompositeContext in an SCA client, this component must be an instance of a
composite (i.e. contain an <implementation.sca> element).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
