From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.71) id 1UUd2l-0001w7-2g for mharc-grub-devel@gnu.org; Tue, 23 Apr 2013 09:13:59 -0400 Received: from eggs.gnu.org ([208.118.235.92]:51768) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UUd2f-0001qZ-IQ for grub-devel@gnu.org; Tue, 23 Apr 2013 09:13:56 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UUd2X-0004r7-EC for grub-devel@gnu.org; Tue, 23 Apr 2013 09:13:53 -0400 Received: from mail.gw90.de ([188.40.100.199]:35365) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UUd2X-0004q3-3g for grub-devel@gnu.org; Tue, 23 Apr 2013 09:13:45 -0400 Received: from e178079183.adsl.alicedsl.de ([85.178.79.183] helo=[192.168.2.49]) by mail.gw90.de with esmtpsa (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.72) (envelope-from ) id 1UUd2R-0001iV-Fp for grub-devel@gnu.org; Tue, 23 Apr 2013 13:13:39 +0000 Message-ID: <1366722817.14205.17.camel@mattotaupa> Subject: [RFC][PATCH] documentation update From: Paul Menzel To: grub-devel@gnu.org Date: Tue, 23 Apr 2013 15:13:37 +0200 In-Reply-To: <2595738.eKyERY89We@icedphoenix> References: <2595738.eKyERY89We@icedphoenix> Content-Type: multipart/signed; micalg="pgp-sha1"; protocol="application/pgp-signature"; boundary="=-XB1HhoaUJ2rYv5yuf4pk" X-Mailer: Evolution 3.4.4-3 Mime-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-Received-From: 188.40.100.199 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: Tue, 23 Apr 2013 13:13:57 -0000 --=-XB1HhoaUJ2rYv5yuf4pk Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Dear Vladimir, you can use the [RFC] tag (*r*equest *f*or *c*omments) to mark draf patches. Also inline patches (not sure how to do this with Bazaar) would it make easier for me to comment them. Am Dienstag, den 23.04.2013, 14:14 +0400 schrieb Vladimir Testov: > diff -Naur grub-2.01/docs/grub.texi grub-new/docs/grub.texi > --- grub-2.01/docs/grub.texi 2013-03-28 23:28:47.000000000 +0400 > +++ grub-new/docs/grub.texi 2013-04-19 03:45:33.641661014 +0400 > @@ -1934,19 +1934,30 @@ > @itemize > @item label > A label displays a line of text. > - =20 > + > Properties: > + > @multitable @columnfractions 0.2 0.7 > - @item text @tab The text to display. > - @item font @tab The font to use for text display. > - @item color @tab The color of the text. > - @item align @tab The horizontal alignment of the text within the comp= onent. Options are ``left``, ``center``, and ``right``. > + @item id > + @tab Set id to ``__timeout__`` to display time, elapsed to booting > + the default entry. Set id to ``__timeout__`` to display the elapsed time to booting the default entry. > + @item text > + @tab The text to display. If ID is set to ``__timeout__`` and no `= `text`` ID or id or ``id``? > + property is set then amount of seconds will be shown. If the value= of =C2=BB=E2=80=A6 then *the* amount of =E2=80=A6=C2=AB or just =C2=BB=E2=80= =A6 the amount of seconds=E2=80=A6=C2=AB > + this property is set to ``@@KEYMAP_SHORT@@``, ``@@KEYMAP_MIDDLE@@`= ` or > + ``@@KEYMAP_LONG@@`` then predefined hotkey information will be sho= wn. Reading that, I have a hard time to understand the implications. Is it easy to add examples? > + @item font > + @tab The font to use for text display. > + @item color > + @tab The color of the text. > + @item align > + @tab The horizontal alignment of the text within the component. Op= tions > + are ``left``, ``center``, and ``right``. > @end multitable > =20 > @item image > A component that displays an image. The image is scaled to fit the > - component, although the preferred size defaults to the image's origin= al > - size unless the ``preferred_size`` property is explicitly set. > + component. > =20 > Properties: > =20 > @@ -1961,17 +1972,40 @@ > Properties: > =20 > @multitable @columnfractions 0.2 0.7 > - @item fg_color @tab The foreground color for plain solid color render= ing. > - @item bg_color @tab The background color for plain solid color render= ing. > - @item border_color @tab The border color for plain solid color render= ing. > - @item text_color @tab The text color. > - @item show_text @tab Boolean value indicating whether or not text sho= uld be displayed on the progress bar. If set to *false*, then no text will= be displayed on the bar. If set to any other value, text will be displaye= d on the bar. > - @item bar_style @tab The styled box specification for the frame of th= e progress bar. Example: ``progress_frame_*.png`` > - @item highlight_style @tab The styled box specification for the highl= ighted region of the progress bar. This box will be used to paint just the = highlighted region of the bar, and will be increased in size as the bar nea= rs completion. Example: ``progress_hl_*.png``. > - @item text @tab The text to display on the progress bar. If the prog= ress bar's ID is set to ``__timeout__``, then GRUB will updated this proper= ty with an informative message as the timeout approaches. > - @item value @tab The progress bar current value. Normally not set ma= nually. > - @item start @tab The progress bar start value. Normally not set manu= ally. > - @item end @tab The progress bar end value. Normally not set manually= . > + @item id > + @tab Set id to ``__timeout__`` to display time, elapsed to booting > + the default entry. See above. > + @item fg_color > + @tab The foreground color for plain solid color rendering. > + @item bg_color > + @tab The background color for plain solid color rendering. > + @item border_color > + @tab The border color for plain solid color rendering. > + @item text_color > + @tab The text color. > + @item font > + @tab The font to use for the progress bar. > + @item bar_style > + @tab The styled box specification for the frame of the progress ba= r. > + Example: ``progress_frame_*.png`` > + @item highlight_style > + @tab The styled box specification for the highlighted region of th= e > + progress bar. This box will be used to paint just the highlighted = region > + of the bar, and will be increased in size as the bar nears complet= ion. > + Example: ``progress_hl_*.png``. > + If the value of the ``bar_style`` property is equal to=20 > + the value of the ``highlight_style`` property > + then no styled boxes will be drawn. > + @item text > + @tab The text to display on the progress bar. If the progress bar= 's ID > + is set to ``__timeout__`` and the value of this property is set to > + ``@@TIMEOUT_NOTIFICATION_SHORT@@``, ``@@TIMEOUT_NOTIFICATION_MIDDL= E@@`` > + or ``@@TIMEOUT_NOTIFICATION_LONG@@``, then GRUB will update this > + property with an informative message as the timeout approaches. > + @item theme_dir > + @tab The full path to the directory where styled boxes are holded. =C2=BB=E2=80=A6 are hold.=C2=AB or =C2=BBare stored/saved/placed=C2=AB? > + This property should be set if styled boxes are not placed in the > + default directory. > @end multitable > =20 > @item circular_progress > @@ -1985,6 +2019,9 @@ > Properties: > =20 > @multitable @columnfractions 0.3 0.6 > + @item id > + @tab Set id to ``__timeout__`` to display time, elapsed to booting > + the default entry. See above. > @item center_bitmap > @tab The file name of the image to draw in the center of the compo= nent. > @item tick_bitmap > @@ -1994,14 +2031,16 @@ > @item ticks_disappear > @tab Boolean value indicating whether tick marks should progressiv= ely appear, > or progressively disappear as *value* approaches *end*. Specify > - ``true`` or ``false``. > - @item value > - @tab The progress indicator current value. Normally not set manua= lly. > - @item start > - @tab The progress indicator start value. Normally not set manuall= y. > - @item end > - @tab The progress indicator end value. Normally not set manually. > + ``true`` or ``false``. Default value is ``false``. > + @item start_angle > + @tab The position of the first tick mark to appear or disappear. M= easured in > + ``parrots``, where 1 ``parrot`` equals to 1 / 256 of the full circ= le. > + @item theme_dir > + @tab The full path to the directory where bitmaps are holded. See above. > + This property should be set if bitmaps are not placed in the > + default directory. > @end multitable > + > @item boot_menu > Displays the GRUB boot menu. It allows selecting items and executing= them. > =20 > @@ -2047,10 +2086,13 @@ > @tab The image file pattern for the scroll bar thumb (the part of = the scroll > bar that moves as scrolling occurs). > Example: ``scrollbar_thumb_*.png`` > - @item max_items_shown > - @tab The maximum number of items to show on the menu. If there ar= e more than > - *max_items_shown* items in the menu, the list will scroll to make = all > - items accessible. > + @item visible > + @tab Show or hide boot menu. Specify ``true`` or ``false``. > + Default value is ``true``. > + @item theme_dir > + @tab The full path to the directory where slyled boxes are holded. > + This property should be set if styled boxes are not placed in the > + default directory. > @end multitable > =20 > @item canvas > @@ -2062,7 +2104,7 @@ > The *hbox* container lays out its children from left to right, giving= each > one its preferred width. The height of each child is set to the maxi= mum of > the preferred heights of all children. > - =20 > + > @item vbox > The *vbox* container lays out its children from top to bottom, giving= each > one its preferred height. The width of each child is set to the maxi= mum of Thanks, Paul --=-XB1HhoaUJ2rYv5yuf4pk Content-Type: application/pgp-signature; name="signature.asc" Content-Description: This is a digitally signed message part Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.12 (GNU/Linux) iEYEABECAAYFAlF2iQEACgkQPX1aK2wOHVgflQCghcPPKRXE4Dzd5fNcOShyryfZ /5kAnjUcdRadhsHyb7nkB9KLoeUPQNik =4Rn3 -----END PGP SIGNATURE----- --=-XB1HhoaUJ2rYv5yuf4pk--