All of lore.kernel.org
 help / color / mirror / Atom feed
From: Zdenek Kabelac <zkabelac@redhat.com>
To: lvm-devel@redhat.com
Subject: Improvement of manpages clvmd.8 and blkdeactivate.8
Date: Wed, 19 Nov 2014 01:28:46 +0100	[thread overview]
Message-ID: <546BE43E.2080104@redhat.com> (raw)
In-Reply-To: <1416069988-13208-1-git-send-email-saulery@free.fr>

Dne 15.11.2014 v 17:46 saulery at free.fr napsal(a):
>
> Hello,
>
> Here is a much improved version of blkdeactivate.8 clvmd.8 and manpages. I can
> update others in the same way if you're interested.
>

This patch set has been only partially accepted.

We cannot use  .OP groff macro since it's not compatible with older systems
(i.e. RHEL5) which do not have them build in and so far we support very wide
set of system to compile on.

Also we generally document long option with adding  '-x' short cut on the same 
line - which is likely not fully compliant but yet well readable.

Also I'm not convinced removing space in option list leads to better man page 
formatting.

So few changes are different from your patches.

Please supply groff error list (ideally with the way how to reproduce)
so we could easily see if there is a way to be more consistent yet
we could avoid rewriting everything.

We would already have 'generated' man pages - yet noone stepped into this 
field yet.

Idea is - to use 'single' place for options and doc for option and generate 
man pages and command line options from it (since current way of hand writing 
is usually not in the closest touch with source code).

Zdenek



  parent reply	other threads:[~2014-11-19  0:28 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-11-15 16:46 Improvement of manpages clvmd.8 and blkdeactivate.8 saulery
2014-11-15 16:46 ` Improve clvmd.8 manpage and help output saulery
2014-11-15 16:46 ` saulery
2014-11-15 16:46 ` Improve blkdeactivate.8 " saulery
2014-11-19  0:28 ` Zdenek Kabelac [this message]
2014-11-19  1:43   ` Improvement of manpages clvmd.8 and blkdeactivate.8 Stéphane Aulery
2014-11-19  7:42     ` Zdenek Kabelac

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=546BE43E.2080104@redhat.com \
    --to=zkabelac@redhat.com \
    --cc=lvm-devel@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.