[U-Boot] organizing doc/ dir?

Peter Tyser ptyser at xes-inc.com
Wed Feb 23 07:26:45 CET 2011


On Wed, 2011-02-23 at 00:02 -0600, Kumar Gala wrote:
> Wolfgang,
> 
> Any issue that added a little hierarchy to the doc/ dir?
> 
> maybe something mimic board/
> 
> for example:
> 
> doc/README.mpc8313erdb  ->      doc/freescale/README.mpc8313erdb
> doc/README.mpc8315erdb  ->      doc/freescale/README.mpc8315erdb
> doc/README.mpc8323erdb  ->      doc/freescale/README.mpc8323erdb
> doc/README.mpc832xemds  ->      doc/freescale/README.mpc832xemds
> doc/README.mpc8349itx   ->      doc/freescale/README.mpc8349itx
> doc/README.mpc8360emds  ->      doc/freescale/README.mpc8360emds
> doc/README.mpc837xemds  ->      doc/freescale/README.mpc837xemds
> doc/README.mpc837xerdb  ->      doc/freescale/README.mpc837xerdb
> doc/README.mpc83xxads   ->      doc/freescale/README.mpc83xxads
> doc/README.mpc83xx.ddrecc->     doc/freescale/README.mpc83xx.ddrecc
> doc/README.mpc8536ds    ->      doc/freescale/README.mpc8536ds
> doc/README.mpc8544ds    ->      doc/freescale/README.mpc8544ds
> doc/README.mpc8569mds   ->      doc/freescale/README.mpc8569mds
> doc/README.mpc8572ds    ->      doc/freescale/README.mpc8572ds
> doc/README.mpc85xxads   ->      doc/freescale/README.mpc85xxads
> doc/README.mpc85xxcds   ->      doc/freescale/README.mpc85xxcds
> doc/README.mpc8610hpcd  ->      doc/freescale/README.mpc8610hpcd
> doc/README.mpc8641hpcn  ->      doc/freescale/README.mpc8641hpcn

What about adding a doc/board directory?  eg:
doc/README.mpc8313erdb  ->      doc/board/freescale/README.mpc8313erdb
doc/README.mpc8315erdb  ->      doc/board/freescale/README.mpc8315erdb
doc/README.ocotea       ->      doc/board/amcc/README.ocotea
doc/README.ebony        ->      doc/board/amcc/README.ebony
doc/README.zeus         ->      doc/board/README.zeus
doc/README.xpedite1k    ->      doc/board/README.xpedite1k

Since the majority of documentation is board specific at this point,
it'd be nice if it was all moved into a subdirectory to clean up the
top-level doc/ dir.

Also, without the board subdirectory it'd be unclear where general
Freescale documentation that was relevant to multiple board vendors
would go.  Eg README.fsl-ddr - doc/freescale?  or doc/?.

A reorganization sounds nice either way!

Peter



More information about the U-Boot mailing list