From mboxrd@z Thu Jan 1 00:00:00 1970 Return-path: Received: from 68.mail-out.ovh.net ([91.121.185.69]) by bombadil.infradead.org with smtp (Exim 4.72 #1 (Red Hat Linux)) id 1On4Mc-0001pH-M7 for barebox@lists.infradead.org; Sun, 22 Aug 2010 06:49:07 +0000 From: Jean-Christophe PLAGNIOL-VILLARD Date: Sun, 22 Aug 2010 08:48:56 +0200 Message-Id: <1282459736-2378-1-git-send-email-plagnioj@jcrosoft.com> List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: barebox-bounces@lists.infradead.org Errors-To: barebox-bounces+u.kleine-koenig=pengutronix.de@lists.infradead.org Subject: [PATCH] move board.dox to Documentation and update it To: barebox@lists.infradead.org Signed-off-by: Jean-Christophe PLAGNIOL-VILLARD --- Documentation/board.dox | 95 ++++++++++++++++++++++++++++++++++++++++++ Documentation/manual_org.dox | 4 +- board/board.dox | 95 ------------------------------------------ 3 files changed, 97 insertions(+), 97 deletions(-) create mode 100644 Documentation/board.dox delete mode 100644 board/board.dox diff --git a/Documentation/board.dox b/Documentation/board.dox new file mode 100644 index 0000000..07425e4 --- /dev/null +++ b/Documentation/board.dox @@ -0,0 +1,95 @@ +/** @page dev_board Adapting a new Board + +To add a new board to @a barebox a few steps must be done, to extend and modify +the @a barebox source tree. + +@section board_add_files Files/Directories to be added + + - arch/\/boards/\ + - arch/\/boards/\/Makefile + - arch/\/boards/\/\.c + - arch/\/boards/\/\.dox + - include/configs/\.h + - arch/\/configs/\_defconfig + +@subsection board_makefile arch/\/boards/\Makefile + +@verbatim + obj-y += all files that builds the BSP (Assembler and/or C files) +@endverbatim + +@subsection board_basefile arch/\/boards/\\.c + +TBD + +@subsection board_doxygen arch/\/boards/\/\.dox + +This file should describe in short words your new board, what CPU +it uses, what resources are provided and features it supports. + +Use the doxygen style for this kind of documentation. Below you find a +template for this kind of file: + +@verbatim +/** @page + +This board uses an based CPU. The board is shipped with: + +- many MiB NOR type Flash Memory +- many MiB SDRAM +- a very special network controller + +and so on. + +*/ +@endverbatim + +To make your new shiny file visible in the automatically generated +documentation you must sort in the used page lable ("" in the +template above) into Documentation/boards.dox as: + +@verbatim + ... + @subpage + ... +@endverbatim + +at the right architecture. + +@note Consider to use an unique page lable. + +@subsection board_lscript arch/\/boards/\/barebox.lds.S + +If your board needs a special binary @a barebox layout, you can provide a local +board linker script file. This will replace the generic one provided by your +architecture or CPU support. + +Add this file with + +@verbatim + extra-y += +@endverbatim + +in your local \b Makefile to the list of files, forwarded to the last linking step. + +@section board_defconfig arch/\/configs/\_defconfig + +TBD + +@section board_mod_files These files needs to be modified: + + - modify Documentation/board.dox + - modify arch/\/Kconfig + - add your board (MACH_*) to the list + - add your default text base address for this architecture (ARCH_TEXT_BASE) + - add BOARDINFO with valueable info for your board + - modify arch/\/Makefile: + - add board-$(MACH_*) = \ + +First, the new board should be visible in the menu. + +@section board_specific_cpu Porting hints for specific CPUs + +@li @subpage dev_s3c24xx_mach + +*/ diff --git a/Documentation/manual_org.dox b/Documentation/manual_org.dox index 6f3b157..17238f0 100644 --- a/Documentation/manual_org.dox +++ b/Documentation/manual_org.dox @@ -10,7 +10,7 @@ than listed here. But these files are the main control files: - Documentation/users_manual.dox - Documentation/commands.dox - Documentation/developers_manual.dox - - board/board.dox + - Documentation/board.dox - arch/architecture.dox - arch/arm/mach-arm.dox - arch/blackfin/mach-bf.dox @@ -24,4 +24,4 @@ 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 +*/ diff --git a/board/board.dox b/board/board.dox deleted file mode 100644 index 6bda416..0000000 --- a/board/board.dox +++ /dev/null @@ -1,95 +0,0 @@ -/** @page dev_board Adapting a new Board - -To add a new board to @a barebox a few steps must be done, to extend and modify -the @a barebox source tree. - -@section board_add_files Files/Directories to be added - - - arch/\/boards/\ - - arch/\/boards/\/Makefile - - arch/\/boards/\/\.c - - arch/\/boards/\/\.dox - - include/configs/\.h - - arch/\/configs/\_defconfig - -@subsection board_makefile arch/\/boards/\Makefile - -@verbatim - obj-y += all files that builds the BSP (Assembler and/or C files) -@endverbatim - -@subsection board_basefile arch/\/boards/\\.c - -TBD - -@subsection board_doxygen arch/\/boards/\/\.dox - -This file should describe in short words your new board, what CPU -it uses, what resources are provided and features it supports. - -Use the doxygen style for this kind of documentation. Below you find a -template for this kind of file: - -@verbatim -/** @page - -This board uses an based CPU. The board is shipped with: - -- many MiB NOR type Flash Memory -- many MiB SDRAM -- a very special network controller - -and so on. - -*/ -@endverbatim - -To make your new shiny file visible in the automatically generated -documentation you must sort in the used page lable ("" in the -template above) into Documentation/boards.dox as: - -@verbatim - ... - @subpage - ... -@endverbatim - -at the right architecture. - -@note Consider to use an unique page lable. - -@subsection board_lscript arch/\/boards/\/barebox.lds.S - -If your board needs a special binary @a barebox layout, you can provide a local -board linker script file. This will replace the generic one provided by your -architecture or CPU support. - -Add this file with - -@verbatim - extra-y += -@endverbatim - -in your local \b Makefile to the list of files, forwarded to the last linking step. - -@section board_defconfig arch/\/configs/\_defconfig - -TBD - -@section board_mod_files These files needs to be modified: - - - modify board/board.dox - - modify arch/\/Kconfig - - add your board (MACH_*) to the list - - add your default text base address for this architecture (ARCH_TEXT_BASE) - - add BOARDINFO with valueable info for your board - - modify arch/\/Makefile: - - add board-$(MACH_*) = \ - -First, the new board should be visible in the menu. - -@section board_specific_cpu Porting hints for specific CPUs - -@li @subpage dev_s3c24xx_mach - -*/ -- 1.7.1 _______________________________________________ barebox mailing list barebox@lists.infradead.org http://lists.infradead.org/mailman/listinfo/barebox