2005-07-17 Yoshinori Okuji <okuji@enbug.org>

* commands/cat.c (GRUB_MOD_INIT): Use better documentation.
	(grub_cat_init): Likewise.
	* loader/i386/pc/chainloader_normal.c (GRUB_MOD_INIT): Likewise.
	(options): Likewise.
	* commands/configfile.c (GRUB_MOD_INIT): Likewise.
	(grub_configfile_init): Likewise.
	* font/manager.c (GRUB_MOD_INIT): Likewise.
	* commands/help.c (GRUB_MOD_INIT): Likewise.
	(grub_help_init): Likewise.
	* normal/command.c (grub_command_init): Likewise.
	* loader/i386/pc/linux_normal.c (GRUB_MOD_INIT): Likewise.
	* disk/loopback.c (grub_loop_init): Likewise.
	(GRUB_MOD_INIT): Likewise.
	* commands/ls.c (grub_ls_init): Likewise.
	(GRUB_MOD_INIT): Likewise.
	(options): Likewise.
	* commands/boot.c (grub_boot_init): Likewise.
	(GRUB_MOD_INIT): Likewise.
	* loader/i386/pc/multiboot_normal.c (GRUB_MOD_INIT): Likewise.
	* commands/i386/pc/reboot.c (grub_reboot_init): Likewise.
	(GRUB_MOD_INIT): Likewise.
	* commands/cmp.c (grub_cmp_init): Likewise.
	(GRUB_MOD_INIT): Likewise.

	* normal/arg.c: Use <> instead of "" to include header files.
	(SHORT_ARG_HELP): New macro.
	(SHORT_ARG_USAGE): Likewise.
	(help_options): Specify SHORT_ARG_HELP and SHORT_ARG_USAGE instead
	of 'h' and 'u' for help and usage, respectively. Use more GNU-like
	descriptions.
	(find_short): Check if C is 'h' or 'u' explicitly.
	(grub_arg_show_help): Use space characters instead of tabs. Treat
	SHORT_ARG_HELP and SHORT_ARG_USAGE exceptionally so that -h and -u
	are shown with --help and --usage only if they are not used for
	the command itself.
	(parse_option): Use SHORT_ARG_HELP and SHORT_ARG_USAGE instead of
	'h' and 'u'.

	* include/grub/arg.h (struct grub_arg_option): Add the qualifier
	const into "longarg". Change the type of "shortarg" to int.
This commit is contained in:
okuji 2005-07-17 20:26:07 +00:00
parent f806d18efd
commit 502c87e80e
17 changed files with 174 additions and 72 deletions

View file

@ -1,7 +1,7 @@
/* boot.c - command to boot an operating system */
/*
* GRUB -- GRand Unified Bootloader
* Copyright (C) 2003 Free Software Foundation, Inc.
* Copyright (C) 2003,2005 Free Software Foundation, Inc.
*
* GRUB is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@ -43,7 +43,7 @@ void
grub_boot_init (void)
{
grub_register_command ("boot", grub_cmd_boot, GRUB_COMMAND_FLAG_BOTH,
"boot", "Boot an operating system", 0);
"boot", "Boot an operating system.", 0);
}
void
@ -54,9 +54,9 @@ grub_boot_fini (void)
#else /* ! GRUB_UTIL */
GRUB_MOD_INIT
{
(void)mod; /* To stop warning. */
(void) mod; /* To stop warning. */
grub_register_command ("boot", grub_cmd_boot, GRUB_COMMAND_FLAG_BOTH,
"boot", "Boot an operating system", 0);
"boot", "Boot an operating system.", 0);
}
GRUB_MOD_FINI

View file

@ -1,7 +1,7 @@
/* cat.c - command to show the contents of a file */
/*
* GRUB -- GRand Unified Bootloader
* Copyright (C) 2003 Free Software Foundation, Inc.
* Copyright (C) 2003,2005 Free Software Foundation, Inc.
*
* GRUB is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@ -74,7 +74,7 @@ void
grub_cat_init (void)
{
grub_register_command ("cat", grub_cmd_cat, GRUB_COMMAND_FLAG_BOTH,
"cat FILE", "Show the contents of a file", 0);
"cat FILE", "Show the contents of a file.", 0);
}
void
@ -85,9 +85,9 @@ grub_cat_fini (void)
#else /* ! GRUB_UTIL */
GRUB_MOD_INIT
{
(void)mod; /* To stop warning. */
(void) mod; /* To stop warning. */
grub_register_command ("cat", grub_cmd_cat, GRUB_COMMAND_FLAG_BOTH,
"cat FILE", "Show the contents of a file", 0);
"cat FILE", "Show the contents of a file.", 0);
}
GRUB_MOD_FINI

View file

