On Fri, Sep 28, 2018 at 10:14:12AM -0700, Stefan Beller wrote: > > I think other high-level concepts that are _not_ APIs (e.g., file > > formats, protocol, etc) could go into technical/. > > That is what I meant with high level concepts. Anything that talks > about or implies the existence of a function is clearly header level.
Ah, OK. I thought you meant the "this is how strbuf roughly works" overview, which IMHO should remain in strbuf.h. I think we are on the same page, then. > > (Though actually, those are the thing that I would not mind at all if > > they get formatted into real manpages and shipped to end users. We do > > not expect most users to dissect our file-formats, but they could at > > least be useful to somebody poking around). > > Formats are sensible thing to present to the end user. I was also thinking > about partial-clone, which is a concept rather than a format. Yeah, definitely. Another good example is technical/api-credentials. The section on credential helpers there probably ought to be in more user-visible documentation (probably gitcredentials(7)). -Peff
