All of lore.kernel.org
 help / color / mirror / Atom feed
From: Ken Dreyer <kdreyer@redhat.com>
To: "ceph-devel@vger.kernel.org" <ceph-devel@vger.kernel.org>
Subject: regenerating man pages
Date: Tue, 17 Mar 2015 10:40:49 -0600	[thread overview]
Message-ID: <55085911.9060800@redhat.com> (raw)

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?

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"?

Just trying to understand what's intentional, whether I'm missing
something, etc.

- Ken

             reply	other threads:[~2015-03-17 16:40 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-17 16:40 Ken Dreyer [this message]
2015-03-17 16:49 ` regenerating man pages Josh Durgin
2015-03-17 17:11   ` Sage Weil
2015-03-17 19:27     ` David Zafman
2015-03-17 19:32       ` Gregory Farnum
2015-03-17 19:41         ` Josh Durgin
2015-03-17 19:44           ` Sage Weil
  -- strict thread matches above, loose matches on Subject: below --
2015-03-18  6:25 kefu chai

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=55085911.9060800@redhat.com \
    --to=kdreyer@redhat.com \
    --cc=ceph-devel@vger.kernel.org \
    /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.