On Nov 16, 2013, at 8:42 PM, James Peach <jpe...@apache.org> wrote:
>
> Choose what you think the most sensible name is. For real man pages, we could
> link them by all the names, but that's probably tricky with Sphinx.
It looks like we’re now creating them with whatever function “creates” an
entity of the grouping, so maybe we stick with that. I don’t care strongly,
other than (as usual) I think it needs to be consistent.
>
>
> Reference docs are for reference. The SDK docs are for exposition and
> tutorial material.
Ok, makes sense, what’s real confusing right now is that they link to the
Doxygen docs on people.apache.org/~amc/.
>
>
> Everything in reference/ produces a man page.
Does it also create a man page or link for every function? I’m definitely not
an expert on man pages, but I’m fairly certain it’s a common pattern to allow
“man TSAnyFunction” and the page which has relevant info for that function is
displayed.
>
> That's a judgement call. Just do what you think is best.
Meh. Lets decide what the format should be. Since no one has cared so far,
maybe just leave it as is, and all future additions follows the same pattern.
As such, I’m creating
doc/reference/api/TSMimeHdrFieldCreate.en.rst
which is slightly confusing, since the file for now only contains the docs for
TSMimeHdrFieldValueStringGet :).
Cheers,
— Leif
