[PATCH] docs/grub-dev.texi: Fix out of place @itemize and fix makeinfo warnings

* [PATCH] docs/grub-dev.texi: Fix out of place @itemize and fix makeinfo warnings
@ 2013-04-04 20:19 Bryan Hundven
  2013-04-06 19:49 ` Vladimir 'φ-coder/phcoder' Serbinenko
  0 siblings, 1 reply; 7+ messages in thread
From: Bryan Hundven @ 2013-04-04 20:19 UTC (permalink / raw)
  To: grub-devel

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

In @node Bitmap_API, @itemize is not in the @subsection, and causes makeinfo to return 1.
Fix this and move sections in the texi to match the menu order to get rid of the warnings.

I'm new to bzr and contributing to grub. This unified patch applies against trunk/grub.

I've looked around and found a contribution workflow from 2010 in the ML archives, and followed those directions. If there is a better way, please advise.

Thanks,

-Bryan



[-- Attachment #2: cleanup_warnings_grub-dev_texi.patch --]
[-- Type: application/octet-stream, Size: 13582 bytes --]

=== modified file 'ChangeLog'

--- ChangeLog	2013-04-04 08:35:50 +0000
+++ ChangeLog	2013-04-04 19:39:04 +0000
@@ -1,3 +1,7 @@
+2013-04-04  Bryan Hundven <bryanhundven@gmail.com>
+
+	* docs/grub-dev.texi: fix placement of itemize and clean up warnings.
+
 2013-04-04  Vladimir Serbinenko  <phcoder@gmail.com>
 2013-04-04  Peter Jones <pjones@redhat.com>
 

=== modified file 'docs/grub-dev.texi'
--- docs/grub-dev.texi	2012-05-22 07:15:28 +0000
+++ docs/grub-dev.texi	2013-04-04 19:34:34 +0000
@@ -112,6 +112,90 @@
 can use @kbd{bzr pull} to keep it up to date.  If you have modified your
 local version, you may need to resolve conflicts when pulling.
 
+@node Finding your way around
+@chapter Finding your way around
+
+Here is a brief map of the GRUB code base.
+
+GRUB uses Autoconf and Automake, with most of the Automake input generated
+by AutoGen.  The top-level build rules are in @file{configure.ac},
+@file{grub-core/Makefile.core.def}, and @file{Makefile.util.def}.  Each
+block in a @file{*.def} file represents a build target, and specifies the
+source files used to build it on various platforms.  The @file{*.def} files
+are processed into AutoGen input by @file{gentpl.py} (which you only need to
+look at if you are extending the build system).  If you are adding a new
+module which follows an existing pattern, such as a new command or a new
+filesystem implementation, it is usually easiest to grep
+@file{grub-core/Makefile.core.def} and @file{Makefile.util.def} for an
+existing example of that pattern to find out where it should be added.
+
+In general, code that may be run at boot time is in a subdirectory of
+@file{grub-core}, while code that is only run from within a full operating
+system is in a subdirectory of the top level.
+
+Low-level boot code, such as the MBR implementation on PC BIOS systems, is
+in the @file{grub-core/boot/} directory.
+
+The GRUB kernel is in @file{grub-core/kern/}.  This contains core facilities
+such as the device, disk, and file frameworks, environment variable
+handling, list processing, and so on.  The kernel should contain enough to
+get up to a rescue prompt.  Header files for kernel facilities, among
+others, are in @file{include/}.
+
+Terminal implementations are in @file{grub-core/term/}.
+
+Disk access code is spread across @file{grub-core/disk/} (for accessing the
+disk devices themselves), @file{grub-core/partmap/} (for interpreting
+partition table data), and @file{grub-core/fs/} (for accessing filesystems).
+Note that, with the odd specialised exception, GRUB only contains code to
+@emph{read} from filesystems and tries to avoid containing any code to
+@emph{write} to filesystems; this lets us confidently assure users that GRUB
+cannot be responsible for filesystem corruption.
+
+PCI and USB bus handling is in @file{grub-core/bus/}.
+
+Video handling code is in @file{grub-core/video/}.  The graphical menu
+system uses this heavily, but is in a separate directory,
+@file{grub-core/gfxmenu/}.
+
+Most commands are implemented by files in @file{grub-core/commands/}, with
+the following exceptions:
+
+@itemize
+@item
+A few core commands live in @file{grub-core/kern/corecmd.c}.
+
+@item
+Commands related to normal mode live under @file{grub-core/normal/}.
+
+@item
+Commands that load and boot kernels live under @file{grub-core/loader/}.
+
+@item
+The @samp{loopback} command is really a disk device, and so lives in
+@file{grub-core/disk/loopback.c}.
+
+@item
+The @samp{gettext} command lives under @file{grub-core/gettext/}.
+
+@item
+The @samp{loadfont} and @samp{lsfonts} commands live under
+@file{grub-core/font/}.
+
+@item
+The @samp{serial}, @samp{terminfo}, and @samp{background_image} commands
+live under @file{grub-core/term/}.
+
+@item
+The @samp{efiemu_*} commands live under @file{grub-core/efiemu/}.
+@end itemize
+
+There are a few other special-purpose exceptions; grep for them if they
+matter to you.
+
+Utility programs meant to be run from a full operating system are in
+@file{util/}.
+
 @node Coding style
 @chapter Coding style
 @c By YoshinoriOkuji, VesaJääskeläinen and ColinBennett
@@ -210,90 +294,6 @@
 
 The opening @samp{/*} and closing @samp{*/} should be placed together on a line with text.
 
-@node Finding your way around
-@chapter Finding your way around
-
-Here is a brief map of the GRUB code base.
-
-GRUB uses Autoconf and Automake, with most of the Automake input generated
-by AutoGen.  The top-level build rules are in @file{configure.ac},
-@file{grub-core/Makefile.core.def}, and @file{Makefile.util.def}.  Each
-block in a @file{*.def} file represents a build target, and specifies the
-source files used to build it on various platforms.  The @file{*.def} files
-are processed into AutoGen input by @file{gentpl.py} (which you only need to
-look at if you are extending the build system).  If you are adding a new
-module which follows an existing pattern, such as a new command or a new
-filesystem implementation, it is usually easiest to grep
-@file{grub-core/Makefile.core.def} and @file{Makefile.util.def} for an
-existing example of that pattern to find out where it should be added.
-
-In general, code that may be run at boot time is in a subdirectory of
-@file{grub-core}, while code that is only run from within a full operating
-system is in a subdirectory of the top level.
-
-Low-level boot code, such as the MBR implementation on PC BIOS systems, is
-in the @file{grub-core/boot/} directory.
-
-The GRUB kernel is in @file{grub-core/kern/}.  This contains core facilities
-such as the device, disk, and file frameworks, environment variable
-handling, list processing, and so on.  The kernel should contain enough to
-get up to a rescue prompt.  Header files for kernel facilities, among
-others, are in @file{include/}.
-
-Terminal implementations are in @file{grub-core/term/}.
-
-Disk access code is spread across @file{grub-core/disk/} (for accessing the
-disk devices themselves), @file{grub-core/partmap/} (for interpreting
-partition table data), and @file{grub-core/fs/} (for accessing filesystems).
-Note that, with the odd specialised exception, GRUB only contains code to
-@emph{read} from filesystems and tries to avoid containing any code to
-@emph{write} to filesystems; this lets us confidently assure users that GRUB
-cannot be responsible for filesystem corruption.
-
-PCI and USB bus handling is in @file{grub-core/bus/}.
-
-Video handling code is in @file{grub-core/video/}.  The graphical menu
-system uses this heavily, but is in a separate directory,
-@file{grub-core/gfxmenu/}.
-
-Most commands are implemented by files in @file{grub-core/commands/}, with
-the following exceptions:
-
-@itemize
-@item
-A few core commands live in @file{grub-core/kern/corecmd.c}.
-
-@item
-Commands related to normal mode live under @file{grub-core/normal/}.
-
-@item
-Commands that load and boot kernels live under @file{grub-core/loader/}.
-
-@item
-The @samp{loopback} command is really a disk device, and so lives in
-@file{grub-core/disk/loopback.c}.
-
-@item
-The @samp{gettext} command lives under @file{grub-core/gettext/}.
-
-@item
-The @samp{loadfont} and @samp{lsfonts} commands live under
-@file{grub-core/font/}.
-
-@item
-The @samp{serial}, @samp{terminfo}, and @samp{background_image} commands
-live under @file{grub-core/term/}.
-
-@item
-The @samp{efiemu_*} commands live under @file{grub-core/efiemu/}.
-@end itemize
-
-There are a few other special-purpose exceptions; grep for them if they
-matter to you.
-
-Utility programs meant to be run from a full operating system are in
-@file{util/}.
-
 @node Contributing Changes
 @chapter Contributing changes
 @c By YoshinoriOkuji, VesaJääskeläinen, ColinWatson
@@ -1353,6 +1353,92 @@
 Returns currently active render target. It returns value in @code{target} that can be subsequently issued back to @code{grub_video_set_active_render_target}.
 @end itemize
 
+@node Bitmap API
+@section Bitmap API
+@subsection grub_video_bitmap_create
+@itemize
+@item Prototype:
+@example
+grub_err_t grub_video_bitmap_create (struct grub_video_bitmap **bitmap, unsigned int width, unsigned int height, enum grub_video_blit_format blit_format)
+@end example
+
+@item Description:
+
+Creates a new bitmap with given dimensions and blitting format. Allocated bitmap data can then be modified freely and finally blitted with @code{grub_video_blit_bitmap} to rendering target.
+@end itemize
+
+@subsection grub_video_bitmap_destroy
+@itemize
+@item Prototype:
+@example
+grub_err_t grub_video_bitmap_destroy (struct grub_video_bitmap *bitmap);
+@end example
+
+@item Description:
+
+When bitmap is no longer needed, it can be freed from memory using this command. @code{bitmap} is previously allocated bitmap with @code{grub_video_bitmap_create} or loaded with @code{grub_video_bitmap_load}.
+@end itemize
+
+@subsection grub_video_bitmap_load
+@itemize
+@item Prototype:
+@example
+grub_err_t grub_video_bitmap_load (struct grub_video_bitmap **bitmap, const char *filename);
+@end example
+
+@item Description:
+
+Tries to load given bitmap (@code{filename}) using registered bitmap loaders. In case bitmap format is not recognized or supported error @code{GRUB_ERR_BAD_FILE_TYPE} is returned.
+@end itemize
+
+@subsection grub_video_bitmap_get_width
+@itemize
+@item Prototype:
+@example
+unsigned int grub_video_bitmap_get_width (struct grub_video_bitmap *bitmap);
+@end example
+
+@item Description:
+
+Returns bitmap width.
+@end itemize
+
+@subsection grub_video_bitmap_get_height
+@itemize
+@item Prototype:
+@example
+unsigned int grub_video_bitmap_get_height (struct grub_video_bitmap *bitmap);
+@end example
+
+@item Description:
+
+Return bitmap height.
+@end itemize
+
+@subsection grub_video_bitmap_get_mode_info
+@itemize
+@item Prototype:
+@example
+void grub_video_bitmap_get_mode_info (struct grub_video_bitmap *bitmap, struct grub_video_mode_info *mode_info);
+@end example
+
+@item Description:
+
+Returns bitmap format details in form of @code{grub_video_mode_info}.
+@end itemize
+
+@subsection grub_video_bitmap_get_data
+@itemize
+@item Prototype:
+@example
+void *grub_video_bitmap_get_data (struct grub_video_bitmap *bitmap);
+@end example
+
+@item Description:
+
+Return pointer to bitmap data. Contents of the pointed data can be freely modified. There is no extra protection against going off the bounds so you have to be carefull how to access the data.
+@end itemize
+
 @node Example usage of Video API
 @section Example usage of Video API
 @subsection Example of screen setup
@@ -1392,92 +1478,6 @@
 grub_video_blit_glyph (&glyph, color, 0, 0);
 @end example
 
-@node Bitmap API
-@section Bitmap API
-@itemize
-@subsection grub_video_bitmap_create
-@item Prototype:
-@example
-grub_err_t grub_video_bitmap_create (struct grub_video_bitmap **bitmap, unsigned int width, unsigned int height, enum grub_video_blit_format blit_format)
-@end example
-
-@item Description:
-
-Creates a new bitmap with given dimensions and blitting format. Allocated bitmap data can then be modified freely and finally blitted with @code{grub_video_blit_bitmap} to rendering target.
-@end itemize
-
-@subsection grub_video_bitmap_destroy
-@itemize
-@item Prototype:
-@example
-grub_err_t grub_video_bitmap_destroy (struct grub_video_bitmap *bitmap);
-@end example
-
-@item Description:
-
-When bitmap is no longer needed, it can be freed from memory using this command. @code{bitmap} is previously allocated bitmap with @code{grub_video_bitmap_create} or loaded with @code{grub_video_bitmap_load}.
-@end itemize
-
-@subsection grub_video_bitmap_load
-@itemize
-@item Prototype:
-@example
-grub_err_t grub_video_bitmap_load (struct grub_video_bitmap **bitmap, const char *filename);
-@end example
-
-@item Description:
-
-Tries to load given bitmap (@code{filename}) using registered bitmap loaders. In case bitmap format is not recognized or supported error @code{GRUB_ERR_BAD_FILE_TYPE} is returned.
-@end itemize
-
-@subsection grub_video_bitmap_get_width
-@itemize
-@item Prototype:
-@example
-unsigned int grub_video_bitmap_get_width (struct grub_video_bitmap *bitmap);
-@end example
-
-@item Description:
-
-Returns bitmap width.
-@end itemize
-
-@subsection grub_video_bitmap_get_height
-@itemize
-@item Prototype:
-@example
-unsigned int grub_video_bitmap_get_height (struct grub_video_bitmap *bitmap);
-@end example
-
-@item Description:
-
-Return bitmap height.
-@end itemize
-
-@subsection grub_video_bitmap_get_mode_info
-@itemize
-@item Prototype:
-@example
-void grub_video_bitmap_get_mode_info (struct grub_video_bitmap *bitmap, struct grub_video_mode_info *mode_info);
-@end example
-
-@item Description:
-
-Returns bitmap format details in form of @code{grub_video_mode_info}.
-@end itemize
-
-@subsection grub_video_bitmap_get_data
-@itemize
-@item Prototype:
-@example
-void *grub_video_bitmap_get_data (struct grub_video_bitmap *bitmap);
-@end example
-
-@item Description:
-
-Return pointer to bitmap data. Contents of the pointed data can be freely modified. There is no extra protection against going off the bounds so you have to be carefull how to access the data.
-@end itemize
-
 @node PFF2 Font File Format
 @chapter PFF2 Font File Format
 


^ permalink raw reply	[flat|nested] 7+ messages in thread