summaryrefslogtreecommitdiff
path: root/nuttx/Documentation/NuttxPortingGuide.html
diff options
context:
space:
mode:
authorpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2007-03-26 16:47:17 +0000
committerpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2007-03-26 16:47:17 +0000
commit899c7204851d44de519804af8a75e0b459012e9f (patch)
tree449ad4c5decd48591605264d1a881a4b81b9bdce /nuttx/Documentation/NuttxPortingGuide.html
parent3a5002af1855fbc7989ea994301abaa420be6db3 (diff)
downloadnuttx-899c7204851d44de519804af8a75e0b459012e9f.tar.gz
nuttx-899c7204851d44de519804af8a75e0b459012e9f.tar.bz2
nuttx-899c7204851d44de519804af8a75e0b459012e9f.zip
Create a place to hold board specific header files
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@146 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'nuttx/Documentation/NuttxPortingGuide.html')
-rw-r--r--nuttx/Documentation/NuttxPortingGuide.html14
1 files changed, 12 insertions, 2 deletions
diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html
index f1ac32c48..c970198fc 100644
--- a/nuttx/Documentation/NuttxPortingGuide.html
+++ b/nuttx/Documentation/NuttxPortingGuide.html
@@ -173,12 +173,12 @@ below and discussed in the following paragraphs:</p>
</p>
<ul><pre>
&lt;<i>arch-name</i>&gt;
- |-- include
+ |-- include/
| |-- arch.h
| |-- irq.h
| |-- types.h
| `-- limits.h
- `-- src
+ `-- src/
|-- Makefile
`-- <i>(architecture-specific source files)</i>
</pre></ul>
@@ -294,6 +294,7 @@ below and discussed in the following paragraphs:</p>
</p>
<ul><pre>
&lt;<i>board-name</i>&gt;
+ |-- include/
|-- Make.defs
|-- defconfig
`-- setenv.sh
@@ -302,6 +303,14 @@ below and discussed in the following paragraphs:</p>
<h3><a name="#summaryofconfigfiles">2.3.2 Summary of Files</a></h3>
<ul>
<li>
+ <code>include/</code>:
+ This directory contains board specific header files.
+ This directory will be linked as <code>include/arch/board</code> at configuration time
+ and can be included via <code>#include &lt;arch/board/header.h&gt;</code>.
+ These header file can only be included by files in <code>arch/&lt;arch-name&gt;/include/</code>
+ and <code>arch/&lt;arch-name&gt;/src/</code>.
+ </li>
+ <li>
<code>Make.defs</code>: This makefile fragment provides architecture and
tool-specific build options. It will be included by all other
makefiles in the build (once it is installed). This make fragment
@@ -316,6 +325,7 @@ below and discussed in the following paragraphs:</p>
fragment may include ${TOPDIR}/.config to perform configuration
specific settings. For example, the CFLAGS will most likely be
different if CONFIG_DEBUG=y.
+ </p>
</li>
<li>
<code>defconfig</code>: This is a configuration file similar to the Linux