[PATCH 2/8] docs: Provide some examples of the various ELF values.

[Konrad Rzeszutek Wilk <konrad@kernel.org>]

Signed-off-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
---
 xen/include/public/elfnote.h | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/xen/include/public/elfnote.h b/xen/include/public/elfnote.h
index 3c57a06..74223dd 100644
--- a/xen/include/public/elfnote.h
+++ b/xen/include/public/elfnote.h
@@ -48,14 +48,19 @@
 /*
  * The virtual address of the entry point (numeric).
  *
+ * Example is 0xffffffff81899200.
+ *
  * LEGACY: VIRT_ENTRY
  */
 #define XEN_ELFNOTE_ENTRY          1
 
 /* The virtual address of the hypercall transfer page (numeric).
  *
+ * Example is 0xffffffff81001000 (but not for legacy)
+ *
  * LEGACY: HYPERCALL_PAGE. (n.b. legacy value is a physical page
  * number not a virtual address)
+ *
  */
 #define XEN_ELFNOTE_HYPERCALL_PAGE 2
 
@@ -63,6 +68,8 @@
  *
  * Defaults to 0.
  *
+ * Example is 0xffffffff80000000.
+ *
  * LEGACY: VIRT_BASE
  */
 #define XEN_ELFNOTE_VIRT_BASE      3
@@ -82,6 +89,8 @@
 /*
  * The version of Xen that we work with (string).
  *
+ * Example is "xen-3.0"
+ *
  * LEGACY: XEN_VER
  */
 #define XEN_ELFNOTE_XEN_VERSION    5
@@ -89,6 +98,7 @@
 /*
  * The name of the guest operating system (string).
  *
+ * Example is "linux"
  * LEGACY: GUEST_OS
  */
 #define XEN_ELFNOTE_GUEST_OS       6
@@ -96,6 +106,8 @@
 /*
  * The version of the guest operating system (string).
  *
+ * Example is "2.6"
+ *
  * LEGACY: GUEST_VER
  */
 #define XEN_ELFNOTE_GUEST_VERSION  7
@@ -103,6 +115,8 @@
 /*
  * The loader type (string).
  *
+ * Example is "generic"
+ *
  * LEGACY: LOADER
  */
 #define XEN_ELFNOTE_LOADER         8
@@ -130,6 +144,9 @@
  * features.h, without the "XENFEAT_" prefix) separated by '|'
  * characters. If a feature is required for the kernel to function
  * then the feature name must be preceded by a '!' character.
+ * For the full list, please look in "features.h"
+ *
+ * Example are: "!writable_page_tables|pae_pgdir_above_4gb"
  *
  * LEGACY: FEATURES
  */
@@ -149,6 +166,8 @@
  * This must not be set higher than HYPERVISOR_VIRT_START. Its presence
  * also indicates to the hypervisor that the kernel can deal with the
  * hole starting at a higher address.
+ *
+ * Example is  0xffff800000000000.
  */
 #define XEN_ELFNOTE_HV_START_LOW  12
 
-- 
1.7.11.7