Re: [PATCH] makedumpfile: add missing options to man page or help

From: HATAYAMA Daisuke <d.hatayama@jp.fujitsu.com>
To: Baoquan He <bhe@redhat.com>
Cc: kumagai-atsushi@mxc.nes.nec.co.jp, kexec@lists.infradead.org
Subject: Re: [PATCH] makedumpfile: add missing options to man page or help
Date: Thu, 20 Jun 2013 09:01:26 +0900	[thread overview]
Message-ID: <51C24656.1080509@jp.fujitsu.com> (raw)
In-Reply-To: <fc047066a6f5ba18f02838f4b3e89006917db4a5.1371632010.git.bhe@redhat.com>

(2013/06/19 17:55), Baoquan He wrote:
> makedumpfile has some options which has two 2 forms, long option
> and short option. E.g. --help  |  -h
>
> In man page and help, only one of them are presented, user may complain
> of this. Here add missing options.
>

I guess the maintainer does so intentionally, I'm not sure of course. Characters for short options is limited resource, but now makedumpfile has considerably many options. We can no longer assign reasonable letters to each functionality with short options. For example, please look at the definition of longopts:

static struct option longopts[] = {
         {"split", no_argument, NULL, 's'},
         {"reassemble", no_argument, NULL, 'r'},
         {"xen-syms", required_argument, NULL, 'y'},
         {"xen-vmcoreinfo", required_argument, NULL, 'z'},
         {"xen_phys_start", required_argument, NULL, 'P'},
         {"message-level", required_argument, NULL, 'm'},
         {"vtop", required_argument, NULL, 'V'},
         {"dump-dmesg", no_argument, NULL, 'M'},
         {"config", required_argument, NULL, 'C'},
         {"help", no_argument, NULL, 'h'},
         {"diskset", required_argument, NULL, 'k'},
         {"non-cyclic", no_argument, NULL, 'Y'},
         {"cyclic-buffer", required_argument, NULL, 'Z'},
         {"eppic", required_argument, NULL, 'S'},
         {"map-size", required_argument, NULL, 'A'},
         {0, 0, 0, 0}
};

I don't see any relationship on the last three options: non-cyclic vs Y, cyclic-buffer vs Z, eppic vs S and map-size vs A. I don't think there are users who use short options for these features.

One of my solution is conversely to delete short options, and I don't think it problem because the short options are only implicitly exported without explicit description on such as manual page and help message.

-- 
Thanks.
HATAYAMA, Daisuke

_______________________________________________
kexec mailing list
kexec@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/kexec