@ -1,7 +1,7 @@
/* cmd.c - command to cmp an operating system */
/*
* GRUB -- GRand Unified Bootloader
* Copyright (C) 2003 Free Software Foundation, Inc.
* Copyright (C) 2003,2005 Free Software Foundation, Inc.
*
* GRUB is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@ -106,7 +106,7 @@ void
grub_cmp_init (void)
{
grub_register_command ("cmp", grub_cmd_cmp, GRUB_COMMAND_FLAG_BOTH,
"cmp FILE1 FILE2", "Compare two files", 0);
"cmp FILE1 FILE2", "Compare two files.", 0);
}
void
@ -117,9 +117,9 @@ grub_cmp_fini (void)
#else /* ! GRUB_UTIL */
GRUB_MOD_INIT
{
(void)mod; /* To stop warning. */
(void) mod; /* To stop warning. */
grub_register_command ("cmp", grub_cmd_cmp, GRUB_COMMAND_FLAG_BOTH,
"cmp FILE1 FILE2", "Compare two files", 0);
"cmp FILE1 FILE2", "Compare two files.", 0);
}
GRUB_MOD_FINI

View file

@ -45,7 +45,7 @@ grub_configfile_init (void)
{
grub_register_command ("configfile", grub_cmd_configfile,
GRUB_COMMAND_FLAG_BOTH, "configfile FILE",
"Load config file", 0);
"Load another config file.", 0);
}
void
@ -56,10 +56,10 @@ grub_configfile_fini (void)
#else /* ! GRUB_UTIL */
GRUB_MOD_INIT
{
(void)mod; /* To stop warning. */
(void) mod; /* To stop warning. */
grub_register_command ("configfile", grub_cmd_configfile,
GRUB_COMMAND_FLAG_BOTH, "configfile FILE",
"Load config file", 0);
"Load another config file.", 0);
}
GRUB_MOD_FINI

View file

@ -99,7 +99,7 @@ void
grub_help_init (void)
{
grub_register_command ("help", grub_cmd_help, GRUB_COMMAND_FLAG_CMDLINE,
"help [PATTERN ...]", "Shows a help message", 0);
"help [PATTERN ...]", "Show a help message.", 0);
}
void
@ -112,7 +112,7 @@ GRUB_MOD_INIT
{
(void)mod; /* To stop warning. */
grub_register_command ("help", grub_cmd_help, GRUB_COMMAND_FLAG_CMDLINE,
"help [PATTERN ...]", "Shows a help message", 0);
"help [PATTERN ...]", "Show a help message.", 0);
}
GRUB_MOD_FINI

View file

@ -25,7 +25,7 @@
static const struct grub_arg_option options[] =
{
{"no-apm", 'n', 0, "Don't use APM to halt the computer", 0, 0},
{"no-apm", 'n', 0, "do not use APM to halt the computer", 0, 0},
{0, 0, 0, 0, 0, 0}
};
@ -63,7 +63,7 @@ GRUB_MOD_INIT
{
(void)mod; /* To stop warning. */
grub_register_command ("halt", grub_cmd_halt, GRUB_COMMAND_FLAG_BOTH,
"halt [OPTIONS...]",
"halt [-n]",
"Halt the system, if possible using APM", options);
}

View file

@ -40,7 +40,7 @@ void
grub_reboot_init (void)
{
grub_register_command ("reboot", grub_cmd_reboot, GRUB_COMMAND_FLAG_BOTH,
"reboot", "Reboot the computer", 0);
"reboot", "Reboot the computer.", 0);
}
void

View file

@ -33,9 +33,9 @@
static const struct grub_arg_option options[] =
{
{"long", 'l', 0, "Show a long list with more detailed information", 0, 0},
{"human-readable", 'h', 0, "Print sizes in a human readable format", 0, 0},
{"all", 'a', 0, "List all files", 0, 0},
{"long", 'l', 0, "show a long list with more detailed information", 0, 0},
{"human-readable", 'h', 0, "print sizes in a human readable format", 0, 0},
{"all", 'a', 0, "list all files", 0, 0},
{0, 0, 0, 0, 0, 0}
};
@ -241,8 +241,8 @@ void
grub_ls_init (void)
{
grub_register_command ("ls", grub_cmd_ls, GRUB_COMMAND_FLAG_BOTH,
"ls [OPTIONS...] [DIR]",
"List devices and files", options);
"ls [-l|-h|-a] [FILE]",
"List devices and files.", options);
}
void
@ -255,8 +255,8 @@ GRUB_MOD_INIT
{
(void)mod; /* To stop warning. */
grub_register_command ("ls", grub_cmd_ls, GRUB_COMMAND_FLAG_BOTH,
"ls [OPTIONS...] [DIR]",
"List devices and files", options);
"ls [-l|-h|-a] [FILE]",
"List devices and files.", options);
}
GRUB_MOD_FINI