From: Wolfgang Denk Date: Tue, 17 Nov 2009 20:50:14 +0100 Subject: [U-Boot] [PATCH v2] README: Add an example of adding a new board. In-Reply-To: References: Message-ID: <20091117195014.7590BF51B07@gemini.denx.de> List-Id: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: u-boot@lists.denx.de Dear "Robert P. J. Day", In message you wrote: > > Show the simple end result of adding an example board (BeagleBoard). > > Signed-off-by: Robert P. J. Day 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.c > + beagle.h > + config.mk > + Makefile > + ./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 -- 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