mirror of
https://github.com/u-boot/u-boot.git
synced 2025-04-16 18:04:48 +00:00
doc: Move generic-board documentation into rst
This information is useful for people looking at how U-Boot has changed over the years and the design decisions which led to it. Move it into doc/ in an 'historical' section. Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
parent
66ca5b7864
commit
09c58e0263
3 changed files with 29 additions and 8 deletions
|
@ -1,10 +1,9 @@
|
|||
# SPDX-License-Identifier: GPL-2.0+
|
||||
#
|
||||
# (C) Copyright 2014 Google, Inc
|
||||
# Simon Glass <sjg@chromium.org>
|
||||
.. SPDX-License-Identifier: GPL-2.0+
|
||||
.. (C) Copyright 2014 Google, Inc
|
||||
.. sectionauthor:: Simon Glass <sjg@chromium.org>
|
||||
|
||||
Background
|
||||
----------
|
||||
Generic board
|
||||
-------------
|
||||
|
||||
U-Boot traditionally had a board.c file for each architecture. This introduced
|
||||
quite a lot of duplication, with each architecture tending to do
|
||||
|
@ -16,7 +15,7 @@ All boards and architectures have moved to this as of mid 2016.
|
|||
|
||||
|
||||
What has changed?
|
||||
-----------------
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
The main change is that the arch/<arch>/lib/board.c file is removed in
|
||||
favour of common/board_f.c (for pre-relocation init) and common/board_r.c
|
||||
|
@ -28,7 +27,7 @@ have been moved to separate structures.
|
|||
|
||||
|
||||
Further Background
|
||||
------------------
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The full text of the original generic board series is reproduced below.
|
||||
|
||||
|
@ -132,4 +131,6 @@ convenience.
|
|||
|
||||
Simon Glass, sjg@chromium.org
|
||||
March 2014
|
||||
|
||||
Updated after final removal, May 2016
|
||||
|
12
doc/develop/historical/index.rst
Normal file
12
doc/develop/historical/index.rst
Normal file
|
@ -0,0 +1,12 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0+
|
||||
|
||||
Historical Documents
|
||||
====================
|
||||
|
||||
This section provides documentation about major changes in U-Boot over the
|
||||
years.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
generic_board
|
|
@ -99,3 +99,11 @@ Code quality
|
|||
:maxdepth: 1
|
||||
|
||||
python_cq
|
||||
|
||||
Historical documentation
|
||||
------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
historical/index
|
||||
|
|
Loading…
Add table
Reference in a new issue