From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by spool.mail.gandi.net (Postfix) with ESMTPS id 53AB4D80254 for ; Tue, 8 Aug 2023 05:00:59 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=49SUh2IGfWEQWhKWOqFlFZY7W4OFuWYfCfdpQucsZgI=; c=relaxed/simple; d=groups.io; h=ARC-Seal:ARC-Message-Signature:ARC-Authentication-Results:From:To:CC:Subject:Thread-Topic:Thread-Index:Date:Message-ID:References:In-Reply-To:Accept-Language:MIME-Version:Precedence:List-Subscribe:List-Help:Sender:List-Id:Mailing-List:Delivered-To:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Language:Content-Type:Content-Transfer-Encoding; s=20140610; t=1691470858; v=1; b=AePc+14nwsAWSYkIsZ6E7l7OZvYzNwi7ygAzoxYsrXO2wxd+ZFcvvnbnvsZPa4WogPVxYWjg Fwdm+mvP2sydlkxYgHR6ARQ0FkLV+bdz+EcNBhJVksyVBXhlBV8f62f5QzlsWkV8z5s0hZCKA2I twSQgZ6bKRJyYb5KfH7LxopA= X-Received: by 127.0.0.2 with SMTP id lWYTYY7687511xfw5vrlaWHJ; Mon, 07 Aug 2023 22:00:58 -0700 X-Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.100]) by mx.groups.io with SMTP id smtpd.web11.54929.1691470857095974816 for ; Mon, 07 Aug 2023 22:00:57 -0700 X-IronPort-AV: E=McAfee;i="6600,9927,10795"; a="437048977" X-IronPort-AV: E=Sophos;i="6.01,263,1684825200"; d="scan'208";a="437048977" X-Received: from orsmga006.jf.intel.com ([10.7.209.51]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 07 Aug 2023 22:00:56 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10795"; a="708109608" X-IronPort-AV: E=Sophos;i="6.01,263,1684825200"; d="scan'208";a="708109608" X-Received: from fmsmsx603.amr.corp.intel.com ([10.18.126.83]) by orsmga006.jf.intel.com with ESMTP; 07 Aug 2023 22:00:56 -0700 X-Received: from fmsmsx612.amr.corp.intel.com (10.18.126.92) by fmsmsx603.amr.corp.intel.com (10.18.126.83) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.27; Mon, 7 Aug 2023 22:00:56 -0700 X-Received: from fmsmsx610.amr.corp.intel.com (10.18.126.90) by fmsmsx612.amr.corp.intel.com (10.18.126.92) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.27; Mon, 7 Aug 2023 22:00:55 -0700 X-Received: from fmsedg601.ED.cps.intel.com (10.1.192.135) by fmsmsx610.amr.corp.intel.com (10.18.126.90) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.27 via Frontend Transport; Mon, 7 Aug 2023 22:00:55 -0700 X-Received: from NAM12-BN8-obe.outbound.protection.outlook.com (104.47.55.177) by edgegateway.intel.com (192.55.55.70) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.27; Mon, 7 Aug 2023 22:00:51 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=MK2a88liusF016ATTlMu9mhn32Wo+zePH0ERQRQgAKofTpi5GF0rkWX0T/hyPFx+q+BfU75xdNeKBNiXfJdDleIblDZlFkFmJ3//Qs/ACGs2OKUKwcG7AnCG7d1pBMDarospKnin8m0+ejH781F6rLzPs6Ll3dngAXLauHhgRfeLgd6I/uQb9HcE+pnbDbqLqNeUYNjtAnNLa6b0i6am0kucwUvBfpU6ASN13XOY1161LzUBHVUk+jhjb8CMdvLYoYC9gh+M8sknXPL+NM6Vr03bNNQ6nrIHOE0U7Ge/eCvDfFGSWGyJLstq2uMq6wMg/aBpTHX84NPOlam2DQRq0A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=hJBk2WGsPE3GmM4n8s6KKEn+nfsYWN1y5d3vpU/HkDU=; b=jrCH1Tp5p+STJcHoY6SOvv5CwgUGq7r9f4LyocP5+pga3ZSpPq3XeY+g1cuIzBYh9Iq/nSdDxqy3SI0GGHqbuDinod4MhqvBMbAOXM5abv1BRFLG5vDn4++1uBDpb908Q6NCQsYeEG5Lp/3ey9NE+gN/7HZ/yFjUIdYxIAGndEfQrhBdPzNAukAY8S2cA69OR0CSlUJr5gmNSgaKOmvmxuelNRMvLEU+oQaWc0wUAZJB6sgtu95V1uF4M7nEbkfv6oicKjPCZXJLFOGEghl73hLn7ZwR1ItZmctp1YHvjFKeGSV6lu69eQ+2nlFlDsm7FZa8y9UDDayJZX/MGLV+eA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none X-Received: from PH7PR11MB5943.namprd11.prod.outlook.com (2603:10b6:510:13f::19) by SA1PR11MB6808.namprd11.prod.outlook.com (2603:10b6:806:24f::10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6652.26; Tue, 8 Aug 2023 05:00:50 +0000 X-Received: from PH7PR11MB5943.namprd11.prod.outlook.com ([fe80::4148:3ffb:428d:c14e]) by PH7PR11MB5943.namprd11.prod.outlook.com ([fe80::4148:3ffb:428d:c14e%4]) with mapi id 15.20.6652.020; Tue, 8 Aug 2023 05:00:49 +0000 From: "Jayaprakash, N" To: "R, Vishal" , "devel@edk2.groups.io" CC: Rebecca Cran , "Kinney, Michael D" Subject: Re: [edk2-devel] [edk2-libc Patch 1/1] edk2-libc/AppPkg: Fix documentation issue with edk2module.c Thread-Topic: [edk2-libc Patch 1/1] edk2-libc/AppPkg: Fix documentation issue with edk2module.c Thread-Index: AQHZximgAwsTFESW5Uq+dIq/pdDr1a/fyxOw Date: Tue, 8 Aug 2023 05:00:49 +0000 Message-ID: References: <20230803164223.1584-1-vishal.r@intel.com> <20230803164223.1584-2-vishal.r@intel.com> In-Reply-To: <20230803164223.1584-2-vishal.r@intel.com> Accept-Language: en-IN, en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ms-publictraffictype: Email x-ms-traffictypediagnostic: PH7PR11MB5943:EE_|SA1PR11MB6808:EE_ x-ms-office365-filtering-correlation-id: 28357e1a-97e9-437d-ebb2-08db97cc6f48 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam-message-info: tkxr4fBphK/L5ChCxZaet1zuUw+XBDcsPoCd3WbGgzYwOzgHdIujRJAd6SlwWoaSF8Bxq5UqPppwt9uRYiQ8MPHeQD5htYPNOokUZc5MUxOWNCXYkigzJ0naiwROcv+SFkotXzGXcEwIPF+cPW3g5MQ2hGnj7WQnzr/W7SSJoQ4cxsZTfr8ueXH8wEg0C5N05U1OxhsSk5A+vs28LGuhfItQQ5ZQT3RyhbH10TrCjy6BqADkETRuLSSWzDfhQGNJ9sro95q6AlFnFbUx9ax4EJVLhTTkcKyXeonIKB1hnFiQuIg3CwPz7VqvikySp9c9JvSktMmunV2/E8hhmtpDD+549jFlnTUwQVFQ/5ZU47Az9lrPvIBLiLOYsU7cEnKKvmbbssaEW/EkHepAVj8X4OK8ucpyusNR9c1O+qfuCBcbQ569B9O8lxpN+ANKjfcaeAv7JcynXrzb82YANGWA2lwdlXWLwRZADomaXu1Fxa7za+Mv3Al3E+yR2AixxxPsa32yayfl3bujjYilfr6G3fkZ05Z4LlCbHZFPmiUJJ1LcVO15/Ki0O+NIYtpu/RG9SIf9/VE24XQGoyFV0G0BnwpZJbRH9g2YAD0ssfjFKrtxgmkB76/YAR1ClW2Ob+gYIAu1hME04ynLo7USEH0c5Y1PdR0FvEp1yl/XuJljZKs= x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?7z0jeR0HN00gFhRzsJusXp9zxRWn8EfKCRCZh3uT/72lx8gWtq1l0rsG0keQ?= =?us-ascii?Q?2ZlE2VbnhYgEQKO32a8ZSR7lWrqFYcbLVfrqxqI50O89qzUL9x9LRmnmPAEX?= =?us-ascii?Q?blEPM3spw+cpY+jQl4NUtK3gd2Cil1GqZzHOwLKvl9pAmHLsC6bVDmI6+3e8?= =?us-ascii?Q?KhBpItBlI0+OvACe5gFLCK61nfNOn3jzXfVhrxtbVGx9v1Riryh6z5dwaWt7?= =?us-ascii?Q?iSkl6/X2/CR7ABmcH7S/1/JSwYNi6FL/YCS0Q/LNbAKNLz2PpCzKgaeVuQk0?= =?us-ascii?Q?ImdP66UDnafng35UfLonOE2xfS0o3KvXVACQ/blwM6N4ZJ7NudF2XEXRkM8H?= =?us-ascii?Q?zmo3+5dDHYSGx8Q0fCbx8ZLNnBn8+oyQTWBjTjO2vnk5RjBI7YFxA7qIqC6/?= =?us-ascii?Q?p+XYiOGcaAk1IgV7yOV/wa2eutpER8sUBX9yKpw0RPhyUDMcgwECcIrYs9+F?= =?us-ascii?Q?NdR9oW+UJWypu5k4CaYXw4fYGvEPa+yPwKYI1sD6ANPPqzZCenDLkIf1X0c3?= =?us-ascii?Q?incGiwvLsNL2mAXtUx4LQKBXo+fAOWEq/R0FMgWuvaMtqvy6O5B8mRdpc3vR?= =?us-ascii?Q?iJCrn44Qv9WhJMz0aMoHUEEKbYruvJRmve0WL/BHCh2h6usxUgyPviQjeNEU?= =?us-ascii?Q?BlRxSLpxy6qMfY7sYTKcNfzPj6vY6nkQJ1Gjsz0xvKXxWu77LYGuF+izyZ7q?= =?us-ascii?Q?K70VGLnC1Um4SXRhdwnSuNAjzAqowDGfpLh65GQ/zpZSGbcHQ16uVOTHED4i?= =?us-ascii?Q?TvO9uBm+s9iG4Yxiy+hb0wdBiDYzLyg4iB/QAUvGNJL4BoDfX2XC6KNPgZUU?= =?us-ascii?Q?1vTYvPkJCTdy3SgRll8fqfTcvBCG55yA2Xuqsbfwk27llcFEw+3uNmFpp1fb?= =?us-ascii?Q?15jjG4tyz3jYfQb/tCLXzjsCglQVt1ppzSVJcAXsRGIWmvaDbXCLgtMKsRTW?= =?us-ascii?Q?S1lGgDc6aqBuNLdZxLrsbupLid32B9rDBTrPvfB08boSES/EEvOLvz+Dsdt1?= =?us-ascii?Q?8CLah4tB+kzKgwgLrECR25cN8wmuThE6kP22MMlqFOS6GiTM5YeNAzOGTu4w?= =?us-ascii?Q?FxOsN4Dak2ZAhwh4r25KZtO/Sr6dGpgZZhWygXExFVitIt96yC+YlmHLKl8B?= =?us-ascii?Q?C2um8n/wOwTXS9JxWWb3eSxCLH8p0NHu3WGInwIl2Gdv/wSVJiPKJSJmot9O?= =?us-ascii?Q?VFBtYEMQ7E9dU8EC4JxY2zdrXklE4HwBipzZKeAsP0CgL85SnwR9L9WgWqMt?= =?us-ascii?Q?MuLz41Kl+v5yip55r4kVjHC+DhL8cQDcPjInRmQg0JfCpHu4yZm1K8QivB2R?= =?us-ascii?Q?oFv8WdQHE4PsTg87PZR3Ll4hxL/vZEPm3c0XtpFO+lSecEv6FzzaKoJV71El?= =?us-ascii?Q?ede1woZuiVlxacb6c8QE9EG3UahmieywVJDmxpEKkcQc5u1KOqE1Nz+blXRK?= =?us-ascii?Q?6zgw0GgoKrioXY8FjmZwcP8sCMUKlyvdeBsayEKjRZlMnamj6FuEycmnsRgk?= =?us-ascii?Q?LsiFt5s2b4QF51JtQ/GmPRowAq1QBIk5IFRovJp9qg1ff6VJST4XKo6RtDiB?= =?us-ascii?Q?H0nEeVKOsN4gEWmJtlDooDwZCA3sciD6AzD0uBBZ?= MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: PH7PR11MB5943.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 28357e1a-97e9-437d-ebb2-08db97cc6f48 X-MS-Exchange-CrossTenant-originalarrivaltime: 08 Aug 2023 05:00:49.8755 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: ktg5Wdr0M+gYTfbjRY1f1bw//22lbusNQuk2gyLXvLQFjT7BJuOcErWckwVbL293D7NDTet9djaHpWhU09g63A== X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA1PR11MB6808 X-OriginatorOrg: intel.com Precedence: Bulk List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,n.jayaprakash@intel.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: sMZ4vIRYYgiXHXupW1ATrLwpx7686176AA= Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable X-GND-Status: LEGIT Authentication-Results: spool.mail.gandi.net; dkim=pass header.d=groups.io header.s=20140610 header.b=AePc+14n; spf=pass (spool.mail.gandi.net: domain of bounce@groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce@groups.io; dmarc=fail reason="SPF not aligned (relaxed), DKIM not aligned (relaxed)" header.from=intel.com (policy=none); arc=reject ("signature check failed: fail, {[1] = sig:microsoft.com:reject}") Reviewed-by: Jayaprakash Nevara -----Original Message----- From: R, Vishal =20 Sent: Thursday, August 3, 2023 10:12 PM To: devel@edk2.groups.io Cc: R, Vishal ; Rebecca Cran ; Kinne= y, Michael D ; Jayaprakash, N Subject: [edk2-libc Patch 1/1] edk2-libc/AppPkg: Fix documentation issue wi= th edk2module.c REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3D4517 This commit fixes the API documentation issue reported via the BZ4517 Updat= ed documentation strings for rdmsr() and wrmsr() Cc: Rebecca Cran Cc: Michael D Kinney Cc: Jayaprakash N Signed-off-by: Vishal R --- .../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/ed= k2module.c b/AppPkg/Applications/Python/Python-3.6.8/PyMod-3.6.8/Modules/ed= k2module.c index 9641f86..05b1a5a 100644 --- a/AppPkg/Applications/Python/Python-3.6.8/PyMod-3.6.8/Modules/edk2modul= e.c +++ b/AppPkg/Applications/Python/Python-3.6.8/PyMod-3.6.8/Modules/edk2mo +++ dule.c @@ -3839,8 +3839,16 @@ void WritePCICfg( } =20 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=20 +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\=20 +"); =20 static PyObject * edk2_rdmsr(PyObject *self, PyObject *args) @@ -3857,9 +3865,19 @@ edk2_rdm= sr(PyObject *self, PyObject *args) return Py_BuildValue("(II)", (unsigned long)veax, (unsigned long)vedx); = } =20 -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=20 +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=20 +Value:\n\ + None\n\ +"); =20 static PyObject * edk2_wrmsr(PyObject *self, PyObject *args) -- 2.39.1.windows.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- 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] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-