RE: [poky] [PATCH 2/2] meta-poky/conf/templates/default/conf-description.txt: add a template description

> -----Original Message-----
> From: Alexander Kanavin <[email protected]>
> Sent: den 31 augusti 2023 19:12
> To: Peter Kjellerstedt <[email protected]>
> Cc: [email protected]; Alexander Kanavin <[email protected]>
> Subject: Re: [poky] [PATCH 2/2] meta-poky/conf/templates/default/conf-description.txt: add a template description
> 
> On Thu, 31 Aug 2023 at 19:04, Peter Kjellerstedt <[email protected]> wrote:
> > > +++ b/meta-poky/conf/templates/default/conf-description.txt
> > > @@ -0,0 +1 @@
> > > +This is the default build configuration for the Poky reference distribution.
> > > --
> > > 2.30.2
> >
> > To use the same nomenclature as for the variables, how about calling
> > this conf-summary.txt instead? Compare to SUMMARY vs DESCRIPTION.
> 
> To match them up we'd also have to rename conf-notes.txt, breaking
> compatiblity. And the meanings are not the same as in
> summary/description recipes or package metadata.
> 
> 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.
> 
> Alex

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...

//Peter