Re: Libification project (SoC)

["Shawn O. Pearce" <spearce@spearce.org>]

Jakub Narebski <jnareb@gmail.com> wrote:
> [Cc: git@vger.kernel.org]
> 
> Luiz Fernando N. Capitulino wrote:
> 
> >     o Documentation (eg, doxygen)
> 
> I wonder if documenting and finishing documentation of git storage structure
> (format description of: loose objects, packs, pack indices, index, refs and
> symbolic refs, packed refs) and git protocols (git protocol description,
> local/ssh fetch/push pipeline description), perhaps using RFC or RFC-like
> notation could (and should) be made part of libification effort...

I would consider that out of scope for this project.

It would be nice if someone did this work, or at least dusted
off "A Large Angry SCM"'s document and made that available in the
Documentation/technical folder.  But I don't think it should be part
of the Libification SoC project, or any of our other current ideas.

Users of a public API don't need to know the internal formatting
of an object within a packfile.  They do however need to know that
a commit has a tree, and 0-n parents.  And that's already covered
in our existing docs.


And *please* stop breaking the CC chains Jakub.  We've asked you
to not do that.  I had to go lookup Luiz' email address so I could
get him back onto it.

-- 
Shawn.