[Unstable/Lunar][PATCH 5/5] UBUNTU: [Packaging] annotations: Write out annotations with notes first

[Andrea Righi]

On Wed, Feb 08, 2023 at 08:36:09AM +0100, Juerg Haefliger wrote:
> On Wed, 8 Feb 2023 07:57:40 +0100
> Andrea Righi <andrea.righi at canonical.com> wrote:
> 
> > On Tue, Feb 07, 2023 at 08:36:07AM +0100, Juerg Haefliger wrote:
> > > When writing the annotations file, separate them  into two groups: With
> > > and without a note. Write the group with notes first and separate the
> > > other group with a visual marker.
> > > 
> > > The idea is that all configs that are set/modified manually should have
> > > an annotation note and putting them at the top of the annotations file
> > > should make it easier to figure out what the config of this kernel is
> > > about.  
> > 
> > I'm wondering if we should move the configs-with-note group at the end of
> > the file to make sure that we always prioritize configs-with-note over
> > configs-without-note, so that we're not tempted to add stuff at the top
> > that can be potentially overridden by the same config rule defined later
> > in the same file (typically this shouldn't happen if we search for the
> > config that we want to change, but I think the config-with-note at the
> > end is less bug prone).
> 
> Policies with notes are manually added and important so should be a the top
> IMO. Otherwise they get (visually) lost at the end after 1000s of mechanically
> added policies. And policies with notes should take precedence over ones
> without notes, no? So that way we can't loose them.

OK, yeah at the end if shouldn't be a problem, because we always run
an updateconfigs that will take care of removing duplicate lines, so in
practice there's no risk of potential overrides and having the
configs-with-note at the top is better in terms of readability.

Alright, in general I like all these changes/cleanups, thanks for doing
all of this Juerg!

-Andrea