public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Sami Mujawar <sami.mujawar@arm.com>
To: edk2-devel@lists.01.org
Cc: leif.lindholm@linaro.org, evan.lloyd@arm.com,
	Matteo.Carlini@arm.com, Stephanie.Hughes-Fitt@arm.com,
	nd@arm.com
Subject: [staging/dynamictables PATCH v1 1/5] DynamicTablesPkg: Add module info to file header
Date: Wed, 27 Jun 2018 17:47:42 +0100	[thread overview]
Message-ID: <20180627164746.36188-2-sami.mujawar@arm.com> (raw)
In-Reply-To: <20180627164746.36188-1-sami.mujawar@arm.com>

The ecc tool reports that the Header comment section must
have Abstract information.

Added a brief module description to the file header.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
---
The changes can be seen at https://github.com/samimujawar/edk2-staging/tree/290_fix_ecc_issues_v1

Notes:
    v1:
    - Fix ecc tool reported issues                                  [SAMI]

 DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.inf | 1 +
 DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.inf | 1 +
 DynamicTablesPkg/DynamicTablesPkg.dec                                      | 5 +++--
 DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/AcpiDbg2LibArm.inf        | 1 +
 DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/AcpiFadtLibArm.inf        | 1 +
 DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/AcpiGtdtLibArm.inf        | 1 +
 DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/AcpiIortLibArm.inf        | 1 +
 DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/AcpiMadtLibArm.inf        | 1 +
 DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/AcpiMcfgLibArm.inf        | 1 +
 DynamicTablesPkg/Library/Acpi/Arm/AcpiRawLibArm/AcpiRawLibArm.inf          | 1 +
 DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/AcpiSpcrLibArm.inf        | 1 +
 DynamicTablesPkg/Library/Common/TableHelperLib/TableHelperLib.inf          | 1 +
 12 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.inf b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.inf
index 346168d6b1496eb1808565f830b9c0eae4b06f79..76f16d4c52fe942258627a16aaa884a8ec0fab40 100644
--- a/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.inf
+++ b/DynamicTablesPkg/Drivers/DynamicTableFactoryDxe/DynamicTableFactoryDxe.inf
@@ -1,4 +1,5 @@
 ## @file
+#  Module to manage the list of available table factories.
 #
 #  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
 #
diff --git a/DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.inf b/DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.inf
index d006587a0119a8d5b433e3c651320d1c6e86f0f9..652a8e115177331b8455b6dd527f1735586aa525 100644
--- a/DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.inf
+++ b/DynamicTablesPkg/Drivers/DynamicTableManagerDxe/DynamicTableManagerDxe.inf
@@ -1,4 +1,5 @@
 ## @file
+# Module that drives the table generation and installation process.
 #
 #  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
 #
diff --git a/DynamicTablesPkg/DynamicTablesPkg.dec b/DynamicTablesPkg/DynamicTablesPkg.dec
index 4ac88d12aa47f6a22f2c2b0e2d8dc64e28cff1fd..cdd041ed35c4dc19cef82d69567aa110d92ad30e 100644
--- a/DynamicTablesPkg/DynamicTablesPkg.dec
+++ b/DynamicTablesPkg/DynamicTablesPkg.dec
@@ -1,6 +1,7 @@
-## @file  DynamicTablesPkg.dec
+## @file
+# dec file for Dynamic Tables Framework.
 #
-# Copyright (c) 2017, ARM Limited. All rights reserved.<BR>
+# Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.<BR>
 #
 # This program and the accompanying materials are licensed and made available under
 # the terms and conditions of the BSD License that accompanies this distribution.
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/AcpiDbg2LibArm.inf b/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/AcpiDbg2LibArm.inf
index e81ad7018334075758441b1180a6a2d5e8565db3..4075862204c9a12cfd26002e359e054c36914ef0 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/AcpiDbg2LibArm.inf
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiDbg2LibArm/AcpiDbg2LibArm.inf
@@ -1,4 +1,5 @@
 ## @file
+# DBG2 Table Generator
 #
 #  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
 #
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/AcpiFadtLibArm.inf b/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/AcpiFadtLibArm.inf
index db8b04845434fd7d0cdb5230699b9279914b3900..e772409069caad8563e37be43ec2841f9d22e62d 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/AcpiFadtLibArm.inf
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiFadtLibArm/AcpiFadtLibArm.inf
@@ -1,4 +1,5 @@
 ## @file
