From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.71) id 1UDvjf-0003WH-7u for mharc-grub-devel@gnu.org; Fri, 08 Mar 2013 06:45:15 -0500 Received: from eggs.gnu.org ([208.118.235.92]:55925) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UDvjc-0003Ud-CM for grub-devel@gnu.org; Fri, 08 Mar 2013 06:45:14 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UDvjW-0000pY-HN for grub-devel@gnu.org; Fri, 08 Mar 2013 06:45:12 -0500 Received: from mail-wi0-x229.google.com ([2a00:1450:400c:c05::229]:58112) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UDvjW-0000oJ-7M for grub-devel@gnu.org; Fri, 08 Mar 2013 06:45:06 -0500 Received: by mail-wi0-f169.google.com with SMTP id l13so4173580wie.2 for ; Fri, 08 Mar 2013 03:45:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=x-received:date:from:to:subject:message-id:in-reply-to:references :x-mailer:mime-version:content-type; bh=kYD6bdjcF9s+mYQ2IPJFRFoa4XYUNWicJDRvWPCvlRQ=; b=ejcab56kPJL9U51Q+Jd2HD7Jn+uofy1UTYBy+OLKgrb0T+/XnK42eMUB9yw16W8GAf xT7dkqVMGf3RZ+x8jsWzcENGlnbUBR6gboC0rbn7+aDk7t/9lGlw8U77LQ9L1JvhPi8z ZTFIaVb8rpB3aT3RQBci0QtfCRYGxjlUsKn6iUl0IuvqMw6aKseXRQwowZ/DAT19Y+0u 9jw3utUMuG7K6tgtSvnhjuiTFiMIwGEnf5aq472umhbteyW2Ijv8+EEdRQdAVqrdt/49 HIvm3mwvfc01grokJhxWeMw9qklW4lHmLkzYbFuI4/EzUFohy60txjEsjPhFEJqc4KEK JaVQ== X-Received: by 10.180.100.10 with SMTP id eu10mr13149106wib.4.1362743105432; Fri, 08 Mar 2013 03:45:05 -0800 (PST) Received: from opensuse.site (ppp79-139-243-180.pppoe.spdop.ru. [79.139.243.180]) by mx.google.com with ESMTPS id ej8sm38832077wib.9.2013.03.08.03.45.04 (version=SSLv3 cipher=RC4-SHA bits=128/128); Fri, 08 Mar 2013 03:45:04 -0800 (PST) Date: Fri, 8 Mar 2013 15:45:02 +0400 From: Andrey Borzenkov To: grub-devel@gnu.org Subject: Re: Command documentation part 1. Message-ID: <20130308154502.72dda706@opensuse.site> In-Reply-To: <513874D0.7090306@gmail.com> References: <20130122170851.1bb50f87@opensuse.site> <20130122171218.GA9543@riva.dynamic.greenend.org.uk> <20130129142517.44838703@opensuse.site> <51163783.7030006@gmail.com> <20130224114056.4cd4a5b0@opensuse.site> <513874D0.7090306@gmail.com> X-Mailer: Claws Mail 3.9.0 (GTK+ 2.24.10; x86_64-suse-linux-gnu) Mime-Version: 1.0 Content-Type: multipart/signed; micalg=PGP-SHA1; boundary="Sig_/Ubo0tA29LA8f/v1F_jp_pSw"; protocol="application/pgp-signature" X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2a00:1450:400c:c05::229 X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list Reply-To: The development of GNU GRUB List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 08 Mar 2013 11:45:14 -0000 --Sig_/Ubo0tA29LA8f/v1F_jp_pSw Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable =D0=92 Thu, 07 Mar 2013 12:06:56 +0100 Vladimir '=CF=86-coder/phcoder' Serbinenko =D0=BF=D0=B8= =D1=88=D0=B5=D1=82: > On 24.02.2013 08:40, Andrey Borzenkov wrote: >=20 > > =20 > > @menu > > +* [:: Check file types and compare values > > * acpi:: Load ACPI tables > > +* authenticate:: Check whether user is in user list > > +* background_color:: Set background color for active termin= al > > +* background_image:: Load background image for active termi= nal >=20 > These are specific to gfxterm, not generic how your patch would suggest. Is it enough to mention that in command description or we need separate section for gfxterm-specific commands? > > +* vbeinfo:: List available video modes >=20 > vbeinfo is a compatibility alias and is reserved for VBE. > Perhaps we should start having commands specifically excluded from help > lists to discourage their use >=20 Is it OK to leave them as comments as Colin suggested (so that they won't be re-added over and over again)? >=20 > > +@node cmosclean > > +@subsection cmosclean > > + > > +@deffn Command cmosclean byte:bit > > +Clear value of bit in CMOS at location @var{byte}:@var{bit}. This com= mand > > +is available only on PC BIOS platform. > > +@end deffn >=20 > It's available on all platforms featuring CMOS which are all x86 > (including EFI, coreboot, ieeee1275, and so on), Loongson, Qemu-mips and > some IEEE1275 platforms (determined at runtime). >=20 Is it OK to change it into "This command is available only on platforms that support CMOS"? > > -@deffn Command crc file > > -Display the CRC32 checksum of @var{file}. > > +@deffn Command crc arg @dots{} > > +Alias for @code{hashsum --hash crc32 arg @dots{}}. See command @comman= d{hashsum} > > +(@pxref{hashsum}) for full description. > > +@end deffn > > + > > + > > +@node cryptomount > > +@subsection cryptomount > > + > > +@deffn Command cryptomount device|@option{-u} uuid|@option{-a}|@option= {-b} > > +Setup access to encrypted device. If necessary, passphrase > > +is requested interactively. Option @var{device} configures specific gr= ub device > > +(@pxref{Naming convention}); option @option{-u} @var{uuid} configures = device > > +with specified @var{uuid}; option @option{-a} configures all encrypted= devices; >=20 > Only the ones GRUB supports >=20 > > +option @option{-b} configures all partitions that have boot flag set. >=20 > Last part is wrong. It refers to boot flag in geli container, not the > one in partmap. To be honest, this is taken directly from command help; I do not know myself what geli is. Could you suggest correct description for this option? > Also I think it's worth mentioning that luks/geli/... aren't autoloaded. >=20 OK > > +@node hashsum > > +@subsection hashsum > > + > > +@deffn Command hashsum @option{--hash} hash @option{--keep-going} @opt= ion{--uncompress} @option{--check} file [@option{--prefix} dir]|file @dots{} > > +Compute or verify file hashes. Hash type is selected with option @opti= on{--hash}. > > +Supported hashes are @samp{crc32}, @samp{md5}, @samp{sha1}, @samp{sha2= 56}, > > +@samp{sha512}. >=20 > Much more hashes are supported. Currently: >=20 OK, I see. > > +When option @option{--check} is given, it points to a file that contai= ns > > +list of @var{hash name} pairs. File hash and file name are separated by > > +single @key{SPACE} or @key{TAB}, one pair on a line. Option @option{--= prefix} > > +may be used to give directory where files are located. Hash verificati= on > > +stops after the first mismatch was found unless option @option{--keep-= going} > > +was given. > > +@end deffn >=20 > This is the same format as used by standard UNIX tools. >=20 Sure; do you mean there is no need to document it? > > @@ -4147,6 +4372,74 @@ will not be shown immediately. > > @end deffn > > =20 > > =20 > > +@node test > > +@subsection test > > + > > +@deffn Command test expression > > +Evaluate @var{expression} and return zero exit status if result is tru= e, > > +non zero status otherwise. > > + > > +@var{expression} is one of: >=20 >=20 > Did you copy it from somewhere else? Please specify all parts copied > from anywhere else. >=20 I used "man test" as template. I think the only part that was directly copied was this sentence. --Sig_/Ubo0tA29LA8f/v1F_jp_pSw Content-Type: application/pgp-signature; name=signature.asc Content-Disposition: attachment; filename=signature.asc -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.19 (GNU/Linux) iEYEARECAAYFAlE5zz4ACgkQR6LMutpd94x9HgCgx9DXeoIf2U601YAQM5d/Q9KF FiAAoNHehZlBGnyTrGv1uRuBB8ssi6O8 =MIZp -----END PGP SIGNATURE----- --Sig_/Ubo0tA29LA8f/v1F_jp_pSw--