Re: regenerating man pages

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

 



On Tue, 17 Mar 2015, Josh Durgin wrote:
> On 03/17/2015 12:32 PM, Gregory Farnum wrote:
> > Yeah. If this has gotten easier it's fine, but asphyxiate required a
> > *lot* of tooling that I'd rather we not require as developer build
> > deps. I'd imagine we can just produce them as part of the Jenkins
> > build procedure or something?
> 
> None of that is needed for man pages or developer builds. asphyxiate is
> just for getting doxygen into the docs. The man pages are generated with
> plain sphinx, and do not need to be part of developer builds. Only
> package builds need to generate them.

Note that in practice devs will run install-deps.sh, which greps the 
Build-depends out of the spec or debian/control file, so they'll probably 
end up installing sphinx.  If it's just that I don't think it'll cause 
problems though!

sage

> 
> Josh
> 
> > On Tue, Mar 17, 2015 at 12:27 PM, David Zafman <dzafman@xxxxxxxxxx> wrote:
> > > 
> > > I found that I could not build the docs on Ubuntu 14.10 with the proper
> > > packages installed.  Kefu is looking into Asphyxiate which is very
> > > tempermental.  I installed an Ubuntu 11.10 in order to generate docs.
> > > 
> > > David
> > > 
> > > 
> > > On 3/17/15 10:11 AM, Sage Weil wrote:
> > > > 
> > > > On Tue, 17 Mar 2015, Josh Durgin wrote:
> > > > > 
> > > > > On 03/17/2015 09:40 AM, Ken Dreyer wrote:
> > > > > > 
> > > > > > I had a question about the way that we're handling man pages.
> > > > > > 
> > > > > > In 356a749f63181d401d16371446bb8dc4f196c2a6 , "rbd: regenerate
> > > > > > rbd(8)
> > > > > > man page", it looks like man/rbd.8 was regenerated from
> > > > > > doc/man/8/rbd.rst
> > > > > > 
> > > > > > It seems like it would be more efficient to avoid storing man pages
> > > > > > in
> > > > > > Git and generate them dynamically at build time instead?
> > > > > 
> > > > > Yes, that'd be great!
> > > > > 
> > > > > > https://github.com/ceph/ceph/blob/master/admin/manpage-howto.txt
> > > > > > 
> > > > > > "admin/build-doc" does a lot of things (including man page
> > > > > > generation).
> > > > > > Could we simply run the "sphinx-build -b man" part at build time as
> > > > > > a
> > > > > > part of "make"?
> > > > > 
> > > > > I don't see a reason not to. It's just a matter of making it work on
> > > > > all
> > > > > the platforms we're building packages for. That might be annoying for
> > > > > the entirety of build-doc, but for just building man pages it should
> > > > > be simple.
> > > > 
> > > > I think the original reason we didn't was just because there are a lot
> > > > of
> > > > dependencies for building the docs, so this inflates Build-Depends.
> > > > That
> > > > doesn't particularly bother me, though, if the deps do in fact exist.
> > > > 
> > > > sage
> > > > --
> > > > 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
> > > 
> > > 
> > > --
> > > 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
> > --
> > 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
> > 
> 
> --
> 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
> 
> 
--
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