summaryrefslogtreecommitdiffstats
path: root/Documentation/manual_org.dox
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/manual_org.dox')
-rw-r--r--Documentation/manual_org.dox27
1 files changed, 27 insertions, 0 deletions
diff --git a/Documentation/manual_org.dox b/Documentation/manual_org.dox
new file mode 100644
index 0000000000..f9cb238a4b
--- /dev/null
+++ b/Documentation/manual_org.dox
@@ -0,0 +1,27 @@
+/** @page manual_org Organisation of this Manual
+
+There is no fixed organisation in this manual, as various source files forwards
+their content into different parts. So there are more visible menu entries,
+than listed here. But these files are the main control files:
+
+ - Documentation
+ - Documentation/Doxyfile
+ - Documentation/uboot-main.dox
+ - Documentation/users_manual.dox
+ - Documentation/commands.dox
+ - Documentation/developers_manual.dox
+ - board/board.dox
+ - arch/architecture.dox
+ - arch/arm/mach-arm.dox
+ - arch/blackfin/mach-bf.dox
+ - arch/ppc/mach-ppc.dox
+ - Documentation/parameters.dox
+ - Documentation/boards.dox
+ - various documentation files from the board directory
+
+New commands should forward their content to Documentation/commands.dox, so
+their pages should be listed in this file.
+
+New boards should forward their content to Documentation/boards.dox, so
+their pages should be listed in this file.
+*/ \ No newline at end of file