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 ---
.../historical/generic_board.rst} | 16 ++++++++-------- doc/develop/historical/index.rst | 12 ++++++++++++ doc/develop/index.rst | 8 ++++++++ 3 files changed, 28 insertions(+), 8 deletions(-) rename doc/{README.generic-board => develop/historical/generic_board.rst} (96%) create mode 100644 doc/develop/historical/index.rst
diff --git a/doc/README.generic-board b/doc/develop/historical/generic_board.rst similarity index 96% rename from doc/README.generic-board rename to doc/develop/historical/generic_board.rst index bc35179fbfd..6711d3d7a89 100644 --- a/doc/README.generic-board +++ b/doc/develop/historical/generic_board.rst @@ -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,5 @@ convenience.
Simon Glass, sjg@chromium.org March 2014 + Updated after final removal, May 2016 diff --git a/doc/develop/historical/index.rst b/doc/develop/historical/index.rst new file mode 100644 index 00000000000..e4462f5d2a7 --- /dev/null +++ b/doc/develop/historical/index.rst @@ -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 diff --git a/doc/develop/index.rst b/doc/develop/index.rst index c0107a783fc..0d0e60ab56c 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -99,3 +99,11 @@ Code quality :maxdepth: 1
python_cq + +Historical documentation +------------------------ + +.. toctree:: + :maxdepth: 2 + + historical/index