doc/html/cdl-guide/ref.script.html

   1 <!-- Copyright (C) 2003 Red Hat, Inc.                                -->
   2 <!-- This material may be distributed only subject to the terms      -->
   3 <!-- and conditions set forth in the Open Publication License, v1.0  -->
   4 <!-- or later (the latest version is presently available at          -->
   5 <!-- http://www.opencontent.org/openpub/).                           -->
   6 <!-- Distribution of the work or derivative of the work in any       -->
   7 <!-- standard (paper) book form is prohibited unless prior           -->
   8 <!-- permission is obtained from the copyright holder.               -->
   9 <HTML
  10 ><HEAD
  11 ><TITLE
  12 >script</TITLE
  13 ><meta name="MSSmartTagsPreventParsing" content="TRUE">
  14 <META
  15 NAME="GENERATOR"
  16 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
  17 "><LINK
  18 REL="HOME"
  19 TITLE="The eCos Component Writer's Guide"
  20 HREF="cdl-guide.html"><LINK
  21 REL="UP"
  22 TITLE="CDL Language Specification"
  23 HREF="reference.html"><LINK
  24 REL="PREVIOUS"
  25 TITLE="requires"
  26 HREF="ref.requires.html"><LINK
  27 REL="NEXT"
  28 TITLE="Templates, Targets and Other Topics"
  29 HREF="advanced.html"></HEAD
  30 ><BODY
  31 CLASS="REFENTRY"
  32 BGCOLOR="#FFFFFF"
  33 TEXT="#000000"
  34 LINK="#0000FF"
  35 VLINK="#840084"
  36 ALINK="#0000FF"
  37 ><DIV
  38 CLASS="NAVHEADER"
  39 ><TABLE
  40 SUMMARY="Header navigation table"
  41 WIDTH="100%"
  42 BORDER="0"
  43 CELLPADDING="0"
  44 CELLSPACING="0"
  45 ><TR
  46 ><TH
  47 COLSPAN="3"
  48 ALIGN="center"
  49 >The <SPAN
  50 CLASS="APPLICATION"
  51 >eCos</SPAN
  52 > Component Writer's Guide</TH
  53 ></TR
  54 ><TR
  55 ><TD
  56 WIDTH="10%"
  57 ALIGN="left"
  58 VALIGN="bottom"
  59 ><A
  60 HREF="ref.requires.html"
  61 ACCESSKEY="P"
  62 >Prev</A
  63 ></TD
  64 ><TD
  65 WIDTH="80%"
  66 ALIGN="center"
  67 VALIGN="bottom"
  68 ></TD
  69 ><TD
  70 WIDTH="10%"
  71 ALIGN="right"
  72 VALIGN="bottom"
  73 ><A
  74 HREF="advanced.html"
  75 ACCESSKEY="N"
  76 >Next</A
  77 ></TD
  78 ></TR
  79 ></TABLE
  80 ><HR
  81 ALIGN="LEFT"
  82 WIDTH="100%"></DIV
  83 ><H1
  84 ><A
  85 NAME="REF.SCRIPT"><SPAN
  86 CLASS="PROPERTY"
  87 >script</SPAN
  88 ></H1
  89 ><DIV
  90 CLASS="REFNAMEDIV"
  91 ><A
  92 NAME="AEN4954"
  93 ></A
  94 ><H2
  95 >Name</H2
  96 >Property <SPAN
  97 CLASS="PROPERTY"
  98 >script</SPAN
  99 >&nbsp;--&nbsp;Include additional configuration information from another
 100 CDL script.</DIV
 101 ><DIV
 102 CLASS="REFSYNOPSISDIV"
 103 ><A
 104 NAME="AEN4958"><H2
 105 >Synopsis</H2
 106 ><TABLE
 107 BORDER="5"
 108 BGCOLOR="#E0E0F0"
 109 WIDTH="70%"
 110 ><TR
 111 ><TD
 112 ><PRE
 113 CLASS="SYNOPSIS"
 114 >cdl_component &lt;name&gt; {
 115     script &lt;filename&gt;
 116     &#8230;
 117 }</PRE
 118 ></TD
 119 ></TR
 120 ></TABLE
 121 ></DIV
 122 ><DIV
 123 CLASS="REFSECT1"
 124 ><A
 125 NAME="AEN4960"
 126 ></A
 127 ><H2
 128 >Description</H2
 129 ><P
 130 >It is possible to define all the configuration options and
 131 sub-components for a given package in a single CDL script, either by
 132 nesting them in the appropriate command bodies, by extensive use of
 133 the <SPAN
 134 CLASS="PROPERTY"
 135 >parent</SPAN
 136 > property, or by some combination of these two. However
 137 for large packages this is inconvenient and it is better to split the
 138 raw configuration data over several different files. The <SPAN
 139 CLASS="PROPERTY"
 140 >script</SPAN
 141 >
 142 property can be used to achieve this. It takes a single filename as
 143 argument. If the package follows the <A
 144 HREF="package.html#PACKAGE.HIERARCHY"
 145 >directory layout conventions</A
 146 > then
 147 the configuration tools will look for the specified file in the
 148 <TT
 149 CLASS="FILENAME"
 150 >cdl</TT
 151 > sub-directory of the
 152 package, otherwise it will look for the file relative to the package's
 153 top-level directory.</P
 154 ><P
 155 >The <SPAN
 156 CLASS="PROPERTY"
 157 >script</SPAN
 158 > property can only occur in the body of a <TT
 159 CLASS="LITERAL"
 160 >cdl_component</TT
 161 >command, and only one <SPAN
 162 CLASS="PROPERTY"
 163 >script</SPAN
 164 > property per body is allowed.</P
 165 ></DIV
 166 ><DIV
 167 CLASS="REFSECT1"
 168 ><A
 169 NAME="AEN4971"
 170 ></A
 171 ><H2
 172 >Example</H2
 173 ><TABLE
 174 BORDER="5"
 175 BGCOLOR="#E0E0F0"
 176 WIDTH="70%"
 177 ><TR
 178 ><TD
 179 ><PRE
 180 CLASS="PROGRAMLISTING"
 181 >cdl_component CYGPKG_UITRON_TASKS {
 182     display      "Tasks"
 183     flavor        none
 184     description   "
 185         uITRON Tasks are the basic blocks of multi-tasking
 186         in the uITRON world; they are threads or lightweight
 187         processes, sharing the address space and the CPU.
 188         They communicate using the primitives outlined above.
 189         Each has a stack, an entry point (a C or C++ function),
 190         and (where appropriate) a scheduling priority."
 191
 192     script        tasks.cdl
 193 }</PRE
 194 ></TD
 195 ></TR
 196 ></TABLE
 197 ></DIV
 198 ><DIV
 199 CLASS="REFSECT1"
 200 ><A
 201 NAME="AEN4974"
 202 ></A
 203 ><H2
 204 >See Also</H2
 205 ><P
 206 >Command  <A
 207 HREF="ref.cdl-component.html"
 208 ><TT
 209 CLASS="LITERAL"
 210 >cdl_component</TT
 211 ></A
 212 >,
 213 and property <A
 214 HREF="ref.parent.html"
 215 ><SPAN
 216 CLASS="PROPERTY"
 217 >parent</SPAN
 218 ></A
 219 >.</P
 220 ></DIV
 221 ><DIV
 222 CLASS="NAVFOOTER"
 223 ><HR
 224 ALIGN="LEFT"
 225 WIDTH="100%"><TABLE
 226 SUMMARY="Footer navigation table"
 227 WIDTH="100%"
 228 BORDER="0"
 229 CELLPADDING="0"
 230 CELLSPACING="0"
 231 ><TR
 232 ><TD
 233 WIDTH="33%"
 234 ALIGN="left"
 235 VALIGN="top"
 236 ><A
 237 HREF="ref.requires.html"
 238 ACCESSKEY="P"
 239 >Prev</A
 240 ></TD
 241 ><TD
 242 WIDTH="34%"
 243 ALIGN="center"
 244 VALIGN="top"
 245 ><A
 246 HREF="cdl-guide.html"
 247 ACCESSKEY="H"
 248 >Home</A
 249 ></TD
 250 ><TD
 251 WIDTH="33%"
 252 ALIGN="right"
 253 VALIGN="top"
 254 ><A
 255 HREF="advanced.html"
 256 ACCESSKEY="N"
 257 >Next</A
 258 ></TD
 259 ></TR
 260 ><TR
 261 ><TD
 262 WIDTH="33%"
 263 ALIGN="left"
 264 VALIGN="top"
 265 ><SPAN
 266 CLASS="PROPERTY"
 267 >requires</SPAN
 268 ></TD
 269 ><TD
 270 WIDTH="34%"
 271 ALIGN="center"
 272 VALIGN="top"
 273 ><A
 274 HREF="reference.html"
 275 ACCESSKEY="U"
 276 >Up</A
 277 ></TD
 278 ><TD
 279 WIDTH="33%"
 280 ALIGN="right"
 281 VALIGN="top"
 282 >Templates, Targets and Other Topics</TD
 283 ></TR
 284 ></TABLE
 285 ></DIV
 286 ></BODY
 287 ></HTML
 288 >