CCSv5: Documentation/Information about command line create/build projects

ROGERG

Other Parts Discussed in Thread: SYSBIOS, CCSTUDIO

Hi,

is there particular documentation on the different commands/options available for command line create/build of projects for CCSv5. I can only find this wiki page:

http://processors.wiki.ti.com/index.php/Projects_-_Command_Line_Build/Create

also mentioning the -ccs.help option, which shows me the different options but only with a small description. Is there a more comprehensive documentation on this somewhere?

Any hints/information is greatly appreciated.

Thank you and best regards,

GINNI

over 13 years ago

0 MartinS over 13 years ago

TI__Genius 15190 points

Hi Ginni,

The documentation generated by running the command line tool with -ccs.help option is most accurate at this point. We update the documentation when changes are made. There are no supplemental docs. Could you give me an idea as to which portions or options are unclear?

Thanks,

Martin

0 ROGERG over 13 years ago in reply to MartinS

TI__Mastermind 35880 points

Hi Martin,

thank you very much for looking into this. My questions are the following:

1. regarding -ccs.args <file>

2. regarding -ccs.projectspec <file>

What can I do/define with these two commands (1., 2.) and how does the file have to look like --> any examples available

3. I would like to create an RTSC example --> therefore I am using the following commands -rtsc.enableRtsc; -rtsc.target; -rtsc.platform; -rtsc.buildProfile)

The result is that IPC, grace, edma, etc. and other SW components are automatically included. How can I tell which software components should be included and which not --> any examples available

This is the include situation after creating the project:

Your help is greatly appreciated.

Thank you very much and best regards,

GINNI

0 ROGERG over 13 years ago in reply to ROGERG

TI__Mastermind 35880 points

Hi All,

any comments/hints on above questions?

Thank you very much and best regards,

GINNI

0 MartinS over 13 years ago in reply to ROGERG

TI__Genius 15190 points

Hi Ginni,

We will be adding some clarifications to CCSv5.3. However, in the meantime:

1. <file> is just a text file containing the same arguments list as if you passed them on the command line. Some users have very long list of options which causes problems with windows command line length issues, thus some or all commands can be placed in text file and passed in this argument.

2. projectspec: This is new feature in 5.2 that will allow to create new project based on project spec. The main purpose is to allow a mechanism to provide examples or projects that are somewhat CCS version agnostic. A CCS project today embeds some version specific information such as CGT version, SYS/BIOS version, etc. The goal of project spec is provide project specification that would allow to define a project but create it on the fly when a customer imports a project spec, using CGT version, SYS/BIOS that is part of their CCS installation, assuming there are no version specific dependencies in project sources.

Let me know if you need further details on this.

3. I believe you should be able to use this option

----

-rtsc.products "<id>[:<version>][;<id>[:<version>]]*"
List of RTSC products to enable (optional).

---

To get the <id> argument is somewhat convoluted today. We need to add some way of getting these id's from command line. However, in the short term you could create a dummy project using New Project wizard, enabling products that you are interested in and then looking at .cproject file. Near the top there should be a line that looks like:

<id>'s would be listed after RTSC_PRODUCTS=

Martin

0 ROGERG over 13 years ago in reply to MartinS

TI__Mastermind 35880 points

Hi Martin,

thank you very much for the comprehensive information. That already helped me a lot. It would be great if you could provide more information on the point 2., since it seems to be a useful feature. Do you have a kind of example how this project spec has to look like, how to define/import/use this project spec?

Many thanks again and best regards,

GINNI

0 ROGERG over 13 years ago in reply to ROGERG

TI__Mastermind 35880 points

Hi Martin,

do you have further information on the "projectspec" option? How to define the project, how the file have to look like, examples?

Many thanks and best regards,

GINNI

0 Baltasar Belyavsky over 13 years ago in reply to ROGERG

TI__Genius 9175 points

Hi Ginni,

I've attached the latest version of the XML schema file for the new project-spec feature. The schema file contains some basic information on the feature, and I will expand the documentation for CCSv5.3. Let me know if you have any questions on this feature.

In CCSv5.3, you'd be able to find the latest version of this schema file in <ccs>/ccsv5/eclipse/plugins/com.ti.ccstudio.project.templates_*/schema/ directory.

Thanks,

- Baltasar

projectSpec.xsd.txt

