Re: Question about Snippets new vs LSR

[Phil Holmes]

----- Original Message ----- 
From: "James" <address@hidden>
To: "Phil Holmes" <address@hidden>; "Developers List" 
<address@hidden>
Sent: Friday, December 20, 2013 12:29 PM
Subject: Re: Question about Snippets new vs LSR


> On 20/12/13 10:45, Phil Holmes wrote:
> > ----- Original Message ----- From: "Pkx" <address@hidden>
> > To: "Developers List" <address@hidden>
> >
> > > So I have a tracker issue that recommends changing a snippet that comes 
> > > from the LSR but with a syntax that won't work with the current version 
> > > of LP in the LSR (which I think is 2.14.something right?).
> >
> > > So in that case if I create a new snippet, what do I do with the snippet 
> > > already created?
> >
> > > Delete it, or just remove it from the ref in the NR (where the example 
> > > is) and give the new snippet a different name?
> >
> > Ignore it.  When makelsr.py is run, it first converts the snippets in 
> > Documentation/snippets and then works on Documentation/snippets/new, thus 
> > overwriting any in Documentation/snippets with any new version.  So your 
> > new snippet has to go in Documentation/snippets/new
> >
> > > I haven't done snippets for a while so have forgotten and the CG is not 
> > > clear in the matter.
> >
> > > James
> >
> > Hope that's clear.
>
> I think so.
>
> 1. Keep the same file name
> 2. Put in Snippets/new - which then forces an overwrite of the old snippet 
> with the same filename

Yep.

> With regard to the patch, I guess I git-cl upload with *just* the patch 
> but I have to test the patch with makelsr.py run on my local tree so that 
> it really tests the make-doc?

You can certainly do this, and the run of makelsr and make doc after making 
the patch should also be done, to be safe.

> Then when I push, I push it with the makelsr.py or do I push and then 
> makelsr.py and then push that as a separate patch?

Either.  If you simply upload the patch as created without makelsr, it's one 
of my jobs (which I'm often rather lax about) to run makelsr and get the 
updates into the docs.

> Oh... one more.
>
> If I overwrite the snippet that will no longer work in the version that 
> LSR uses, I assume we don't 'push' that snippet up to the LSR and break 
> something there?

Correct.  If we ever manage to update the LSR, myself Thomas and David N 
would probably be persuaded to push the updated versions into the LSR. 
That's a bit of a game, though.

> Thanks again.
>
> James

--
Phil Holmes