Re: better doc (and build) validation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 12/05/2017 12:27 PM, Alfredo Deza wrote:
> On Tue, Dec 5, 2017 at 12:44 PM, Gregory Farnum <gfarnum@xxxxxxxxxx> wrote:
>> On Tue, Dec 5, 2017 at 5:31 AM, Alfredo Deza <adeza@xxxxxxxxxx> 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.

--
To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [CEPH Users]     [Ceph Large]     [Information on CEPH]     [Linux BTRFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]
  Powered by Linux