summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorJuergen Beisert <jbe@isonoe.(none)>2007-10-19 13:19:43 +0200
committerJuergen Beisert <jbe@isonoe.(none)>2007-10-19 13:19:43 +0200
commitb21ed7177c94b805ab0433049a8950d9ef770f19 (patch)
treea2253ff8573c62b4d1badb3b7e078c5e25a03950 /Documentation
parentf855f6e865e457e220fce0caad70f29d3e9aaef3 (diff)
downloadbarebox-b21ed7177c94b805ab0433049a8950d9ef770f19.tar.gz
barebox-b21ed7177c94b805ab0433049a8950d9ef770f19.tar.xz
basic doc structure added
Diffstat (limited to 'Documentation')
-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
4 files changed, 42 insertions, 0 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