grub-devel.gnu.org archive mirror
 help / color / mirror / Atom feed
From: Daniel Kiper <daniel.kiper@oracle.com>
To: grub-devel@gnu.org, xen-devel@lists.xenproject.org
Cc: andrew.cooper3@citrix.com, arvidjaar@gmail.com,
	eric.snowberg@oracle.com,  jgross@suse.com,
	konrad.wilk@oracle.com, phcoder@gmail.com,
	seth.goldberg@oracle.com
Subject: [MULTIBOOT2 DOC PATCH v2 03/11] multiboot2: Clarify meaning of information request header tag
Date: Thu, 24 Nov 2016 21:40:02 +0100	[thread overview]
Message-ID: <1480020010-18421-4-git-send-email-daniel.kiper@oracle.com> (raw)
In-Reply-To: <1480020010-18421-1-git-send-email-daniel.kiper@oracle.com>

Signed-off-by: Daniel Kiper <daniel.kiper@oracle.com>
---
v2 - suggestions/fixes:
   - rephrase some sentences
     (suggested by Andrew Cooper),
   - add missing the articles
     (suggested by Andrew Cooper).
---
 doc/multiboot.texi |   20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

diff --git a/doc/multiboot.texi b/doc/multiboot.texi
index c438b38..771aeab 100644
--- a/doc/multiboot.texi
+++ b/doc/multiboot.texi
@@ -443,15 +443,19 @@ u32[n]  | mbi_tag_types     |
 @end group
 @end example
 
-@samp{mbi_tag_types} is an array of u32 each one representing an information
-request
-If this tag is present and @samp{optional} is set to @samp{0} information
-conveyed by requested tag types must be present. If bootloader is unable
-to supply this information it must fail with an error
+@samp{mbi_tag_types} is an array of u32's, each one representing an information request.
 
-Note: it doesn't garantee that any tags of type @samp{mbi_tag_types} will
-actually be present. E.g. on a videoless system even if you requested tag
-@samp{8} no tags of type @samp{8} will be present in mbi.
+If this tag is present and @samp{optional} is set to @samp{0}, the bootloader must
+support the requested tag and be able to provide relevant information to the image
+if it is available. If the bootloader does not understand the meaning of the requested
+tag it must fail with an error. However, if it supports a given tag but the information
+conveyed by it is not available the bootloader does not provide the requested tag in
+the Multiboot2 information structure and passes control to the loaded image as usual.
+
+Note: The above means that there is no guarantee that any tags of type @samp{mbi_tag_types}
+will actually be present. E.g. on a videoless system even if you requested tag @samp{8}
+and the bootloader supports it, no tags of type @samp{8} will be present in the Multiboot2
+information structure.
 
 
 @node Address header tag
-- 
1.7.10.4



  parent reply	other threads:[~2016-11-24 20:40 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-11-24 20:39 [MULTIBOOT2 DOC PATCH v2 00/10] multiboot2: Update documentation Daniel Kiper
2016-11-24 20:40 ` [MULTIBOOT2 DOC PATCH v2 01/11] multiboot2: Rename Multiboot to Multiboot2 Daniel Kiper
2016-11-28 18:06   ` Andrei Borzenkov
2016-11-29  8:45     ` Daniel Kiper
2016-11-24 20:40 ` [MULTIBOOT2 DOC PATCH v2 02/11] multiboot2: Replace redundant if with the Daniel Kiper
2016-11-24 20:40 ` Daniel Kiper [this message]
2016-11-24 20:40 ` [MULTIBOOT2 DOC PATCH v2 04/11] multiboot2: Fix description of EFI boot services tag Daniel Kiper
2016-11-24 20:40 ` [MULTIBOOT2 DOC PATCH v2 05/11] multiboot2: Add description of support for EFI boot services Daniel Kiper
2016-11-24 21:47   ` Toomas Soome
2016-11-28 15:46     ` Daniel Kiper
2016-11-28 16:24       ` Toomas Soome
2016-11-28 17:53   ` Andrei Borzenkov
2016-11-29  9:08     ` Daniel Kiper
2016-11-29  9:39       ` Toomas Soome
2016-11-29 10:09         ` Daniel Kiper
2016-11-29 10:34           ` Toomas Soome
2016-11-24 20:40 ` [MULTIBOOT2 DOC PATCH v2 06/11] multiboot2: Add description of EFI image handle tags Daniel Kiper
2016-11-28 17:59   ` Andrei Borzenkov
2016-11-29  9:18     ` Daniel Kiper
2016-11-24 20:40 ` [MULTIBOOT2 DOC PATCH v2 07/11] multiboot2: Add description of support for relocatable images Daniel Kiper
2016-11-24 20:40 ` [MULTIBOOT2 DOC PATCH v2 08/11] multiboot2: Say that memory maps may not be available on EFI platforms Daniel Kiper
2016-11-24 20:40 ` [MULTIBOOT2 DOC PATCH v2 09/11] multiboot2: Add C structure members alignment and padding consideration section Daniel Kiper
2016-11-24 20:40 ` [MULTIBOOT2 DOC PATCH v2 10/11] multiboot2: Add me to authors Daniel Kiper
2016-11-24 20:40 ` [MULTIBOOT2 DOC PATCH v2 11/11] multiboot2: Bump version to 2.0 Daniel Kiper

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1480020010-18421-4-git-send-email-daniel.kiper@oracle.com \
    --to=daniel.kiper@oracle.com \
    --cc=andrew.cooper3@citrix.com \
    --cc=arvidjaar@gmail.com \
    --cc=eric.snowberg@oracle.com \
    --cc=grub-devel@gnu.org \
    --cc=jgross@suse.com \
    --cc=konrad.wilk@oracle.com \
    --cc=phcoder@gmail.com \
    --cc=seth.goldberg@oracle.com \
    --cc=xen-devel@lists.xenproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).