<?xml version='1.0' encoding='UTF-8'?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

   <xs:annotation>
      <xs:documentation>
         A project-spec file can be used to generate new CCS projects.  The project-spec file should have the 'projectspec' extension.  These files can be imported using the CCS Project Import wizard, and using the 'com.ti.ccstudio.apps.projectCreate' headless application.
      </xs:documentation>
   </xs:annotation>

   <xs:element name="projectSpec">
      <xs:complexType>
         <xs:sequence>
            <xs:element ref="project" minOccurs="1" maxOccurs="unbounded"/>
         </xs:sequence>
      </xs:complexType>
   </xs:element>

   <xs:element name="project">
      <xs:annotation>
         <xs:documentation>
            Template macros can be used in most project-spec attributes to give XML-defined project-specs a more dynamic behaviour. These macros would be replaced with values based on the actual device/endianness/output-format selections made by the user in the wizard at runtime. For the full list of supported template macros, see {@link com.ti.common.project.core.initializer.ProjectAttributes}.
         </xs:documentation>
      </xs:annotation>
      <xs:complexType>
         <xs:sequence>
            <xs:element ref="file" minOccurs="0" maxOccurs="unbounded"/>
            <xs:element ref="pathVariable" minOccurs="0" maxOccurs="unbounded"/>
            <xs:element ref="buildVariable" minOccurs="0" maxOccurs="unbounded"/>
            <xs:element ref="property" minOccurs="0" maxOccurs="unbounded"/>
         </xs:sequence>
         <xs:attribute name="name" type="xs:string" use="required">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="device" type="xs:string" use="required">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="location" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  Location of the new project. If relative-path specified, it will be treated as relative to the directory containing the project-spec file. If omitted, project will be created in the workspace directory.
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="outputType" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  Specifies the output-type of the project produced by this template. If omitted, it is assumed that this template can generate either one of the two intrinsic output-types - &apos;executable&apos; or &apos;staticLibrary&apos;.
               </xs:documentation>
               <xs:appinfo>
                  <xs:meta.attribute kind="identifier" basedOn="com.ti.common.project.core.outputTypes/outputType/@id"/>
               </xs:appinfo>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="endianness">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
            <xs:simpleType>
               <xs:restriction base="xs:string">
                  <xs:enumeration value="little">
                  </xs:enumeration>
                  <xs:enumeration value="big">
                  </xs:enumeration>
                  <xs:enumeration value="be8">
                  </xs:enumeration>
                  <xs:enumeration value="be32">
                  </xs:enumeration>
               </xs:restriction>
            </xs:simpleType>
         </xs:attribute>
         <xs:attribute name="cgtVersion" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="outputFormat">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
            <xs:simpleType>
               <xs:restriction base="xs:string">
                  <xs:enumeration value="COFF">
                  </xs:enumeration>
                  <xs:enumeration value="ELF">
                  </xs:enumeration>
               </xs:restriction>
            </xs:simpleType>
         </xs:attribute>
         <xs:attribute name="configurations" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  Comma-separated list of build-configuration names to create for the new project.
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="references" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  Comma-separated list of referenced project names.
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="artifactName" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  Build-artifact name.
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="artifactExtension" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  Build-artifact extension
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="autoGenerateMakefiles" type="xs:boolean">
            <xs:annotation>
               <xs:documentation>
                  Defaults to 'true'.
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="buildLocation" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="buildCommand" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  Build-command. Defaults to the 'gmake' utility included with CCS.
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="buildCommandFlags" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  Comma-separated list of build-command flags. Defaults to '-k'.
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="buildTarget" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="cleanTarget" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="template" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  Project-template to use when constructing the project.
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="launchWizard" type="xs:boolean">
            <xs:annotation>
               <xs:documentation>
                  Launches the New Project wizard, allowing the user to adjust the details. Not applicable in headless mode. Defaults to 'false'.
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="linkerCommandFile" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="runtimeSupportLibrary" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="compilerBuildOptions" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="linkerBuildOptions" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="assemblerBuildOptions" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="preBuildStep" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="postBuildStep" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
      </xs:complexType>
   </xs:element>

   <xs:element name="file">
      <xs:complexType>
         <xs:sequence>
            <xs:element ref="property" minOccurs="0" maxOccurs="unbounded"/>
         </xs:sequence>
         <xs:attribute name="path" type="xs:string" use="required">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="targetDirectory" type="xs:string">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="action">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
            <xs:simpleType>
               <xs:restriction base="xs:string">
                  <xs:enumeration value="copy">
                  </xs:enumeration>
                  <xs:enumeration value="link">
                  </xs:enumeration>
               </xs:restriction>
            </xs:simpleType>
         </xs:attribute>
         <xs:attribute name="excludeFromBuild" type="xs:boolean">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="openOnCreation" type="xs:boolean">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
      </xs:complexType>
   </xs:element>

   <xs:element name="pathVariable">
      <xs:complexType>
         <xs:attribute name="name" type="xs:string" use="required">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="path" type="xs:string" use="required">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="scope">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
            <xs:simpleType>
               <xs:restriction base="xs:string">
                  <xs:enumeration value="global">
                  </xs:enumeration>
                  <xs:enumeration value="project">
                  </xs:enumeration>
               </xs:restriction>
            </xs:simpleType>
         </xs:attribute>
      </xs:complexType>
   </xs:element>

   <xs:element name="buildVariable">
      <xs:complexType>
         <xs:attribute name="name" type="xs:string" use="required">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="value" type="xs:string" use="required">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="type">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
            <xs:simpleType>
               <xs:restriction base="xs:string">
                  <xs:enumeration value="string">
                  </xs:enumeration>
                  <xs:enumeration value="dir">
                  </xs:enumeration>
                  <xs:enumeration value="file">
                  </xs:enumeration>
               </xs:restriction>
            </xs:simpleType>
         </xs:attribute>
         <xs:attribute name="scope">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
            <xs:simpleType>
               <xs:restriction base="xs:string">
                  <xs:enumeration value="global">
                  </xs:enumeration>
                  <xs:enumeration value="project">
                  </xs:enumeration>
               </xs:restriction>
            </xs:simpleType>
         </xs:attribute>
      </xs:complexType>
   </xs:element>

   <xs:element name="property">
      <xs:complexType>
         <xs:attribute name="name" type="xs:string" use="required">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
         <xs:attribute name="value" type="xs:string" use="required">
            <xs:annotation>
               <xs:documentation>
                  
               </xs:documentation>
            </xs:annotation>
         </xs:attribute>
      </xs:complexType>
   </xs:element>

</xs:schema>

0 ROGERG over 13 years ago in reply to Baltasar Belyavsky

TI__Mastermind 35880 points

Hi Baltasar,

thank you very much!

Best Regards,

GINNI

Code Composer Studio™︎

Code Composer Studio forum

CCSv5: Documentation/Information about command line create/build projects