Revision: 14361
          http://edk2.svn.sourceforge.net/edk2/?rev=14361&view=rev
Author:   jljusten
Date:     2013-05-15 06:22:50 +0000 (Wed, 15 May 2013)
Log Message:
-----------
OvmfPkg: adapt VirtioAppendDesc()'s leading comment to the coding style

Contributed-under: TianoCore Contribution Agreement 1.0

Signed-off-by: Laszlo Ersek <[email protected]>

Modified Paths:
--------------
    trunk/edk2/OvmfPkg/Include/Library/VirtioLib.h
    trunk/edk2/OvmfPkg/Library/VirtioLib/VirtioLib.c

Modified: trunk/edk2/OvmfPkg/Include/Library/VirtioLib.h
===================================================================
--- trunk/edk2/OvmfPkg/Include/Library/VirtioLib.h      2013-05-15 06:22:15 UTC 
(rev 14360)
+++ trunk/edk2/OvmfPkg/Include/Library/VirtioLib.h      2013-05-15 06:22:50 UTC 
(rev 14361)
@@ -180,28 +180,27 @@
   The caller is responsible for initializing *Indices with VirtioPrepare()
   first.
 
-  @param[in out] Ring           The virtio ring to append the buffer to, as a
-                                descriptor.
+  @param[in,out] Ring        The virtio ring to append the buffer to, as a
+                             descriptor.
 
-  @param [in] BufferPhysAddr    (Guest pseudo-physical) start address of the
-                                transmit / receive buffer.
+  @param[in] BufferPhysAddr  (Guest pseudo-physical) start address of the
+                             transmit / receive buffer.
 
-  @param [in] BufferSize        Number of bytes to transmit or receive.
+  @param[in] BufferSize      Number of bytes to transmit or receive.
 
-  @param [in] Flags             A bitmask of VRING_DESC_F_* flags. The caller
-                                computes this mask dependent on further buffers
-                                to append and transfer direction.
-                                VRING_DESC_F_INDIRECT is unsupported. The
-                                VRING_DESC.Next field is always set, but the
-                                host only interprets it dependent on
-                                VRING_DESC_F_NEXT.
+  @param[in] Flags           A bitmask of VRING_DESC_F_* flags. The caller
+                             computes this mask dependent on further buffers to
+                             append and transfer direction.
+                             VRING_DESC_F_INDIRECT is unsupported. The
+                             VRING_DESC.Next field is always set, but the host
+                             only interprets it dependent on VRING_DESC_F_NEXT.
 
-  In *Indices:
+  @param[in,out] Indices     Indices->HeadDescIdx is not accessed.
+                             On input, Indices->NextDescIdx identifies the next
+                             descriptor to carry the buffer. On output,
+                             Indices->NextDescIdx is incremented by one, modulo
+                             2^16.
 
-  @param [in out] NextDescIdx  On input, the index identifying the next
-                               descriptor to carry the buffer. On output,
-                               incremented by one, modulo 2^16.
-
 **/
 VOID
 EFIAPI

Modified: trunk/edk2/OvmfPkg/Library/VirtioLib/VirtioLib.c
===================================================================
--- trunk/edk2/OvmfPkg/Library/VirtioLib/VirtioLib.c    2013-05-15 06:22:15 UTC 
(rev 14360)
+++ trunk/edk2/OvmfPkg/Library/VirtioLib/VirtioLib.c    2013-05-15 06:22:50 UTC 
(rev 14361)
@@ -329,28 +329,27 @@
   The caller is responsible for initializing *Indices with VirtioPrepare()
   first.
 
-  @param[in out] Ring           The virtio ring to append the buffer to, as a
-                                descriptor.
+  @param[in,out] Ring        The virtio ring to append the buffer to, as a
+                             descriptor.
 
-  @param [in] BufferPhysAddr    (Guest pseudo-physical) start address of the
-                                transmit / receive buffer.
+  @param[in] BufferPhysAddr  (Guest pseudo-physical) start address of the
+                             transmit / receive buffer.
 
-  @param [in] BufferSize        Number of bytes to transmit or receive.
+  @param[in] BufferSize      Number of bytes to transmit or receive.
 
-  @param [in] Flags             A bitmask of VRING_DESC_F_* flags. The caller
-                                computes this mask dependent on further buffers
-                                to append and transfer direction.
-                                VRING_DESC_F_INDIRECT is unsupported. The
-                                VRING_DESC.Next field is always set, but the
-                                host only interprets it dependent on
-                                VRING_DESC_F_NEXT.
+  @param[in] Flags           A bitmask of VRING_DESC_F_* flags. The caller
+                             computes this mask dependent on further buffers to
+                             append and transfer direction.
+                             VRING_DESC_F_INDIRECT is unsupported. The
+                             VRING_DESC.Next field is always set, but the host
+                             only interprets it dependent on VRING_DESC_F_NEXT.
 
-  In *Indices:
+  @param[in,out] Indices     Indices->HeadDescIdx is not accessed.
+                             On input, Indices->NextDescIdx identifies the next
+                             descriptor to carry the buffer. On output,
+                             Indices->NextDescIdx is incremented by one, modulo
+                             2^16.
 
-  @param [in out] NextDescIdx  On input, the index identifying the next
-                               descriptor to carry the buffer. On output,
-                               incremented by one, modulo 2^16.
-
 **/
 VOID
 EFIAPI

This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.


------------------------------------------------------------------------------
AlienVault Unified Security Management (USM) platform delivers complete
security visibility with the essential security capabilities. Easily and
efficiently configure, manage, and operate all of your security controls
from a single console and one unified framework. Download a free trial.
http://p.sf.net/sfu/alienvault_d2d
_______________________________________________
edk2-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/edk2-commits

Reply via email to