[PATCH 17/19] Make DISTRO_DEFAULTS as deprecated

[Mark Kettenis]

> From: Simon Glass <sjg at chromium.org>
> Date: Thu, 24 Aug 2023 13:59:08 -0600
> 
> Encourage people to move to distro boot. Add a short migration guide.

Doesn't this commit message say the exact opposite of what the patch does?

> Signed-off-by: Simon Glass <sjg at chromium.org>
> ---
> 
>  boot/Kconfig            |  7 ++++++-
>  doc/develop/bootstd.rst | 23 +++++++++++++++++++++++
>  2 files changed, 29 insertions(+), 1 deletion(-)
> 
> diff --git a/boot/Kconfig b/boot/Kconfig
> index 02b33323d726..4742ee2027bd 100644
> --- a/boot/Kconfig
> +++ b/boot/Kconfig
> @@ -781,7 +781,7 @@ config SYS_BOOT_RAMDISK_HIGH
>  endmenu		# Boot images
>  
>  config DISTRO_DEFAULTS
> -	bool "Select defaults suitable for booting general purpose Linux distributions"
> +	bool "(deprecated) 'Defaults suitable for booting general purpose Linux distributions"
>  	select BOOT_DEFAULTS
>  	select AUTO_COMPLETE
>  	select CMDLINE_EDITING
> @@ -789,6 +789,11 @@ config DISTRO_DEFAULTS
>  	select HUSH_PARSER
>  	select SYS_LONGHELP
>  	help
> +	  Note: These scripts have been replaced by Standard Boot. Do not use
> +	  them on new boards. See 'Migrating from distro_boot' at
> +	  doc/develop/bootstd.rst
> +
> +
>  	  Select this to enable various options and commands which are suitable
>  	  for building u-boot for booting general purpose Linux distributions.
>  
> diff --git a/doc/develop/bootstd.rst b/doc/develop/bootstd.rst
> index ec3136535783..8b2f0849a1c0 100644
> --- a/doc/develop/bootstd.rst
> +++ b/doc/develop/bootstd.rst
> @@ -458,6 +458,28 @@ ready    File was loaded and is ready for use. In this state the bootflow is
>  =======  =======================================================================
>  
>  
> +Migrating from distro_boot
> +--------------------------
> +
> +To migrate from distro_boot:
> +
> +#. Update your board header files to remove the BOOTENV and BOOT_TARGET_xxx
> +   defines. Standard boot finds available boot devices automatically.
> +
> +#. Remove the "boot_targets" variable unless you need it. Standard boot uses a
> +   default order from fastest to slowest, which generally matches the order used
> +   by boards.
> +
> +#. Make sure that CONFIG_BOOTSTD_DEFAULTS is enabled by your board, so it can
> +   boot common Linux distributions.
> +
> +An example patch is at migrate_patch_.
> +
> +If you are using custom boot scripts for your board, consider creating your
> +own bootmeth to hold the logic. There are various examples at
> +`boot/bootmeth_...`.
> +
> +
>  Theory of operation
>  -------------------
>  
> @@ -768,3 +790,4 @@ Other ideas:
>  .. _BootLoaderSpec: http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/
>  .. _distro_boot: https://github.com/u-boot/u-boot/blob/master/boot/distro.c
>  .. _bootflow_h: https://github.com/u-boot/u-boot/blob/master/include/bootflow.h
> +.. _migrate_patch: https://patchwork.ozlabs.org/project/uboot/patch/20230727215433.578830-2-sjg@chromium.org/
> -- 
> 2.42.0.rc1.204.g551eb34607-goog
> 
>