From: Jiaxin Wu <Jiaxin.wu@intel.com>
To: edk2-devel@lists.01.org
Cc: Fu Siyuan <siyuan.fu@intel.com>, Ye Ting <ting.ye@intel.com>,
Bi Dandan <dandan.bi@intel.com>, Wu Jiaxin <jiaxin.wu@intel.com>
Subject: [Patch 1/2] NetworkPkg/UefiPxeBcDxe: Correct comments to align with the input parameter.
Date: Mon, 8 Oct 2018 11:03:24 +0800 [thread overview]
Message-ID: <20181008030325.4188-2-Jiaxin.wu@intel.com> (raw)
In-Reply-To: <20181008030325.4188-1-Jiaxin.wu@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=1230
Cc: Fu Siyuan <siyuan.fu@intel.com>
Cc: Ye Ting <ting.ye@intel.com>
Cc: Bi Dandan <dandan.bi@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Wu Jiaxin <jiaxin.wu@intel.com>
---
NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c | 11 ++++++++++-
NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h | 5 ++++-
2 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c
index 9725fb40dd..61d2d59675 100644
--- a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c
+++ b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c
@@ -1,9 +1,9 @@
/** @file
Functions implementation related with Mtftp for UefiPxeBc Driver.
- Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
@@ -107,10 +107,11 @@ PxeBcMtftp6CheckPacket (
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in, out] BufferSize Pointer to buffer size.
@retval EFI_SUCCESS Sucessfully obtained the size of file.
@retval EFI_NOT_FOUND Parse the tftp ptions failed.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@@ -246,10 +247,11 @@ ON_ERROR:
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether with a receive buffer.
@retval EFI_SUCCESS Successfully read the data from the special file.
@@ -414,10 +416,11 @@ PxeBcMtftp6WriteFile (
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer.
@retval EFI_SUCCESS Successfully obtained the data from the file included in directory.
@@ -584,10 +587,11 @@ PxeBcMtftp4CheckPacket (
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in, out] BufferSize Pointer to buffer size.
@retval EFI_SUCCESS Successfully obtained the size of file.
@retval EFI_NOT_FOUND Parse the tftp options failed.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@@ -723,10 +727,11 @@ ON_ERROR:
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer.
@retval EFI_SUCCESS Successfully read the data from the special file.
@@ -890,10 +895,11 @@ PxeBcMtftp4WriteFile (
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer.
@retval EFI_SUCCES Successfully obtained the data from the file included in the directory.
@@ -982,10 +988,11 @@ PxeBcMtftp4ReadDirectory (
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to configure data.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in, out] BufferSize Pointer to buffer size.
@retval EFI_SUCCESS Successfully obtained the size of file.
@retval EFI_NOT_FOUND Parse the tftp options failed.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@@ -1029,10 +1036,11 @@ PxeBcTftpGetFileSize (
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to config data.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer.
@retval EFI_SUCCESS Sucessfully read the data from the special file.
@@ -1134,10 +1142,11 @@ PxeBcTftpWriteFile (
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to config data.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicatse whether to use a receive buffer.
@retval EFI_SUCCES Successfully obtained the data from the file included in the directory.
diff --git a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h
index edd8decbd8..30d5cfe343 100644
--- a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h
+++ b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h
@@ -1,9 +1,9 @@
/** @file
Functions declaration related with Mtftp for UefiPxeBc Driver.
- Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
@@ -33,10 +33,11 @@
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to configure data.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in, out] BufferSize Pointer to buffer size.
@retval EFI_SUCCESS Successfully obtained the size of file.
@retval EFI_NOT_FOUND Parse the tftp ptions failed.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@@ -59,10 +60,11 @@ PxeBcTftpGetFileSize (
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to config data.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer.
@retval EFI_SUCCESS Successfully read the data from the special file.
@@ -116,10 +118,11 @@ PxeBcTftpWriteFile (
@param[in] Private Pointer to PxeBc private data.
@param[in] Config Pointer to config data.
@param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size.
+ @param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether with a receive buffer.
@retval EFI_SUCCES Successfully obtained the data from the file included in directory.
--
2.17.1.windows.2
next prev parent reply other threads:[~2018-10-08 3:03 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-08 3:03 [Patch 0/2] Correct comments to align with the input parameter Jiaxin Wu
2018-10-08 3:03 ` Jiaxin Wu [this message]
2018-10-08 3:03 ` [Patch 2/2] ShellPkg/TftpDynamicCommand: " Jiaxin Wu
2018-10-08 14:47 ` Carsey, Jaben
2018-10-08 3:11 ` [Patch 0/2] " Fu, Siyuan
2018-10-08 6:07 ` Bi, Dandan
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=20181008030325.4188-2-Jiaxin.wu@intel.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