[Zorg][PATCH] Add Sphinx documentation factory and builder for LLVM, Clang and LLD

[Sean Silva]

On Thu, Aug 7, 2014 at 3:47 AM, Dan Liew <dan at su-root.co.uk> wrote:

> >> >> @Sean Silva : I know you disagree with having Sphinx warnings as
> >> >> errors but I think for the buildbot that this is probably fine.
>
> <snip>
>
> >> I think we could experiment with this. We could start with the patch
> >> as it is and if devs find it irritating
> >
> >
> > An email from a buildbot is not really an invitation for a dialogue about
> > whether the dev finds it irritating. Before you set up a bot, I would
> > recommend that you start out by personally emailing the devs about these
> > issues. That is an easy way to find out if e.g. they usually need help
> > understanding what Sphinx is warning about and how to fix it.
> >
> > Also, unlike a bot, you have a gut feeling about how annoying you are
> being
> > when emailing someone about something, which lets you estimate the
> > "annoyance factor" without having to rely on developers taking action to
> > inform "the bot operator" that the bot is annoying them (or even worse,
> just
> > silently and/or subconsciously contributing less to the documentation).
>
> Although this does sound like a good idea I'm not sure I really have
> the free time to dedicate to doing that right now (you are quite
> welcome to do so). But I'd like to see this patch reviewed, improve
> and committed sooner rather than later because I'd like get this in
> before I start looking at cleaning up Zorg and documenting it.
>

Glad to hear that you'll be giving zorg some love!


>
> As a compromise we could mark the buildbot as experimental (so it
> doesn't notify devs like the normal buildbots) and have it only notify
> a few people (probably myself, you and anyone else who pipes up and
> says they're interested) about documentation build failures until we
> can reach a decision on whom it notifies


That sounds fine. It looks like Tobias already has figured out how to do
that so it shouldn't be difficult.


> (perhaps this issue should go
> to llvmdev as a separate thread?).
>

Let's wait until we have some experience with the bot.

-- Sean Silva


>
> Thanks,
> Dan.
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20140807/690dbb2e/attachment.html>