[U-Boot] [PATCH v2] README: Add an example of adding a new board.
Show the simple end result of adding an example board (BeagleBoard).
Signed-off-by: Robert P. J. Day rpjday@crashcourse.ca
---
based on dirk's earlier email, i'm emphasizing that this represents only the *end result* of adding BeagleBoard support to U-Boot. anything more involved than that wouldn't really belong in the README and would more properly be described in, say, an ARM porting guide.
diff --git a/README b/README index 2c77687..3e5bb69 100644 --- a/README +++ b/README @@ -2874,6 +2874,75 @@ steps: [Of course, this last step is much harder than it sounds.]
+A real-life example of adding a new board +========================================= + + As a working example of the end result of adding a new board, +here's a list of files and directories that were added/changed to +support the OMAP3-based BeagleBoard. Note that these changes don't +represent *how* this board was added, they represent only the +end result. + + First, the new BeagleBoard-related files: + + ./board/ti/beagle/ + beagle.c + beagle.h + config.mk + Makefile + ./include/configs/omap3_beagle.h + +Followed by eventual changes to some existing files: + + Makefile + ======== + + omap3_beagle_config : unconfig + @$(MKCONFIG) $(@:_config=) arm arm_cortexa8 beagle ti omap3 + + MAKEALL + ======= + + LIST_ARM_CORTEX_A8=" \ + devkit8000 \ + omap3_beagle \ + omap3_overo \ + ... + + include/asm-arm/types.h + ======================= + + #ifdef CONFIG_MACH_OMAP3_BEAGLE + # ifdef machine_arch_type + # undef machine_arch_type + # define machine_arch_type __machine_arch_type + # else + # define machine_arch_type MACH_TYPE_OMAP3_BEAGLE + # endif + # define machine_is_omap3_beagle() (machine_arch_type == MACH_TYPE_OMAP3_BEAGLE) + #else + # define machine_is_omap3_beagle() (0) + #endif + + doc/README.omap3 + ================ + + Build + ===== + + * BeagleBoard: + + make omap3_beagle_config + make + + MAINTAINERS + =========== + + Dirk Behme dirk.behme@gmail.com + + omap3_beagle ARM CORTEX-A8 (OMAP3530 SoC) + + Testing of U-Boot Modifications, Ports to New Hardware, etc.: ==============================================================
rday --
======================================================================== Robert P. J. Day Waterloo, Ontario, CANADA
Linux Consulting, Training and Kernel Pedantry.
Web page: http://crashcourse.ca Twitter: http://twitter.com/rpjday ========================================================================
Dear "Robert P. J. Day",
In message alpine.LFD.2.00.0911170707400.7159@localhost you wrote:
Show the simple end result of adding an example board (BeagleBoard).
Signed-off-by: Robert P. J. Day rpjday@crashcourse.ca
This text is still inconsistent and not good enough as an example.
based on dirk's earlier email, i'm emphasizing that this represents only the *end result* of adding BeagleBoard support to U-Boot. anything more involved than that wouldn't really belong in the README and would more properly be described in, say, an ARM porting guide.
How about adding an entry in the U-Boot wiki?
+A real-life example of adding a new board +=========================================
- As a working example of the end result of adding a new board,
+here's a list of files and directories that were added/changed to +support the OMAP3-based BeagleBoard. Note that these changes don't +represent *how* this board was added, they represent only the +end result.
- First, the new BeagleBoard-related files:
- ./board/ti/beagle/
beagle.cbeagle.hconfig.mkMakefile- ./include/configs/omap3_beagle.h
Please do add a comment why this is not a good example.
+Followed by eventual changes to some existing files:
- Makefile
- ========
I think it would make more sense to list the modified files first, and then eventually add description of the changes later.
...
- MAKEALL
- =======
...
- include/asm-arm/types.h
- =======================
NAK. This has been mentioned before.
- doc/README.omap3
- ================
Thi sis not strictly necessary.
- Build
- =====
- BeagleBoard:
- make omap3_beagle_config
- make
This section does not belong here, in the middle of the list of modified files. Move down, or omit it.
- MAINTAINERS
- ===========
...
Best regards,
Wolfgang Denk
On Tue, 17 Nov 2009, Wolfgang Denk wrote:
Dear "Robert P. J. Day",
In message alpine.LFD.2.00.0911170707400.7159@localhost you wrote:
Show the simple end result of adding an example board (BeagleBoard).
Signed-off-by: Robert P. J. Day rpjday@crashcourse.ca
This text is still inconsistent and not good enough as an example.
based on dirk's earlier email, i'm emphasizing that this represents only the *end result* of adding BeagleBoard support to U-Boot. anything more involved than that wouldn't really belong in the README and would more properly be described in, say, an ARM porting guide.
How about adding an entry in the U-Boot wiki?
ok, that's fair.
rday
p.s. is there a "trivial" patch email address for simple things like typoes, just to keep this main list for more important stuff?
======================================================================== Robert P. J. Day Waterloo, Ontario, CANADA
Linux Consulting, Training and Kernel Pedantry.
Web page: http://crashcourse.ca Twitter: http://twitter.com/rpjday ========================================================================
Dear "Robert P. J. Day",
In message alpine.LFD.2.00.0911180024280.13228@localhost you wrote:
p.s. is there a "trivial" patch email address for simple things like typoes, just to keep this main list for more important stuff?
No. All patches shall go though a central place (i. e. this list).
Best regards,
Wolfgang Denk
participants (2)
-
Robert P. J. Day -
Wolfgang Denk