From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <evan.lloyd@arm.com>
Received: from cam-smtp0.cambridge.arm.com (fw-tnat.cambridge.arm.com
 [217.140.96.140]) (using TLSv1 with cipher AES256-SHA (256/256 bits))
 (No client certificate requested)
 by ml01.01.org (Postfix) with ESMTPS id 5B51F80373
 for <edk2-devel@ml01.01.org>; Thu,  9 Mar 2017 15:49:54 -0800 (PST)
Received: from E111747.Emea.Arm.com (e111747.emea.arm.com [10.1.30.67])
 by cam-smtp0.cambridge.arm.com (8.13.8/8.13.8) with ESMTP id v29Nnlco010779;
 Thu, 9 Mar 2017 23:49:48 GMT
From: evan.lloyd@arm.com
To: edk2-devel@ml01.01.org
Cc: Jaben Carsey <jaben.carsey@intel.com>,
 Ruiyu Ni Leif Lindholm <ruiyu.ni@intel.comleif.lindholm@linaro.org>,
 Michael D Kinney <michael.d.kinney@intel.com>,
 Jiewen Yao <jiewen.yao@intel.com>, Dong Wei <dong.wei@arm.com>
Date: Thu,  9 Mar 2017 23:49:41 +0000
Message-Id: <20170309234942.11956-2-evan.lloyd@arm.com>
X-Mailer: git-send-email 2.8.3
In-Reply-To: <20170309234942.11956-1-evan.lloyd@arm.com>
References: <20170309234942.11956-1-evan.lloyd@arm.com>
Subject: [edk2-staging][PATCH 1/2] ShellPkg: acpiview branch on edk2-staging
X-BeenThere: edk2-devel@lists.01.org
X-Mailman-Version: 2.1.21
Precedence: list
List-Id: EDK II Development  <edk2-devel.lists.01.org>
List-Unsubscribe: <https://lists.01.org/mailman/options/edk2-devel>,
 <mailto:edk2-devel-request@lists.01.org?subject=unsubscribe>
List-Archive: <http://lists.01.org/pipermail/edk2-devel/>
List-Post: <mailto:edk2-devel@lists.01.org>
List-Help: <mailto:edk2-devel-request@lists.01.org?subject=help>
List-Subscribe: <https://lists.01.org/mailman/listinfo/edk2-devel>,
 <mailto:edk2-devel-request@lists.01.org?subject=subscribe>
X-List-Received-Date: Thu, 09 Mar 2017 23:49:54 -0000

From: Evan Lloyd <evan.lloyd@arm.com>

Add a Readme file to initiate a branch for acpiview on edk2-staging.
The branch is intended to allow collaborative updating of acpiview for
platforms beyond the initial ARM implementation.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Evan Lloyd <evan.lloyd@arm.com>
---
 Readme.md | 53 ++++++++++++++++++++
 1 file changed, 53 insertions(+)

diff --git a/Readme.md b/Readme.md
new file mode 100755
index 0000000000000000000000000000000000000000..7a64b941cee1aed7cd51b5db06843535a359c057
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,53 @@
+################################################################################
+# ReadMe.MD for acpiview staging branch..
+#  Contents:
+#    1. Introduction
+#    2. Branch Owner
+#    3. Feature Summary
+#    4. Timeline
+#    5. Related Modules
+#    6. Related Links
+#    7. Misc
+#
+###############################################################################
+
+1. Introduction
+   This acpiview staging branch is requested by Evan Lloyd <evan.lloyd@arm.com>
+   following suggestions from Jiewen Yao <jiewen.yao@intel.com> in response
+   to a patch submitted to the edk2-devel mailing list.
+   The aim is to allow collaborative development of acpiview for all platforms.
+
+2. Branch Owners
+   Evan Lloyd <evan.lloyd@arm.com>
+   Jiewen Yao <iiewen.yao@intel.com>
+
+3. Feature Summary
+   Acpiview allows examination of ACPI table contents from the UEFI Shell.
+   This can help with investigations, especially at that stage where the tables
+   are not enabling an OS to boot.  The program is not exhaustive, and only
+   encapsulates detailed knowledge of a limited number of table types.
+   There is no immediate intent to provide disassembly of AML tables.
+
+   Default behaviour is to display the content of all tables installed.
+   'Known' table types will be parsed and displayed with descriptions and
+   field values.  Where appropriate a degree of consistency checking is
+   done and errors may be reported in the output.
+   Other table types will be displayed as an array of Hexadecimal bytes.
+
+   To facilitate debugging, the -t and -b options can be used to generate a
+   binary file image of a table that can be copied elsewhere for
+   investigation using tools such as those provided by acpica.org.  This is
+   especially relevant for AML type tables like DSDT and SSDT.
+
+4. Timeline
+   N/A
+
+5. Related Modules
+   ShellPkg
+
+6. Related Links
+   N/A
+
+7. Misc
+   N/A
+
-- 
Guid("CE165669-3EF3-493F-B85D-6190EE5B9759")