summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Documentation/boards.dox15
-rw-r--r--Documentation/developers_manual.dox13
-rw-r--r--Documentation/uboot-main.dox6
-rw-r--r--Documentation/users_manual.dox8
-rw-r--r--Doxyfile3
-rw-r--r--arch/architecture.dox15
-rw-r--r--arch/arm/mach-arm.dox9
-rw-r--r--arch/blackfin/mach-bf.dox9
-rw-r--r--arch/ppc/mach-ppc.dox9
-rw-r--r--board/board.dox5
10 files changed, 91 insertions, 1 deletions
diff --git a/Documentation/boards.dox b/Documentation/boards.dox
new file mode 100644
index 0000000000..9810262f65
--- /dev/null
+++ b/Documentation/boards.dox
@@ -0,0 +1,15 @@
+/** @page supported_boards
+
+This is a list of boards that are currently supported by UBootv2.
+
+
+*/
+
+/* TODO
+ *
+ * Add documentation to your boardfile, forward it with doxygen's page
+ * feature (@page <reference>) and include it here with:
+ *
+ * @subpage <reference>
+ *
+ */
diff --git a/Documentation/developers_manual.dox b/Documentation/developers_manual.dox
new file mode 100644
index 0000000000..8978ab955c
--- /dev/null
+++ b/Documentation/developers_manual.dox
@@ -0,0 +1,13 @@
+/** @page developers_manual Developer's Manual
+
+FIXME: Hints and tips for simply adapting UBootv2
+
+@subpage dev_board
+
+@subpage dev_cpu
+
+@subpage dev_architecture
+
+@subpage dev_params
+
+*/ \ No newline at end of file
diff --git a/Documentation/uboot-main.dox b/Documentation/uboot-main.dox
index 694989bdd7..377f5943cd 100644
--- a/Documentation/uboot-main.dox
+++ b/Documentation/uboot-main.dox
@@ -214,4 +214,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston,
MA 02111-1307 USA
@endverbatim
+@subpage users_manual
+
+@subpage developers_manual
+
+@subpage supported_boards
+
*/
diff --git a/Documentation/users_manual.dox b/Documentation/users_manual.dox
new file mode 100644
index 0000000000..232c0f5445
--- /dev/null
+++ b/Documentation/users_manual.dox
@@ -0,0 +1,8 @@
+/** @page users_manual User's Manual
+
+FIXME: Hints and tips for simply using UBootv2
+
+@subpage command_reference
+@subpage partitions
+
+*/ \ No newline at end of file
diff --git a/Doxyfile b/Doxyfile
index 419676b53e..e8dfdea862 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -464,7 +464,8 @@ INPUT = Documentation \
arch \
drivers \
commands \
- common
+ common \
+ board
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
diff --git a/arch/architecture.dox b/arch/architecture.dox
new file mode 100644
index 0000000000..e2356bbd73
--- /dev/null
+++ b/arch/architecture.dox
@@ -0,0 +1,15 @@
+/** @page dev_architecture Integrate a new architecture (ARCH)
+
+Friesel
+
+*/
+
+/** @page dev_cpu Intergrate a new CPU (MACH)
+
+Frasel
+
+@subpage dev_arm_mach
+@subpage dev_bf_mach
+@subpage dev_ppc_mach
+
+*/
diff --git a/arch/arm/mach-arm.dox b/arch/arm/mach-arm.dox
new file mode 100644
index 0000000000..9d311a82f9
--- /dev/null
+++ b/arch/arm/mach-arm.dox
@@ -0,0 +1,9 @@
+/* This document is intended to provide the developer with information
+ * how to integrate a new CPU (MACH) into this part of the UBoot tree
+ */
+
+/** @page dev_arm_mach ARM based CPU (MACH) into the tree
+
+FIXME
+
+*/
diff --git a/arch/blackfin/mach-bf.dox b/arch/blackfin/mach-bf.dox
new file mode 100644
index 0000000000..9812acec35
--- /dev/null
+++ b/arch/blackfin/mach-bf.dox
@@ -0,0 +1,9 @@
+/* This document is intended to provide the developer with information
+ * how to integrate a new CPU (MACH) into this part of the UBoot tree
+ */
+
+/** @page dev_bf_mach Blackfin based CPU (MACH) into the tree
+
+FIXME
+
+*/
diff --git a/arch/ppc/mach-ppc.dox b/arch/ppc/mach-ppc.dox
new file mode 100644
index 0000000000..01343a34eb
--- /dev/null
+++ b/arch/ppc/mach-ppc.dox
@@ -0,0 +1,9 @@
+/* This document is intended to provide the developer with information
+ * how to integrate a new CPU (MACH) into this part of the UBoot tree
+ */
+
+/** @page dev_ppc_mach PowerPC based CPU into the tree
+
+FIXME
+
+*/
diff --git a/board/board.dox b/board/board.dox
new file mode 100644
index 0000000000..a68a96aed1
--- /dev/null
+++ b/board/board.dox
@@ -0,0 +1,5 @@
+/** @page dev_board Intergrating a new board
+
+Blablubb
+
+*/