+#  FADT Table Generator
 #
 #  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
 #
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/AcpiGtdtLibArm.inf b/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/AcpiGtdtLibArm.inf
index 701cc8b019f564469fc1ec411ed11b367c48ff01..da3db2b1ff882a9e3a71810eff3d76681ec9d208 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/AcpiGtdtLibArm.inf
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiGtdtLibArm/AcpiGtdtLibArm.inf
@@ -1,4 +1,5 @@
 ## @file
+#  GTDT Table Generator
 #
 #  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
 #
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/AcpiIortLibArm.inf b/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/AcpiIortLibArm.inf
index 1d77a3bb58cfa9643b4c1b47b83e1ab4e53d26cb..ce828eb09147d8cc149902c852cc8eaac9b12dc4 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/AcpiIortLibArm.inf
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiIortLibArm/AcpiIortLibArm.inf
@@ -1,4 +1,5 @@
 ## @file
+#  IORT Table Generator
 #
 #  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
 #
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/AcpiMadtLibArm.inf b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/AcpiMadtLibArm.inf
index 03be5a2ab6e8df5029d1c823f51ff01a4293f694..6ba8af4632c25e97b948893c344517ac447ce01a 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/AcpiMadtLibArm.inf
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMadtLibArm/AcpiMadtLibArm.inf
@@ -1,4 +1,5 @@
 ## @file
+#  MADT Table Generator
 #
 #  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
 #
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/AcpiMcfgLibArm.inf b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/AcpiMcfgLibArm.inf
index dfd20dbb86ff1cf9150e8f6a219b2d1008f2116f..e491ad6b24faae24e473f0fd501e06a6f3b456b5 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/AcpiMcfgLibArm.inf
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiMcfgLibArm/AcpiMcfgLibArm.inf
@@ -1,4 +1,5 @@
 ## @file
+#  MCFG Table Generator
 #
 #  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
 #
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiRawLibArm/AcpiRawLibArm.inf b/DynamicTablesPkg/Library/Acpi/Arm/AcpiRawLibArm/AcpiRawLibArm.inf
index cbb53ecef6b5b16405b03bebf28a664259928518..213dbd1cd7b69b3088afb09bdaaf1355c81d8f35 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiRawLibArm/AcpiRawLibArm.inf
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiRawLibArm/AcpiRawLibArm.inf
@@ -1,4 +1,5 @@
 ## @file
+#  Raw Table Generator
 #
 #  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
 #
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/AcpiSpcrLibArm.inf b/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/AcpiSpcrLibArm.inf
index 35c17089986f728a553d73849744e3f904f28b24..8dd94e550b8181dea13d5be81688cc35b8b80eac 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/AcpiSpcrLibArm.inf
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiSpcrLibArm/AcpiSpcrLibArm.inf
@@ -1,4 +1,5 @@
 ## @file
+#  SPCR Table Generator
 #
 #  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
 #
diff --git a/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelperLib.inf b/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelperLib.inf
index 5faadd198f053d3f6281019aff97466932917b8d..2568057a9e5021d9779c769e611a86da163f6d1d 100644
--- a/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelperLib.inf
+++ b/DynamicTablesPkg/Library/Common/TableHelperLib/TableHelperLib.inf
@@ -1,4 +1,5 @@
 ## @file
+#  Table Helper
 #
 #  Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
 #
-- 
'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'




  reply	other threads:[~2018-06-27 16:47 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-06-27 16:47 [staging/dynamictables PATCH v1 0/5] Fix issues reported by ecc tool Sami Mujawar
2018-06-27 16:47 ` Sami Mujawar [this message]
2018-06-27 16:47 ` [staging/dynamictables PATCH v1 2/5] DynamicTablesPkg: Fix function documentation Sami Mujawar
2018-06-27 16:47 ` [staging/dynamictables PATCH v1 3/5] DynamicTablesPkg: Fix variable naming issue Sami Mujawar
2018-06-27 16:47 ` [staging/dynamictables PATCH v1 4/5] DynamicTablesPkg: Fix macro to prevent side effect Sami Mujawar
2018-06-28 16:50   ` Leif Lindholm
2018-06-28 17:10     ` Sami Mujawar
2018-06-29  9:41       ` Leif Lindholm
2018-06-27 16:47 ` [staging/dynamictables PATCH v1 5/5] DynamicTablesPkg: Fix variable declaration Sami Mujawar
2018-06-27 16:57 ` [staging/dynamictables PATCH v1 0/5] Fix issues reported by ecc tool Evan Lloyd
2018-07-02 14:00 ` Leif Lindholm

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-list 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=20180627164746.36188-2-sami.mujawar@arm.com \
    --to=devel@edk2.groups.io \
    /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