| Message ID | 20220908161333.96614-1-johan.korsnes@remarkable.no |
|---|---|
| State | New |
| Headers | show |
| Series | ref-manual: variables: document KERNEL_IMAGETYPES | expand |
Hi Johan, On 9/8/22 18:13, Johan Korsnes wrote: > Cc: He Zhe <zhe.he@windriver.com> > Cc: Ross Burton <ross.burton@intel.com> > Cc: Richard Purdie <richard.purdie@linuxfoundation.org> > Signed-off-by: Johan Korsnes <johan.korsnes@remarkable.no> > --- > documentation/ref-manual/variables.rst | 13 +++++++++---- > 1 file changed, 9 insertions(+), 4 deletions(-) > > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst > index cf817e954..59a474f30 100644 > --- a/documentation/ref-manual/variables.rst > +++ b/documentation/ref-manual/variables.rst > @@ -3984,11 +3984,10 @@ system and gives an overview of their function and contents. > > KCONFIG_MODE = "alldefconfig" > > - > :term:`KERNEL_ALT_IMAGETYPE` > Specifies an alternate kernel image type for creation in addition to > - the kernel image type specified using the > - :term:`KERNEL_IMAGETYPE` variable. > + the kernel image type specified using the :term:`KERNEL_IMAGETYPE` and > + :term:`KERNEL_IMAGETYPES` variables. > I'm wondering if we shouldn't retire KERNEL_ALT_IMAGETYPE since it's superseded by KERNEL_IMAGETYPES? Not something for the docs though, code needs to be changed first. > :term:`KERNEL_ARTIFACT_NAME` > Specifies the name of all of the build artifacts. You can change the > @@ -4174,7 +4173,13 @@ system and gives an overview of their function and contents. > > If you want to build an alternate kernel image type in addition to that > specified by :term:`KERNEL_IMAGETYPE`, use the :term:`KERNEL_ALT_IMAGETYPE` > - variable. > + variable. For additional kernel image types, use the > + :term:`KERNEL_IMAGETYPES` variable. > + I would simplify by just saying to use KERNEL_IMAGETYPES or KERNEL_ALT_IMAGETYPE (or maybe even replace KERNEL_ALT_IMAGETYPE by KERNEL_IMAGETYPES entirely). > + :term:`KERNEL_IMAGETYPES` > + Lists additional types of kernel images to build for a device in addition > + to image type specified in :term:`KERNEL_IMAGETYPE`. Usually set by the > + machine configuration files. > Technically, the KERNEL_IMAGETYPES variable will end up containing KERNEL_IMAGETYPE and KERNEL_ALT_IMAGETYPE but that's an implementation detail. If you could address the second comment that would be great, the other two are just remarks. Thanks! Quentin
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index cf817e954..59a474f30 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3984,11 +3984,10 @@ system and gives an overview of their function and contents. KCONFIG_MODE = "alldefconfig" - :term:`KERNEL_ALT_IMAGETYPE` Specifies an alternate kernel image type for creation in addition to - the kernel image type specified using the - :term:`KERNEL_IMAGETYPE` variable. + the kernel image type specified using the :term:`KERNEL_IMAGETYPE` and + :term:`KERNEL_IMAGETYPES` variables. :term:`KERNEL_ARTIFACT_NAME` Specifies the name of all of the build artifacts. You can change the @@ -4174,7 +4173,13 @@ system and gives an overview of their function and contents. If you want to build an alternate kernel image type in addition to that specified by :term:`KERNEL_IMAGETYPE`, use the :term:`KERNEL_ALT_IMAGETYPE` - variable. + variable. For additional kernel image types, use the + :term:`KERNEL_IMAGETYPES` variable. + + :term:`KERNEL_IMAGETYPES` + Lists additional types of kernel images to build for a device in addition + to image type specified in :term:`KERNEL_IMAGETYPE`. Usually set by the + machine configuration files. :term:`KERNEL_MODULE_AUTOLOAD` Lists kernel modules that need to be auto-loaded during boot.
Cc: He Zhe <zhe.he@windriver.com> Cc: Ross Burton <ross.burton@intel.com> Cc: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Johan Korsnes <johan.korsnes@remarkable.no> --- documentation/ref-manual/variables.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-)