Re: refactoring livepatch documentation was Re: [PATCH 1/2] docs/livepatch: Add new compiler considerations doc

[Josh Poimboeuf]

On Mon, Aug 10, 2020 at 03:46:46PM -0400, Joe Lawrence wrote:
> > > > > I'm thinking a newcomer reading this might be lost.  It's not
> > > > > necessarily clear that there are currently two completely different
> > > > > approaches to creating a livepatch module, each with their own quirks
> > > > > and benefits/drawbacks.  There is one mention of a "source-based
> > > > > livepatch author" but no explanation of what that means.
> > > > > 
> > > > 
> > > > Yes, the initial draft was light on source-based patching since I only
> > > > really tinker with it for samples/kselftests.  The doc was the result of an
> > > > experienced livepatch developer and Sunday afternoon w/the compiler. I'm
> > > > sure it reads as such. :)
> > > 
> > > Are experienced livepatch developers the intended audience?  If so I
> > > question what value this document has in its current form.  Presumably
> > > experienced livepatch developers would already know this stuff.
> > 
> > IMHO, this document is useful even for newbies. They might at
> > least get a clue about these catches. It is better than nothing.
> > 
> > I do not want to discourage Joe from creating even better
> > documentation. But if he does not have interest or time
> > to work on it, I am happy even for this piece.

Agreed.  Joe, sorry for instigating and then disappearing :-)

I know we're all busy and I didn't intend to block the patch until we
reach Documentation Nirvana.  Though it would be _really_ nice to get
more input from those who have more experience with the subject matter
(source-based patch generation).

It's part of my job as a maintainer to push back, question, and
sometimes even complain.  I was just wondering where this is heading,
because as our documentation grows (a good thing), the overall state is
getting less cohesive (a bad thing).

Anyway, ACK to the original patch.

> 1. Provide a better index page to connect the other files/docs, like
> https://www.kernel.org/doc/html/latest/core-api/index.html but obviously not
> that extensive.  Right now we have only a Table of Contents tree without any
> commentary.
> 
> 2. Rearrange and refactor sections:
> 
> livepatch.rst
>   Keep just about everything
>   Add a history section to explain ksplice, kgraft, kpatch for the
>     uninitiated?
>   Add a section on source based vs. binary diff livepatch creation,
>     this may be worth its own top-level section
> 
> Livepatch API
>   Basic API
>   Callbacks
>   Shadow variables
>   Cumulative patches
>   System state
> 
> KLP Relocations
>   Right now this is a bit academic AFAIK kpatch is the only tool
>   currently making use of them.  So maybe this document becomes a
>   more general purpose doc explaining how to reference unexported
>   symbols?  (ie, how does kgraft currently do it, particularly
>   w/kallsyms going unexported?)
> 
>   Eventually this could contain klp-convert howto if it ever gets
>   merged.
> 
> Compiler considerations
>   TBD

This is certainly a logical way to organize things.  But again I would
wonder, who's the audience?

> I suppose this doesn't create a "Livepatching creation for dummies" guide,
> but my feeling is that there are so many potential (hidden) pitfalls that
> such guide would be dangerous.

I disagree that a live patching creation guide would be dangerous.  I
think it would be less dangerous than *not* having one.  There are
several companies now delivering (hopefully reliable) livepatches to
customers, and they're all presumably following processes.  We just need
to agree on best practices and document the resulting process.  Over
time I believe that will create much more good than harm.

Sure, there are pitfalls, but the known ones can be highlighted in the
guide.  No document is perfect but it hopefully improves and becomes
more useful over time.

-- 
Josh