* [edk2-devel] [edk2-libc Patch 0/1] Fix documentation issue with edk2module.c
@ 2023-08-03 16:42 Vishal R
2023-08-03 16:42 ` [edk2-devel] [edk2-libc Patch 1/1] edk2-libc/AppPkg: " Vishal R
0 siblings, 1 reply; 3+ messages in thread
From: Vishal R @ 2023-08-03 16:42 UTC (permalink / raw)
To: devel; +Cc: Vishal R
This patch contains fix for edk2 module documentation issue
Vishal R (1):
edk2-libc/AppPkg: Fix documentation issue with edk2module.c
.../PyMod-3.6.8/Modules/edk2module.c | 28 +++++++++++++++----
1 file changed, 23 insertions(+), 5 deletions(-)
--
2.39.1.windows.1
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#107577): https://edk2.groups.io/g/devel/message/107577
Mute This Topic: https://groups.io/mt/100551577/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 3+ messages in thread
* [edk2-devel] [edk2-libc Patch 1/1] edk2-libc/AppPkg: Fix documentation issue with edk2module.c
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 ` Vishal R
2023-08-08 5:00 ` Jayaprakash, N
0 siblings, 1 reply; 3+ messages in thread
From: Vishal R @ 2023-08-03 16:42 UTC (permalink / raw)
To: devel; +Cc: Vishal R, Rebecca Cran, Michael D Kinney, Jayaprakash N
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/edk2module.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 (#107578): https://edk2.groups.io/g/devel/message/107578
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]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [edk2-devel] [edk2-libc Patch 1/1] edk2-libc/AppPkg: Fix documentation issue with edk2module.c
2023-08-03 16:42 ` [edk2-devel] [edk2-libc Patch 1/1] edk2-libc/AppPkg: " Vishal R
@ 2023-08-08 5:00 ` Jayaprakash, N
0 siblings, 0 replies; 3+ messages in thread
From: Jayaprakash, N @ 2023-08-08 5:00 UTC (permalink / raw)
To: R, Vishal, devel@edk2.groups.io; +Cc: Rebecca Cran, Kinney, Michael D
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]
-=-=-=-=-=-=-=-=-=-=-=-
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-08-08 5:00 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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 is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox