doc/html/cdl-guide/reference.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 >CDL Language Specification</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="PREVIOUS"
  22 TITLE="Building Test Cases"
  23 HREF="build.tests.html"><LINK
  24 REL="NEXT"
  25 TITLE="cdl_option"
  26 HREF="ref.cdl-option.html"></HEAD
  27 ><BODY
  28 CLASS="CHAPTER"
  29 BGCOLOR="#FFFFFF"
  30 TEXT="#000000"
  31 LINK="#0000FF"
  32 VLINK="#840084"
  33 ALINK="#0000FF"
  34 ><DIV
  35 CLASS="NAVHEADER"
  36 ><TABLE
  37 SUMMARY="Header navigation table"
  38 WIDTH="100%"
  39 BORDER="0"
  40 CELLPADDING="0"
  41 CELLSPACING="0"
  42 ><TR
  43 ><TH
  44 COLSPAN="3"
  45 ALIGN="center"
  46 >The <SPAN
  47 CLASS="APPLICATION"
  48 >eCos</SPAN
  49 > Component Writer's Guide</TH
  50 ></TR
  51 ><TR
  52 ><TD
  53 WIDTH="10%"
  54 ALIGN="left"
  55 VALIGN="bottom"
  56 ><A
  57 HREF="build.tests.html"
  58 ACCESSKEY="P"
  59 >Prev</A
  60 ></TD
  61 ><TD
  62 WIDTH="80%"
  63 ALIGN="center"
  64 VALIGN="bottom"
  65 ></TD
  66 ><TD
  67 WIDTH="10%"
  68 ALIGN="right"
  69 VALIGN="bottom"
  70 ><A
  71 HREF="ref.cdl-option.html"
  72 ACCESSKEY="N"
  73 >Next</A
  74 ></TD
  75 ></TR
  76 ></TABLE
  77 ><HR
  78 ALIGN="LEFT"
  79 WIDTH="100%"></DIV
  80 ><DIV
  81 CLASS="CHAPTER"
  82 ><H1
  83 ><A
  84 NAME="REFERENCE">Chapter 5. CDL Language Specification</H1
  85 ><DIV
  86 CLASS="TOC"
  87 ><DL
  88 ><DT
  89 ><B
  90 >Table of Contents</B
  91 ></DT
  92 ><DT
  93 ><A
  94 HREF="ref.cdl-option.html"
  95 ><TT
  96 CLASS="LITERAL"
  97 >cdl_option</TT
  98 ></A
  99 >&nbsp;--&nbsp;Define a single configuration option</DT
 100 ><DT
 101 ><A
 102 HREF="ref.cdl-component.html"
 103 ><TT
 104 CLASS="LITERAL"
 105 >cdl_component</TT
 106 ></A
 107 >&nbsp;--&nbsp;Define a component, a collection of configuration options</DT
 108 ><DT
 109 ><A
 110 HREF="ref.cdl-package.html"
 111 ><TT
 112 CLASS="LITERAL"
 113 >cdl_package</TT
 114 ></A
 115 >&nbsp;--&nbsp;Define a package, a component that can be distributed</DT
 116 ><DT
 117 ><A
 118 HREF="ref.cdl-interface.html"
 119 ><TT
 120 CLASS="LITERAL"
 121 >cdl_interface</TT
 122 ></A
 123 >&nbsp;--&nbsp;Define an interface, functionality that can be provided by
 124 a number of different implementations.</DT
 125 ><DT
 126 ><A
 127 HREF="ref.active-if.html"
 128 ><SPAN
 129 CLASS="PROPERTY"
 130 >active_if</SPAN
 131 ></A
 132 >&nbsp;--&nbsp;Allow additional control over the active state of an
 133 option or other CDL entity.</DT
 134 ><DT
 135 ><A
 136 HREF="ref.calculated.html"
 137 ><SPAN
 138 CLASS="PROPERTY"
 139 >calculated</SPAN
 140 ></A
 141 >&nbsp;--&nbsp;Used if the current option's value is not user-modifiable,
 142 but is calculated using a suitable CDL expression.</DT
 143 ><DT
 144 ><A
 145 HREF="ref.compile.html"
 146 ><SPAN
 147 CLASS="PROPERTY"
 148 >compile</SPAN
 149 ></A
 150 >&nbsp;--&nbsp;List the source files that should be built if this option
 151 is active and enabled.</DT
 152 ><DT
 153 ><A
 154 HREF="ref.default-value.html"
 155 ><SPAN
 156 CLASS="PROPERTY"
 157 >default_value</SPAN
 158 ></A
 159 >&nbsp;--&nbsp;Provide a default value for this option using a CDL expression.</DT
 160 ><DT
 161 ><A
 162 HREF="ref.define.html"
 163 ><SPAN
 164 CLASS="PROPERTY"
 165 >define</SPAN
 166 ></A
 167 >&nbsp;--&nbsp;Specify additional <TT
 168 CLASS="LITERAL"
 169 >#define</TT
 170 > symbols that
 171 should go into the owning package's configuration header file.</DT
 172 ><DT
 173 ><A
 174 HREF="ref.define-format.html"
 175 ><SPAN
 176 CLASS="PROPERTY"
 177 >define_format</SPAN
 178 ></A
 179 >&nbsp;--&nbsp;Control how an option's value will appear in the
 180 configuration header file.</DT
 181 ><DT
 182 ><A
 183 HREF="ref.define-header.html"
 184 ><SPAN
 185 CLASS="PROPERTY"
 186 >define_header</SPAN
 187 ></A
 188 >&nbsp;--&nbsp;Specify the  configuration header file that
 189 will be generated for a given package.</DT
 190 ><DT
 191 ><A
 192 HREF="ref.define-proc.html"
 193 ><SPAN
 194 CLASS="PROPERTY"
 195 >define_proc</SPAN
 196 ></A
 197 >&nbsp;--&nbsp;Use a fragment of Tcl code to output additional data to
 198 configuration header files.</DT
 199 ><DT
 200 ><A
 201 HREF="ref.description.html"
 202 ><SPAN
 203 CLASS="PROPERTY"
 204 >description</SPAN
 205 ></A
 206 >&nbsp;--&nbsp;Provide a textual description for an option.</DT
 207 ><DT
 208 ><A
 209 HREF="ref.display.html"
 210 ><SPAN
 211 CLASS="PROPERTY"
 212 >display</SPAN
 213 ></A
 214 >&nbsp;--&nbsp;Provide a short string describing this option.</DT
 215 ><DT
 216 ><A
 217 HREF="ref.doc.html"
 218 ><SPAN
 219 CLASS="PROPERTY"
 220 >doc</SPAN
 221 ></A
 222 >&nbsp;--&nbsp;The location of online-documentation for a configuration option.</DT
 223 ><DT
 224 ><A
 225 HREF="ref.flavor.html"
 226 ><SPAN
 227 CLASS="PROPERTY"
 228 >flavor</SPAN
 229 ></A
 230 >&nbsp;--&nbsp;Specify the nature of a configuration option.</DT
 231 ><DT
 232 ><A
 233 HREF="ref.hardware.html"
 234 ><SPAN
 235 CLASS="PROPERTY"
 236 >hardware</SPAN
 237 ></A
 238 >&nbsp;--&nbsp;Specify that a package is tied to specific hardware.</DT
 239 ><DT
 240 ><A
 241 HREF="ref.if-define.html"
 242 ><SPAN
 243 CLASS="PROPERTY"
 244 >if_define</SPAN
 245 ></A
 246 >&nbsp;--&nbsp;Output a common preprocessor construct to a configuration
 247 header file.</DT
 248 ><DT
 249 ><A
 250 HREF="ref.implements.html"
 251 ><SPAN
 252 CLASS="PROPERTY"
 253 >implements</SPAN
 254 ></A
 255 >&nbsp;--&nbsp;Enabling this option provides one instance of a more
 256 general interface.</DT
 257 ><DT
 258 ><A
 259 HREF="ref.include-dir.html"
 260 ><SPAN
 261 CLASS="PROPERTY"
 262 >include_dir</SPAN
 263 ></A
 264 >&nbsp;--&nbsp;Specify the desired location of a package's exported
 265 header files in the install tree.</DT
 266 ><DT
 267 ><A
 268 HREF="ref.include-files.html"
 269 ><SPAN
 270 CLASS="PROPERTY"
 271 >include_files</SPAN
 272 ></A
 273 >&nbsp;--&nbsp;List the header files that are exported by a package.</DT
 274 ><DT
 275 ><A
 276 HREF="ref.legal-values.html"
 277 ><SPAN
 278 CLASS="PROPERTY"
 279 >legal_values</SPAN
 280 ></A
 281 >&nbsp;--&nbsp;Impose constraints on the possible values for an option.</DT
 282 ><DT
 283 ><A
 284 HREF="ref.library.html"
 285 ><SPAN
 286 CLASS="PROPERTY"
 287 >library</SPAN
 288 ></A
 289 >&nbsp;--&nbsp;Specify which library should contain the object files
 290 generated by building this package.</DT
 291 ><DT
 292 ><A
 293 HREF="ref.make.html"
 294 ><SPAN
 295 CLASS="PROPERTY"
 296 >make</SPAN
 297 ></A
 298 >&nbsp;--&nbsp;Define an additional custom build step associated with an
 299 option, resulting in a target that should not go directly into a library.</DT
 300 ><DT
 301 ><A
 302 HREF="ref.make-object.html"
 303 ><SPAN
 304 CLASS="PROPERTY"
 305 >make_object</SPAN
 306 ></A
 307 >&nbsp;--&nbsp;Define a custom build step, resulting in an object file
 308 that should go into a library.</DT
 309 ><DT
 310 ><A
 311 HREF="ref.no-define.html"
 312 ><SPAN
 313 CLASS="PROPERTY"
 314 >no_define</SPAN
 315 ></A
 316 >&nbsp;--&nbsp;Suppress the normal generation of a preprocessor
 317 <TT
 318 CLASS="LITERAL"
 319 >#define</TT
 320 > symbol in a configuration header file.</DT
 321 ><DT
 322 ><A
 323 HREF="ref.parent.html"
 324 ><SPAN
 325 CLASS="PROPERTY"
 326 >parent</SPAN
 327 ></A
 328 >&nbsp;--&nbsp;Control the location of an option in the configuration hierarchy.</DT
 329 ><DT
 330 ><A
 331 HREF="ref.requires.html"
 332 ><SPAN
 333 CLASS="PROPERTY"
 334 >requires</SPAN
 335 ></A
 336 >&nbsp;--&nbsp;List constraints that the configuration should satisfy if
 337 a given option is active and enabled..</DT
 338 ><DT
 339 ><A
 340 HREF="ref.script.html"
 341 ><SPAN
 342 CLASS="PROPERTY"
 343 >script</SPAN
 344 ></A
 345 >&nbsp;--&nbsp;Include additional configuration information from another
 346 CDL script.</DT
 347 ></DL
 348 ></DIV
 349 ><P
 350 >This chapter contains reference information for the main <SPAN
 351 CLASS="APPLICATION"
 352 >CDL</SPAN
 353 >
 354 commands <TT
 355 CLASS="LITERAL"
 356 >cdl_option</TT
 357 >, <TT
 358 CLASS="LITERAL"
 359 >cdl_component</TT
 360 >, <TT
 361 CLASS="LITERAL"
 362 >cdl_package</TT
 363 > and
 364 <TT
 365 CLASS="LITERAL"
 366 >cdl_interface</TT
 367 >, followed by the various properties such as
 368 <SPAN
 369 CLASS="PROPERTY"
 370 >active_if</SPAN
 371 > and <SPAN
 372 CLASS="PROPERTY"
 373 >compile</SPAN
 374 > in alphabetical order.</P
 375 ></DIV
 376 ><DIV
 377 CLASS="NAVFOOTER"
 378 ><HR
 379 ALIGN="LEFT"
 380 WIDTH="100%"><TABLE
 381 SUMMARY="Footer navigation table"
 382 WIDTH="100%"
 383 BORDER="0"
 384 CELLPADDING="0"
 385 CELLSPACING="0"
 386 ><TR
 387 ><TD
 388 WIDTH="33%"
 389 ALIGN="left"
 390 VALIGN="top"
 391 ><A
 392 HREF="build.tests.html"
 393 ACCESSKEY="P"
 394 >Prev</A
 395 ></TD
 396 ><TD
 397 WIDTH="34%"
 398 ALIGN="center"
 399 VALIGN="top"
 400 ><A
 401 HREF="cdl-guide.html"
 402 ACCESSKEY="H"
 403 >Home</A
 404 ></TD
 405 ><TD
 406 WIDTH="33%"
 407 ALIGN="right"
 408 VALIGN="top"
 409 ><A
 410 HREF="ref.cdl-option.html"
 411 ACCESSKEY="N"
 412 >Next</A
 413 ></TD
 414 ></TR
 415 ><TR
 416 ><TD
 417 WIDTH="33%"
 418 ALIGN="left"
 419 VALIGN="top"
 420 >Building Test Cases</TD
 421 ><TD
 422 WIDTH="34%"
 423 ALIGN="center"
 424 VALIGN="top"
 425 >&nbsp;</TD
 426 ><TD
 427 WIDTH="33%"
 428 ALIGN="right"
 429 VALIGN="top"
 430 ><TT
 431 CLASS="LITERAL"
 432 >cdl_option</TT
 433 ></TD
 434 ></TR
 435 ></TABLE
 436 ></DIV
 437 ></BODY
 438 ></HTML
 439 >