[RFC][PATCH] documentation update

[Paul Menzel <paulepanter@users.sourceforge.net>]

[-- Attachment #1: Type: text/plain, Size: 8420 bytes --]

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.
> -   
> +
>     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 component. 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

»… then *the* amount of …« or just »… the amount of seconds…«

> +      this property is set to ``@@KEYMAP_SHORT@@``, ``@@KEYMAP_MIDDLE@@`` or
> +      ``@@KEYMAP_LONG@@`` then predefined hotkey information will be shown.

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. Options
> +      are ``left``, ``center``, and ``right``.
>     @end multitable
>  
>  @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 original
> -   size unless the ``preferred_size`` property is explicitly set.
> +   component.
>  
>     Properties:
>  
> @@ -1961,17 +1972,40 @@
>     Properties:
>  
>     @multitable @columnfractions 0.2 0.7
> -   @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 show_text @tab Boolean value indicating whether or not text should 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 displayed on the bar.
> -   @item bar_style @tab The styled box specification for the frame of the progress bar. Example: ``progress_frame_*.png``
> -   @item highlight_style @tab The styled box specification for the highlighted 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 nears completion. Example: ``progress_hl_*.png``.
> -   @item text @tab The text to display on the progress bar.  If the progress bar's ID is set to ``__timeout__``, then GRUB will updated this property with an informative message as the timeout approaches.
> -   @item value @tab The progress bar current value.  Normally not set manually.
> -   @item start @tab The progress bar start value.  Normally not set manually.
> -   @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 bar.
> +      Example: ``progress_frame_*.png``
> +   @item highlight_style
> +      @tab The styled box specification for the highlighted 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 nears completion.
> +      Example: ``progress_hl_*.png``.
> +      If the value of the ``bar_style`` property is equal to 
> +      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_MIDDLE@@``
> +      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.

»… are hold.« or »are stored/saved/placed«?

> +      This property should be set if styled boxes are not placed in the
> +      default directory.
>     @end multitable
>  
>  @item circular_progress
> @@ -1985,6 +2019,9 @@
>     Properties:
>  
>     @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 component.
>     @item tick_bitmap
> @@ -1994,14 +2031,16 @@
>     @item ticks_disappear
>        @tab Boolean value indicating whether tick marks should progressively appear,
>        or progressively disappear as *value* approaches *end*.  Specify
> -      ``true`` or ``false``.
> -   @item value
> -      @tab The progress indicator current value.  Normally not set manually.
> -   @item start
> -      @tab The progress indicator start value.  Normally not set manually.
> -   @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. Measured in
> +      ``parrots``, where 1 ``parrot`` equals to 1 / 256 of the full circle.
> +   @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.
>  
> @@ -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 are 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
>  
>  @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 maximum of
>     the preferred heights of all children.
> -   
> +
>  @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 maximum of


Thanks,

Paul

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 198 bytes --]