Re: [poky] [PATCH 2/2] meta-poky/conf/templates/default/conf-description.txt: add a template description
Alexander Kanavin <[email protected]>
| Newsgroups | org.yoctoproject.lists.poky |
|---|---|
| Message-ID | <CANNYZj9Xj54_R_obhYuyU-U=KVPsk8XVPbR2ETKt9vPw8tuc3g@mail.gmail.com> |
On Thu, 31 Aug 2023 at 21:10, Peter Kjellerstedt <[email protected]> wrote: > > conf-notes.txt would contain lengthy instructions/notes for how to use > > the template and would be shown when you actually set up a build > > directory (this is already happening now), conf-description.txt has a > > single sentence saying what it is for, and shown before/during > > selection of the template. > Well, your distinction between "notes" and "description" and that the > latter is expected to be a oneliner is not obvious from their names. > Though, in the end, I guess it is all down to documentation... There's also how the tools are handling them. 'bitbake-layers save-build-conf' would write the following into the files: https://patchwork.yoctoproject.org/project/oe-core/patch/[email protected]/ Description would be then shown on template selection and both description and notes when initializing a build from it. Between all that users should be able to figure out what needs to go where. Alex