Djam/u-boot
1
0
Fork 0
mirror of https://github.com/u-boot/u-boot.git synced 2025-04-22 04:44:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Move generic-board documentation into rst

Browse source 
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:
Simon Glass 2024-08-21 10:19:26 -06:00 • committed by Tom Rini
parent 66ca5b7864
commit 09c58e0263
3 changed files with 29 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/README.generic-board → doc/develop/historical/generic_board.rst
View file

@ -1,10 +1,9 @@
# SPDX-License-Identifier: GPL-2.0+ .. SPDX-License-Identifier: GPL-2.0+
# .. (C) Copyright 2014 Google, Inc
# (C) Copyright 2014 Google, Inc .. sectionauthor:: Simon Glass <sjg@chromium.org>
# Simon Glass <sjg@chromium.org>
Background Generic board
---------- -------------
U-Boot traditionally had a board.c file for each architecture. This introduced U-Boot traditionally had a board.c file for each architecture. This introduced
quite a lot of duplication, with each architecture tending to do 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? What has changed?
----------------- ~~~~~~~~~~~~~~~~~
The main change is that the arch/<arch>/lib/board.c file is removed in 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 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 Further Background
------------------ ~~~~~~~~~~~~~~~~~~
The full text of the original generic board series is reproduced below. The full text of the original generic board series is reproduced below.
@ -132,4 +131,6 @@ convenience.
Simon Glass, sjg@chromium.org Simon Glass, sjg@chromium.org
March 2014 March 2014
Updated after final removal, May 2016 Updated after final removal, May 2016

12
doc/develop/historical/index.rst Normal file
View 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

8
doc/develop/index.rst
View file

@ -99,3 +99,11 @@ Code quality
:maxdepth: 1 :maxdepth: 1
python_cq python_cq
Historical documentation
------------------------
.. toctree::
:maxdepth: 2
historical/index