search

ilbers / isar

Integration System for Automated Root filesystem generation
Other
177 stars 72 forks source link

doc: Change <CONFIG> to ${CONFIG} in user_manual.md #79

Closed winndows closed 2 years ago

winndows commented 2 years ago

While using .conf, it will generate only ".conf" as "conf/multiconfig/.conf", so change to ${MACHINE} in user_manual.md

amikan commented 2 years ago

Hello. <CONFIG> here stands for any multiconfig name you choose. It usually consist not only of machine name, but also distro name, to be able to build any machine with any distro. For example, if you have machine described in beaglebone.conf and distro described in bullseye.conf it is useful to name multiconfig file like beaglebone-bullseye.conf, but of course you can choose any. In that case you should set at least BBMULTICONFIG = "beaglebone-bullseye" (or any other you prefer) to make bitbake do not fail on multiconfig build setup.

So the patch you've send it incorrect because:

  1. multiconfig filename should not (and never in real life) equal with machine config name
  2. this is not actually a code, but just a description in pseudocode of how it works
winndows commented 2 years ago

Hello,

  1. If we use <CONFIG>.conf, it will generate only ".conf" as following:

BBMULTICONFIG - The list of the complete configuration definition files. BitBake looks for conf/multiconfig/.conf in every layer.

As above mentioned, BitBake looks for conf/multiconfig/.conf

  1. How about change: "<CONFIG>.conf" to ${CONFIG}.conf? Then we will get:

BBMULTICONFIG - The list of the complete configuration definition files. BitBake looks for conf/multiconfig/${CONFIG}.conf in every layer. Every configuration must define MACHINE, DISTRO and DISTRO_ARCH.

amikan commented 2 years ago

If speaking about Github Markdown parser, it's better to cover the whole conf/multiconfig/<CONFIG>.conf with ``.

BTW we are not using pull request in Isar, please send the patch to isar-users@googlegroups.com maillist if you want it to be applied to next.

winndows commented 2 years ago

ok, thanks a lot. I will send the path to the maillist.