From: "Jayaprakash, N" <n.jayaprakash@intel.com>
To: "R, Vishal" <vishal.r@intel.com>,
"devel@edk2.groups.io" <devel@edk2.groups.io>
Cc: Rebecca Cran <rebecca@bsdio.com>,
"Kinney, Michael D" <michael.d.kinney@intel.com>
Subject: Re: [edk2-devel] [edk2-libc Patch 1/1] edk2-libc/AppPkg: Fix documentation issue with edk2module.c
Date: Tue, 8 Aug 2023 05:00:49 +0000 [thread overview]
Message-ID: <PH7PR11MB59431A9F568013E6520A5AC2EE0DA@PH7PR11MB5943.namprd11.prod.outlook.com> (raw)
In-Reply-To: <20230803164223.1584-2-vishal.r@intel.com>
Reviewed-by: Jayaprakash Nevara <n.jayaprakash@intel.com>
-----Original Message-----
From: R, Vishal <vishal.r@intel.com>
Sent: Thursday, August 3, 2023 10:12 PM
To: devel@edk2.groups.io
Cc: R, Vishal <vishal.r@intel.com>; Rebecca Cran <rebecca@bsdio.com>; Kinney, Michael D <michael.d.kinney@intel.com>; Jayaprakash, N <n.jayaprakash@intel.com>
Subject: [edk2-libc Patch 1/1] edk2-libc/AppPkg: Fix documentation issue with edk2module.c
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4517
This commit fixes the API documentation issue reported via the BZ4517 Updated documentation strings for rdmsr() and wrmsr()
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Jayaprakash N <n.jayaprakash@intel.com>
Signed-off-by: Vishal R <vishal.r@intel.com>
---
.../PyMod-3.6.8/Modules/edk2module.c | 28 +++++++++++++++----
1 file changed, 23 insertions(+), 5 deletions(-)
diff --git a/AppPkg/Applications/Python/Python-3.6.8/PyMod-3.6.8/Modules/edk2module.c b/AppPkg/Applications/Python/Python-3.6.8/PyMod-3.6.8/Modules/edk2module.c
index 9641f86..05b1a5a 100644
--- a/AppPkg/Applications/Python/Python-3.6.8/PyMod-3.6.8/Modules/edk2module.c
+++ b/AppPkg/Applications/Python/Python-3.6.8/PyMod-3.6.8/Modules/edk2mo
+++ dule.c
@@ -3839,8 +3839,16 @@ void WritePCICfg( }
PyDoc_STRVAR(efi_rdmsr__doc__,
-"rdmsr(ecx) -> (eax,edx)\n\
-Read the given MSR.");
+"rdmsr(msr) -> (lower_32bits, higher_32bits)\n\ \n\ Read the given msr
+and return the data as tuple.\n\ \n\ Parameters:\n\
+ msr - The msr in hex or int format\n\ \n\ Return Value:\n\
+ a tuple with lower and higher 32 bit values read from the msr\n\
+");
static PyObject *
edk2_rdmsr(PyObject *self, PyObject *args) @@ -3857,9 +3865,19 @@ edk2_rdmsr(PyObject *self, PyObject *args)
return Py_BuildValue("(II)", (unsigned long)veax, (unsigned long)vedx); }
-PyDoc_STRVAR(efi_wrmsr__doc__,
-"wrmsr(ecx, eax, edx) -> None\n\
-Write edx:eax to the given MSR.");
+PyDoc_STRVAR(efi_wrmsr__doc__,
+"wrmsr(msr, lower_32bits, higher_32bits) -> None\n\ \n\ Writes
+higher_32bits:lower_32bits to the given msr.\n\ \n\ Parameters:\n\
+ msr - The msr in hex or int format\n\
+ lower_32bits - The lower 32 bit data for the msr\n\
+ higher_32bits - The higher 32 bit data for the msr\n\ \n\ Return
+Value:\n\
+ None\n\
+");
static PyObject *
edk2_wrmsr(PyObject *self, PyObject *args)
--
2.39.1.windows.1
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#107633): https://edk2.groups.io/g/devel/message/107633
Mute This Topic: https://groups.io/mt/100551578/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
prev parent reply other threads:[~2023-08-08 5:00 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-03 16:42 [edk2-devel] [edk2-libc Patch 0/1] Fix documentation issue with edk2module.c Vishal R
2023-08-03 16:42 ` [edk2-devel] [edk2-libc Patch 1/1] edk2-libc/AppPkg: " Vishal R
2023-08-08 5:00 ` Jayaprakash, N [this message]
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=PH7PR11MB59431A9F568013E6520A5AC2EE0DA@PH7PR11MB5943.namprd11.prod.outlook.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