Re: [PATCH v9 1/2] dts: Change hugepage runtime config to 2MB Exclusively

[Thomas Monjalon <thomas@monjalon.net>]

10/06/2024 17:20, Nicholas Pratte:
>       You may specify the optional hugepage configuration in the DTS config file.
>       If you do, DTS will take care of configuring hugepages,
> -     overwriting your current SUT hugepage configuration.
> +     overwriting your current SUT hugepage configuration. Configuration of hugepages via DTS
> +     allows only for allocation of 2MB hugepages, as doing so prevents accidental/over
> +     allocation of hugepage sizes not recommended during runtime due to
> +     contiguous memory space requirements. Thus, if you require hugepage
> +     sizes not equal to 2MB, then this configuration must be done outside of the DTS framework.

Lines must be broken logically, example: after a dot or comma.

>  
>     * System under test configuration
>  
> @@ -453,11 +457,11 @@ _`Build target`
>                          **Example**: ``ccache``
>     ==================== =================================================================
>  
> -_`hugepages`
> -   *mapping* – hugepages described as:
> +_`hugepages_2mb`
> +   *mapping* – hugepages_2mb described as:
>  
>     ==================== ================================================================
> -   ``amount``           *integer* – The amount of hugepages to configure.
> +   ``number_of``        *integer* – The number of 2MB hugepages to configure.

The rename to "number_of" belongs to the next commit.

>  
>                          Hugepage size will be the system default.
>     ``force_first_numa`` (*optional*, defaults to ``false``) – If ``true``, it forces the
> @@ -570,7 +574,7 @@ involved in the testing. These can be defined with the following mappings:
>     |                       |                                                                                       |
>     |                       | The number of the memory channels to use.                                             |
>     +-----------------------+---------------------------------------------------------------------------------------+
> -   | ``hugepages``         | (*optional*) See `hugepages`_. If unset, hugepages won't be configured                |
> +   | ``hugepages_2mb``     | (*optional*) See `hugepages`_. If unset, 2MB hugepages won't be configured            |

The link needs to be changed to hugepages_2mb here.
There is an error in CI while generating doc.