[PATCH] Sphinx-based clang man pages

Sean Silva chisophugis at gmail.com
Mon Jun 29 19:42:02 PDT 2015


On Mon, Jun 29, 2015 at 7:39 PM, Andrew Wilkins <axwalk at gmail.com> wrote:

> On Tue, 30 Jun 2015 at 10:33 Sean Silva <chisophugis at gmail.com> wrote:
>
>> On Sat, Jun 27, 2015 at 2:42 AM, Dimitry Andric <dimitry at andric.com>
>> wrote:
>>
>>> This looks good to me too.  We had been using the .pod based man page in
>>> FreeBSD for a while, since building man pages from the other .rst files in
>>> tools/clang/docs resulted in *very* incomplete output, which looked partly
>>> like documentation, partly like a manpage...
>>>
>>
>> I think what was happening before is that Sphinx was just generating the
>> regular docs, but formatted as man pages.
>>
>> I think Andrew's changes actually make clang's docs be like LLVM's docs
>> so that the only generated man pages are the things intended to be manpages
>> (like llvm/docs/CommandGuide; in clang it is just the single manpage).
>>
>
> That is correct. Previously, trying to build the man would just build the
> entire documentation in the man page format. Now there's a man-page
> specific file, with room for adding more later.
>
> Is this patch acceptable now? I think the sooner it gets in and breaks
> packaging, the better, since people will have more time to react.
>

LGTM

-- Sean Silva


>
> Cheers,
> Andrew
>
>
>> -- Sean Silva
>>
>>
>>>
>>>
>>> http://reviews.llvm.org/D10562
>>>
>>> EMAIL PREFERENCES
>>>   http://reviews.llvm.org/settings/panel/emailpreferences/
>>>
>>>
>>>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20150629/9ce02b5a/attachment.html>


More information about the cfe-commits mailing list