[edk2] [PATCH v2 05/23] OvmfPkg/Virtio: fix comment style

Brijesh Singh posted 21 patches 7 years, 4 months ago
There is a newer version of this series
[edk2] [PATCH v2 05/23] OvmfPkg/Virtio: fix comment style
Posted by Brijesh Singh 7 years, 4 months ago
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Tom Lendacky <thomas.lendacky@amd.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Brijesh Singh <brijesh.singh@amd.com>
---
 OvmfPkg/Include/Protocol/VirtioDevice.h | 22 +++++++++++++-------
 1 file changed, 14 insertions(+), 8 deletions(-)

diff --git a/OvmfPkg/Include/Protocol/VirtioDevice.h b/OvmfPkg/Include/Protocol/VirtioDevice.h
index 910a4866e7ac..edb20c18822c 100644
--- a/OvmfPkg/Include/Protocol/VirtioDevice.h
+++ b/OvmfPkg/Include/Protocol/VirtioDevice.h
@@ -320,16 +320,22 @@ EFI_STATUS
   );
 
 
-///
-///  This protocol provides an abstraction over the VirtIo transport layer
-///
-///  DISCLAIMER: this protocol is a work in progress, and should not be used
-///  outside of the EDK II tree.
-///
+/**
+
+  This protocol provides an abstraction over the VirtIo transport layer
+
+  DISCLAIMER: this protocol is a work in progress, and should not be used
+  outside of the EDK II tree.
+**/
+
 struct _VIRTIO_DEVICE_PROTOCOL {
-  /// VirtIo Specification Revision encoded with VIRTIO_SPEC_REVISION()
+  //
+  // VirtIo Specification Revision encoded with VIRTIO_SPEC_REVISION()
+  //
   UINT32                      Revision;
-  /// From the Virtio Spec
+  //
+  // From the Virtio Spec
+  //
   INT32                       SubSystemDeviceId;
 
   VIRTIO_GET_DEVICE_FEATURES  GetDeviceFeatures;
-- 
2.7.4

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] [PATCH v2 05/23] OvmfPkg/Virtio: fix comment style
Posted by Laszlo Ersek 7 years, 4 months ago
On 08/14/17 13:36, Brijesh Singh wrote:
> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> Cc: Jordan Justen <jordan.l.justen@intel.com>
> Cc: Tom Lendacky <thomas.lendacky@amd.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Brijesh Singh <brijesh.singh@amd.com>
> ---
>  OvmfPkg/Include/Protocol/VirtioDevice.h | 22 +++++++++++++-------
>  1 file changed, 14 insertions(+), 8 deletions(-)
> 
> diff --git a/OvmfPkg/Include/Protocol/VirtioDevice.h b/OvmfPkg/Include/Protocol/VirtioDevice.h
> index 910a4866e7ac..edb20c18822c 100644
> --- a/OvmfPkg/Include/Protocol/VirtioDevice.h
> +++ b/OvmfPkg/Include/Protocol/VirtioDevice.h
> @@ -320,16 +320,22 @@ EFI_STATUS
>    );
>  
>  
> -///
> -///  This protocol provides an abstraction over the VirtIo transport layer
> -///
> -///  DISCLAIMER: this protocol is a work in progress, and should not be used
> -///  outside of the EDK II tree.
> -///
> +/**
> +
> +  This protocol provides an abstraction over the VirtIo transport layer
> +
> +  DISCLAIMER: this protocol is a work in progress, and should not be used
> +  outside of the EDK II tree.
> +**/
> +
>  struct _VIRTIO_DEVICE_PROTOCOL {
> -  /// VirtIo Specification Revision encoded with VIRTIO_SPEC_REVISION()
> +  //
> +  // VirtIo Specification Revision encoded with VIRTIO_SPEC_REVISION()
> +  //
>    UINT32                      Revision;
> -  /// From the Virtio Spec
> +  //
> +  // From the Virtio Spec
> +  //
>    INT32                       SubSystemDeviceId;
>  
>    VIRTIO_GET_DEVICE_FEATURES  GetDeviceFeatures;
> 

In
<http://mid.mail-archive.com/f953ec03-b160-726b-b9ed-5e3122642815@redhat.com>,
point (18), I meant to identify all the comments that I thought would
benefit from clean-ups. The above patch misses some of those comments,
but reformats comments that (IMO) were fine (e.g. consistent with MdePkg
protocol includes). I've fixed up the patch.

[lersek@redhat.com: clarify subject line]
[lersek@redhat.com: adjust the set of comments updated by the patch]
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Regression-tested-by: Laszlo Ersek <lersek@redhat.com>

Commit a136bc3ccfa479ec8a3fc9afcbd00283339101fa.

Thank you for these miscellaneous fixes (patches 1 through 5)! I'll
strive to continue the review soon.

Thanks
Laszlo
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel