doc/html/user-guide/install-tree.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 >Install Tree</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="eCos User Guide"
  20 HREF="ecos-user-guide.html"><LINK
  21 REL="UP"
  22 TITLE="The Component Repository and Working Directories"
  23 HREF="component-repo-and-working-dirs.html"><LINK
  24 REL="PREVIOUS"
  25 TITLE="Build Tree"
  26 HREF="build-tree.html"><LINK
  27 REL="NEXT"
  28 TITLE="Application Build Tree"
  29 HREF="repository-app-build-tree.html"></HEAD
  30 ><BODY
  31 CLASS="SECT1"
  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 >eCos User Guide</TH
  50 ></TR
  51 ><TR
  52 ><TD
  53 WIDTH="10%"
  54 ALIGN="left"
  55 VALIGN="bottom"
  56 ><A
  57 HREF="build-tree.html"
  58 ACCESSKEY="P"
  59 >Prev</A
  60 ></TD
  61 ><TD
  62 WIDTH="80%"
  63 ALIGN="center"
  64 VALIGN="bottom"
  65 >Chapter 25. The Component Repository and Working Directories</TD
  66 ><TD
  67 WIDTH="10%"
  68 ALIGN="right"
  69 VALIGN="bottom"
  70 ><A
  71 HREF="repository-app-build-tree.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="SECT1"
  82 ><H1
  83 CLASS="SECT1"
  84 ><A
  85 NAME="INSTALL-TREE">Install Tree</H1
  86 ><P
  87 >The <I
  88 CLASS="FIRSTTERM"
  89 >install tree</I
  90 > is the location
  91           for all files needed for application development. The
  92           <TT
  93 CLASS="FILENAME"
  94 >libtarget.a</TT
  95 > library, which contains the
  96             custom-built <SPAN
  97 CLASS="PRODUCTNAME"
  98 >eCos</SPAN
  99 > kernel and other components, is placed
 100             in the install tree, along with all packages&#8217; public
 101             header files. If you build the tests, the test executable
 102             programs will also be placed in the install
 103             tree. </P
 104 ><P
 105 >By default, the install tree is created by
 106           <B
 107 CLASS="COMMAND"
 108 >ecosconfig</B
 109 > in a subdirectory of the build
 110           tree called <TT
 111 CLASS="FILENAME"
 112 >install</TT
 113 >. This can be
 114           modified with the <TT
 115 CLASS="OPTION"
 116 >--prefix</TT
 117 > option (see
 118           <A
 119 HREF="manual-configuration.html"
 120 >Chapter 28</A
 121 >).
 122         </P
 123 ><DIV
 124 CLASS="SECT2"
 125 ><H2
 126 CLASS="SECT2"
 127 ><A
 128 NAME="AEN2130">Purpose</H2
 129 ><P
 130 >The install tree is where the custom-built
 131             <TT
 132 CLASS="FILENAME"
 133 >libtarget.a</TT
 134 > library, which contains
 135             the <SPAN
 136 CLASS="PRODUCTNAME"
 137 >eCos</SPAN
 138 > kernel and other components, is located. The
 139             install tree is also the location for all the header files
 140             that are part of a published interface for their
 141             component. </P
 142 ></DIV
 143 ><DIV
 144 CLASS="SECT2"
 145 ><H2
 146 CLASS="SECT2"
 147 ><A
 148 NAME="AEN2135">How is it modified?</H2
 149 ><P
 150 >Recompiling can replace
 151             <TT
 152 CLASS="FILENAME"
 153 >libtarget.a</TT
 154 > and the test
 155             executables. </P
 156 ></DIV
 157 ><DIV
 158 CLASS="SECT2"
 159 ><H2
 160 CLASS="SECT2"
 161 ><A
 162 NAME="AEN2139">When is it edited manually?</H2
 163 ><P
 164 >Where a memory layout requires modification without
 165             use of the <SPAN
 166 CLASS="PRODUCTNAME"
 167 >eCos</SPAN
 168 > <SPAN
 169 CLASS="APPLICATION"
 170 >Configuration Tool</SPAN
 171 >, the memory layout
 172             files must be edited directly in the install tree. These
 173             files are located at
 174             <TT
 175 CLASS="FILENAME"
 176 >install/include/pkgconf/mlt_*.*</TT
 177 >.
 178             Note that subsequent modification of the install tree
 179             using the Configuration Tool will result in such manual
 180             edits being lost.</P
 181 ></DIV
 182 ><DIV
 183 CLASS="SECT2"
 184 ><H2
 185 CLASS="SECT2"
 186 ><A
 187 NAME="AEN2145">User applications</H2
 188 ><P
 189 >User application source or binary code should
 190             <SPAN
 191 CLASS="emphasis"
 192 ><I
 193 CLASS="EMPHASIS"
 194 >not</I
 195 ></SPAN
 196 > go in the install tree. </P
 197 ></DIV
 198 ><DIV
 199 CLASS="SECT2"
 200 ><H2
 201 CLASS="SECT2"
 202 ><A
 203 NAME="AEN2149">Examples of files in this hierarchy</H2
 204 ><P
 205 ></P
 206 ><DIV
 207 CLASS="VARIABLELIST"
 208 ><DL
 209 ><DT
 210 ><TT
 211 CLASS="FILENAME"
 212 >install/lib/libtarget.a</TT
 213 ></DT
 214 ><DD
 215 ><P
 216 >The library containing the kernel and other components.</P
 217 ></DD
 218 ><DT
 219 ><TT
 220 CLASS="FILENAME"
 221 >install/include/cyg/kernel/kapi.h</TT
 222 ></DT
 223 ><DD
 224 ><P
 225 >The header file for the kernel C language API.</P
 226 ></DD
 227 ><DT
 228 ><TT
 229 CLASS="FILENAME"
 230 >install/include/pkgconf/mlt_arm_pid_ram.ldi</TT
 231 ></DT
 232 ><DD
 233 ><P
 234 >The linker script fragment describing the memory
 235                   layout for linking applications intended for
 236                   execution on an ARM PID development board using RAM
 237                   startup.</P
 238 ></DD
 239 ><DT
 240 ><TT
 241 CLASS="FILENAME"
 242 >install/include/stdio.h</TT
 243 ></DT
 244 ><DD
 245 ><P
 246 >The C library header file for standard I/O. </P
 247 ></DD
 248 ></DL
 249 ></DIV
 250 ></DIV
 251 ></DIV
 252 ><DIV
 253 CLASS="NAVFOOTER"
 254 ><HR
 255 ALIGN="LEFT"
 256 WIDTH="100%"><TABLE
 257 SUMMARY="Footer navigation table"
 258 WIDTH="100%"
 259 BORDER="0"
 260 CELLPADDING="0"
 261 CELLSPACING="0"
 262 ><TR
 263 ><TD
 264 WIDTH="33%"
 265 ALIGN="left"
 266 VALIGN="top"
 267 ><A
 268 HREF="build-tree.html"
 269 ACCESSKEY="P"
 270 >Prev</A
 271 ></TD
 272 ><TD
 273 WIDTH="34%"
 274 ALIGN="center"
 275 VALIGN="top"
 276 ><A
 277 HREF="ecos-user-guide.html"
 278 ACCESSKEY="H"
 279 >Home</A
 280 ></TD
 281 ><TD
 282 WIDTH="33%"
 283 ALIGN="right"
 284 VALIGN="top"
 285 ><A
 286 HREF="repository-app-build-tree.html"
 287 ACCESSKEY="N"
 288 >Next</A
 289 ></TD
 290 ></TR
 291 ><TR
 292 ><TD
 293 WIDTH="33%"
 294 ALIGN="left"
 295 VALIGN="top"
 296 >Build Tree</TD
 297 ><TD
 298 WIDTH="34%"
 299 ALIGN="center"
 300 VALIGN="top"
 301 ><A
 302 HREF="component-repo-and-working-dirs.html"
 303 ACCESSKEY="U"
 304 >Up</A
 305 ></TD
 306 ><TD
 307 WIDTH="33%"
 308 ALIGN="right"
 309 VALIGN="top"
 310 >Application Build Tree</TD
 311 ></TR
 312 ></TABLE
 313 ></DIV
 314 ></BODY
 315 ></HTML
 316 >