summaryrefslogtreecommitdiffstats
path: root/arch/architecture.dox
diff options
context:
space:
mode:
authorJuergen Beisert <jbe@pengutronix.de>2009-12-15 11:32:02 +0100
committerSascha Hauer <s.hauer@pengutronix.de>2009-12-15 11:32:02 +0100
commitdac84c7b9d67c2f831adb53a41f53a9f7330acdb (patch)
tree4e6e7ad95e421fd8e0f4a7eb1771b7391f8f1f1f /arch/architecture.dox
parentf3d6e2f8f93b6f0d9b8ca68bc7978ea3036636be (diff)
downloadbarebox-dac84c7b9d67c2f831adb53a41f53a9f7330acdb.tar.gz
barebox-dac84c7b9d67c2f831adb53a41f53a9f7330acdb.tar.xz
documentation updates
Signed-off-by: Juergen Beisert <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'arch/architecture.dox')
-rw-r--r--arch/architecture.dox12
1 files changed, 6 insertions, 6 deletions
diff --git a/arch/architecture.dox b/arch/architecture.dox
index b1e32a5328..669c028435 100644
--- a/arch/architecture.dox
+++ b/arch/architecture.dox
@@ -5,7 +5,7 @@
Never include an object file by name directly! Linker Script Files defines the
layout, not the content. Content is defined in objecfiles instead.
-Don't rely on the given object file order to create your binary barebox! This
+Don't rely on the given object file order to create your binary @a barebox! This
may work, but is not relyable in all cases (and its a very bad style)!
For the special case some layout contraints exists, use specific section
@@ -19,11 +19,11 @@ For example the ARM architecture starts its reset code at address 0x0000000,
the x86 architecture at 0x000FFFF0, PowerPC at 0x00000100 or 0xFFFFF100.
So for the special reset code on all architectures it must be located at
-architecture specific locations within the binary barebox image.
+architecture specific locations within the binary @a barebox image.
All reset code uses section ".text_entry" for its localisation within the
-binary barebox image. Its up to the linker script file to use this section name
-to find the right place in whatever environment and barebox sizes.
+binary @a barebox image. Its up to the linker script file to use this section name
+to find the right place in whatever environment and @a barebox sizes.
@code
.section ".text_entry","ax"
@@ -45,7 +45,7 @@ Features required for every CPU:
@section time_keeping Time keeping
-In barebox we are using the clocksource mechanism from the Linux Kernel.
+In @a barebox we are using the clocksource mechanism from the Linux Kernel.
This makes it fairly easy to add timer functionality for a new board or
architecture.
@@ -78,7 +78,7 @@ the Linux Kernel can be used nearly 1:1, except for the register accesses.
Note: For clocksources the __lshrdi3 symbol is needed. You can find the
function for your architecture in the Linux Kernel or a libc of your choice.
-Note: barebox expects an upward counting counter!
+@note @a barebox expects an upward counting counter!
@section reset_function Reset function