From: Dan Mick <dmick@redhat.com>
To: Alfredo Deza <adeza@redhat.com>, Gregory Farnum <gfarnum@redhat.com>
Cc: ceph-devel <ceph-devel@vger.kernel.org>
Subject: Re: better doc (and build) validation
Date: Mon, 11 Dec 2017 20:08:59 -0800 [thread overview]
Message-ID: <837d39fb-0cf1-a51f-18e9-2555f747ef13@redhat.com> (raw)
In-Reply-To: <CAC-Np1x9R9F5Y=X-HafVmQfzgCe67A6YmJ6GdCrdGHY62KZ4_w@mail.gmail.com>
On 12/05/2017 12:27 PM, Alfredo Deza wrote:
> On Tue, Dec 5, 2017 at 12:44 PM, Gregory Farnum <gfarnum@redhat.com> wrote:
>> On Tue, Dec 5, 2017 at 5:31 AM, Alfredo Deza <adeza@redhat.com> wrote:
>>> It seems like we keep hitting catastrophic build errors with minor doc
>>> changes. The last one was introduced by a change I made to the
>>> ceph-disk man page that updated the title:
>>>
>>> https://github.com/ceph/ceph/pull/19241/commits/bd00560c20caeeb1ded211cb81533280338014d1
> It failed there because the man pages are generated differently, using
> a couple of ad-hoc helpers that try to ensure certain conditions. In
> this case, it was a Python
> utility (ceph/man/conf.py). It was trying to make sure that the title
> of the man page matched the name of the man page.
> I had added "[DEPRECATED]" to the ceph-disk title, which failed the assertion.
Ugh. FWIW I agree that's horrid. Seems to me the doc build should be
doing the same thing the docs-part-of-the-binary-build is doing (and
always should have) and yes I know it's not simple.
prev parent reply other threads:[~2017-12-12 4:08 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-05 13:31 better doc (and build) validation Alfredo Deza
2017-12-05 17:44 ` Gregory Farnum
2017-12-05 20:27 ` Alfredo Deza
2017-12-06 7:44 ` kefu chai
2017-12-06 12:02 ` Alfredo Deza
2017-12-06 16:23 ` kefu chai
2017-12-12 4:08 ` Dan Mick [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=837d39fb-0cf1-a51f-18e9-2555f747ef13@redhat.com \
--to=dmick@redhat.com \
--cc=adeza@redhat.com \
--cc=ceph-devel@vger.kernel.org \
--cc=gfarnum@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.