[U-Boot] [PATCH 02/12] Remove/update old generic-board documentation and warning

[Andreas Bießmann]

On 2016-05-15 02:49, Simon Glass wrote:
> Remove the warning from the Makefile, since boards that do not use 
> generic
> board will no longer build. Also update documentation.
> 
> Signed-off-by: Simon Glass <sjg at chromium.org>

Reviewed-by: Andreas Bießmann <andreas at biessmann.org>

> ---
> 
>  Makefile                     | 14 ---------
>  README                       | 10 -------
>  board/sandbox/README.sandbox |  3 +-
>  doc/README.fdt-control       |  6 ----
>  doc/README.generic-board     | 69 
> +++++---------------------------------------
>  5 files changed, 8 insertions(+), 94 deletions(-)
> 
> diff --git a/Makefile b/Makefile
> index 293fad0..8478019 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -801,13 +801,6 @@ quiet_cmd_pad_cat = CAT     $@
>  cmd_pad_cat = $(cmd_objcopy) && $(append) || rm -f $@
> 
>  all:		$(ALL-y)
> -ifneq ($(CONFIG_SYS_GENERIC_BOARD),y)
> -	@echo "===================== WARNING ======================"
> -	@echo "Please convert this board to generic board."
> -	@echo "Otherwise it will be removed by the end of 2014."
> -	@echo "See doc/README.generic-board for further information"
> -	@echo "===================================================="
> -endif
>  ifeq ($(CONFIG_DM_I2C_COMPAT),y)
>  	@echo "===================== WARNING ======================"
>  	@echo "This board uses CONFIG_DM_I2C_COMPAT. Please remove"
> @@ -1257,13 +1250,6 @@ prepare2: prepare3 outputmakefile
> 
>  prepare1: prepare2 $(version_h) $(timestamp_h) \
>                     include/config/auto.conf
> -ifeq ($(CONFIG_HAVE_GENERIC_BOARD),)
> -ifeq ($(CONFIG_SYS_GENERIC_BOARD),y)
> -	@echo >&2 "  Your architecture does not support generic board."
> -	@echo >&2 "  Please undefine CONFIG_SYS_GENERIC_BOARD in your board
> config file."
> -	@/bin/false
> -endif
> -endif
>  ifeq ($(wildcard $(LDSCRIPT)),)
>  	@echo >&2 "  Could not find linker script."
>  	@/bin/false
> diff --git a/README b/README
> index 88ff837..2cdfb92 100644
> --- a/README
> +++ b/README
> @@ -4043,16 +4043,6 @@ Configuration Settings:
>  	If defined, don't allow the -f switch to env set override variable
>  	access flags.
> 
> -- CONFIG_SYS_GENERIC_BOARD
> -	This selects the architecture-generic board system instead of the
> -	architecture-specific board files. It is intended to move boards
> -	to this new framework over time. Defining this will disable the
> -	arch/foo/lib/board.c file and use common/board_f.c and
> -	common/board_r.c instead. To use this option your architecture
> -	must support it (i.e. must select HAVE_GENERIC_BOARD in 
> arch/Kconfig).
> -	If you find problems enabling this option on your board please report
> -	the problem and send patches!
> -
>  - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
>  	This is set by OMAP boards for the max time that reset should
>  	be asserted. See doc/README.omap-reset-time for details on how
> diff --git a/board/sandbox/README.sandbox 
> b/board/sandbox/README.sandbox
> index fa1842b..9fe3bf1 100644
> --- a/board/sandbox/README.sandbox
> +++ b/board/sandbox/README.sandbox
> @@ -186,8 +186,7 @@ U-Boot sandbox supports these emulations:
>  A wide range of commands is implemented. Filesystems which use a block
>  device are supported.
> 
> -Also sandbox uses generic board (CONFIG_SYS_GENERIC_BOARD) and 
> supports
> -driver model (CONFIG_DM) and associated commands.
> +Also sandbox supports driver model (CONFIG_DM) and associated 
> commands.
> 
> 
>  Linux RAW Networking Bridge
> diff --git a/doc/README.fdt-control b/doc/README.fdt-control
> index 29fd56a..2913fcb 100644
> --- a/doc/README.fdt-control
> +++ b/doc/README.fdt-control
> @@ -33,12 +33,6 @@ the features of each board in the device tree file,
> and have a single
>  generic source base.
> 
>  To enable this feature, add CONFIG_OF_CONTROL to your board config 
> file.
> -It is currently supported on ARM, x86 and Microblaze - other 
> architectures
> -will need to add code to their arch/xxx/lib/board.c file to locate the
> -FDT. Alternatively you can enable generic board support on your board
> -(with CONFIG_SYS_GENERIC_BOARD) if this is available (as it is for
> -PowerPC). For ARM, Tegra and Exynos5 have device trees available for
> -common devices.
> 
> 
>  What is a Flat Device Tree?
> diff --git a/doc/README.generic-board b/doc/README.generic-board
> index 734f1aa..6858c4d 100644
> --- a/doc/README.generic-board
> +++ b/doc/README.generic-board
> @@ -5,29 +5,22 @@
>  # SPDX-License-Identifier:	GPL-2.0+
>  #
> 
> -DEPRECATION NOTICE FOR arch/<arch>/lib/board.c
> -
> -For board maintainers: Please submit patches for boards you maintain 
> before
> -July 2014, to make them use generic board.
> -
> -For architecture maintainers: Please submit patches to remove your
> -architecture-specific board.c file before October 2014.
> -
> -
>  Background
>  ----------
> 
> -U-Boot has traditionally had a board.c file for each architecture. 
> This has
> -introduced quite a lot of duplication, with each architecture tending 
> to do
> +U-Boot traditionally had a board.c file for each architecture. This 
> introduced
> +quite a lot of duplication, with each architecture tending to do
>  initialisation slightly differently. To address this, a new 'generic 
> board
> -init' feature was introduced a year ago in March 2013 (further 
> motivation is
> +init' feature was introduced in March 2013 (further motivation is
>  provided in the cover letter below).
> 
> +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 being 
> 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
>  (for post-relocation init).
> 
> @@ -36,55 +29,6 @@ fields which are common to all architectures.
> Architecture-specific fields
>  have been moved to separate structures.
> 
> 
> -Supported Architectures
> -------------------------
> -
> -If you are unlucky then your architecture may not support generic 
> board.
> -The following architectures are supported now:
> -
> -   arc
> -   arm
> -   avr32
> -   blackfin
> -   m68k
> -   microblaze
> -   mips
> -   nios2
> -   powerpc
> -   sandbox
> -   x86
> -
> -If your architecture is not supported, you need to select
> -HAVE_GENERIC_BOARD in arch/Kconfig
> -and test it with a suitable board, as follows.
> -
> -
> -Adding Support for your Board
> ------------------------------
> -
> -To enable generic board for your board, define 
> CONFIG_SYS_GENERIC_BOARD in
> -your board config header file.
> -
> -Test that U-Boot still functions correctly on your board, and fix any
> -problems you find. Don't be surprised if there are no problems - 
> generic
> -board has had a reasonable amount of testing with common boards.
> -
> -
> -DeadLine
> ---------
> -
> -Please don't take this the wrong way - there is no intent to make your 
> life
> -miserable, and we have the greatest respect and admiration for U-Boot 
> users.
> -However, with any migration there has to be a period where the old way 
> is
> -deprecated and removed. Every patch to the deprecated code introduces 
> a
> -potential breakage in the new unused code. Therefore:
> -
> -Boards or architectures not converted over to general board by the
> -end of 2014 may be forcibly changed over (potentially causing run-time
> -breakage) or removed.
> -
> -
> -
>  Further Background
>  ------------------
> 
> @@ -190,3 +134,4 @@ convenience.
> 
>  Simon Glass, sjg at chromium.org
>  March 2014
> +Updated after final removal, May 2016