README: Add an example of adding a new board.
PATCH v2 1/1 README: Add an example of adding a new board.
Show the simple end result of adding an example board (BeagleBoard).
---
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.
README +69 -0
@@ -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 <[email protected]> + + 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
========================================================================
PATCH v2 1/1 README: Add an example of adding a new board.
Dear "Robert P. J. Day",
Quoted 4 lines · 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 <[email protected]>
This text is still inconsistent and not good enough as an example.
Quoted 4 lines
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?
Quoted 7 lines
README +7
-0+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
README steps: · line 2893
Quoted 10 lines
README +10
-0+end result. + + First, the new BeagleBoard-related files: + + ./board/ti/beagle/ + beagle.c + beagle.h + config.mk + Makefile + ./include/configs/omap3_beagle.h
Please do add a comment why this is not a good example.
README steps: · line 2898
Quoted 4 lines
README +4
-0+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.
...
Quoted 2 lines
README +2
-0+ MAKEALL + =======
...
README steps: · line 2913
Quoted 2 lines
README +2
-0+ include/asm-arm/types.h + =======================
NAK. This has been mentioned before.
README steps: · line 2928
Quoted 2 lines
README +2
-0+ doc/README.omap3 + ================
Thi sis not strictly necessary.
README steps: · line 2936
Quoted 7 lines
README +7
-0+ 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.
README steps: · line 2939
Quoted 2 lines
README +2
-0+ MAINTAINERS + ===========
...
Best regards,
Wolfgang Denk
Signature · 7 lines
DENX Software Engineering GmbH, MD: Wolfgang Denk & Detlev Zundel HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de "Logic and practical information do not seem to apply here." "You admit that?" "To deny the facts would be illogical, Doctor" -- Spock and McCoy, "A Piece of the Action", stardate unknown
PATCH v2 1/1 README: Add an example of adding a new board.
Quoted 10 lines · Wolfgang Denk
Dear "Robert P. J. Day",
Quoted 4 lines · 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 <[email protected]>This text is still inconsistent and not good enough as an example.
Quoted 7 lines
Quoted 5 lines
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
========================================================================
PATCH v2 1/1 README: Add an example of adding a new board.
Dear "Robert P. J. Day",
Quoted 3 lines · 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
Signature · 4 lines
DENX Software Engineering GmbH, MD: Wolfgang Denk & Detlev Zundel HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de Weekends were made for programming. - Karl Lehenbauer