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 1C0D4AC0BEB for ; Fri, 1 Dec 2023 06:10:04 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=qt2MSflPiC/FyAii9OweldSkoqyhWcAK9niCAQOn5wM=; 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=1701411003; v=1; b=qpO0zut1zq8x2FbIW/vB9aF+vHul0WYFtY5stDS8M3W8onB9Cn0M7cj3mpxEXkg71LilKFkd 46Vszw8LOmPkZf4yBqYkeWh1Xzu6IjrY2NSrvvZtx7cOe/uqJTOJqOBDehoeaWbVHw88tnC1KLN Bw0sPItog1Ihqm+NZiBtilew= X-Received: by 127.0.0.2 with SMTP id z3ADYY7687511xGF0UIVp3qk; Thu, 30 Nov 2023 22:10:03 -0800 X-Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.8]) by mx.groups.io with SMTP id smtpd.web11.16854.1701411002493479041 for ; Thu, 30 Nov 2023 22:10:02 -0800 X-IronPort-AV: E=McAfee;i="6600,9927,10910"; a="6687751" X-IronPort-AV: E=Sophos;i="6.04,241,1695711600"; d="scan'208";a="6687751" X-Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by fmvoesa102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 30 Nov 2023 22:09:58 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10910"; a="773319547" X-IronPort-AV: E=Sophos;i="6.04,241,1695711600"; d="scan'208";a="773319547" X-Received: from fmsmsx601.amr.corp.intel.com ([10.18.126.81]) by fmsmga007.fm.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 30 Nov 2023 22:09:57 -0800 X-Received: from fmsmsx612.amr.corp.intel.com (10.18.126.92) by fmsmsx601.amr.corp.intel.com (10.18.126.81) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.34; Thu, 30 Nov 2023 22:09:57 -0800 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.34; Thu, 30 Nov 2023 22:09:57 -0800 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.34 via Frontend Transport; Thu, 30 Nov 2023 22:09:57 -0800 X-Received: from NAM12-DM6-obe.outbound.protection.outlook.com (104.47.59.168) 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.34; Thu, 30 Nov 2023 22:09:57 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=NbOmM6cWpUNfwhuyrxWn+i+CEV5cQQmzwbuk+1jICfQA9yzhNeN80MfO3lZy0XrNs0lwA2DhJLm6+6lBorqiV2pbrojVBRtOvpTgenOYonHPsqJI/Ml+dMNM/WC3KIMROkPow3WdCZL5HcV2jox6fCZxf1ki4uYIA+4Ux8hvc+ZuaaAB7lAgEnnPbHizMfUOlQPwiIkV8ybCnI5nVfuFrp3YdDMwXRBRyw8nZboqlkxrV/NCZCgY2Yk1Ou8OkOnbtKgX4/miuo9JKKBqIwg4igiTzknXaZ00ws0zBcZlK6SY7tWTY80al/vhKeop5ZFnptVJdEOEGJI7TCb70ycw2g== 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=GkXeKYb0QwcFyDaxHtO9IOKWO3h8Ej4ptnM7zWNwKBM=; b=hxMWMo9J35/Gh8iSdL0TF/FbEmiG/A0DTXX9e2QPjpi9X8bjojTc/7huVRukBx4uXPji8O3cHtjOxxrJ1pGHXxm2fjapr18q04Z22u2FSjVDV+dbeCk4TRee5FGTgY+oKK5CLuTzoYXcd2cVbzW6x/C+xwXgi+R7TZzt7Bmc4YE6prfB++w5YHGwJQJ0X9bK565shxjHVdvACPWf346ZnaAlOE+HwH7mnHP3htpWcuWF/tN6eMdgNez+myzJdBCm/hxTNA+/jQxS8K8OfZ9t9k+dyOLbKRWPAqDxZ3BB7GkPEN5ObEaurNz3vXCRIvGEBMZwOQg/XlNMVc4JmifhCw== 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 DM4PR11MB5280.namprd11.prod.outlook.com (2603:10b6:5:38b::18) by PH7PR11MB8478.namprd11.prod.outlook.com (2603:10b6:510:308::11) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7046.24; Fri, 1 Dec 2023 06:09:50 +0000 X-Received: from DM4PR11MB5280.namprd11.prod.outlook.com ([fe80::611a:44ea:244a:3885]) by DM4PR11MB5280.namprd11.prod.outlook.com ([fe80::611a:44ea:244a:3885%5]) with mapi id 15.20.7046.027; Fri, 1 Dec 2023 06:09:49 +0000 From: "Ashraf Ali S" To: "Desimone, Nathaniel L" , "devel@edk2.groups.io" CC: "Ni, Ray" , "Chiu, Chasel" , "Duggapu, Chinni B" , "Ng, Ray Han Lim" , "Zeng, Star" , "Kuo, Ted" , "Mohapatra, Susovan" Subject: Re: [edk2-devel] [PATCH] IntelFsp2Pkg/PatchFv: Fix syntax issue in markdown manual Thread-Topic: [PATCH] IntelFsp2Pkg/PatchFv: Fix syntax issue in markdown manual Thread-Index: AQHaI/mjQOMJt3I4WUiVJuR8GiegdrCT8fkg Date: Fri, 1 Dec 2023 06:09:49 +0000 Message-ID: References: <20231201015618.3920-1-nathaniel.l.desimone@intel.com> In-Reply-To: <20231201015618.3920-1-nathaniel.l.desimone@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ms-publictraffictype: Email x-ms-traffictypediagnostic: DM4PR11MB5280:EE_|PH7PR11MB8478:EE_ x-ms-office365-filtering-correlation-id: 6f827a15-982f-4885-9049-08dbf234206d x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam-message-info: sShfFIQHZxpr76w+vfPU39knSkhd7ullBfYHh3FAiQN6JPsHEpQWDpuOR35fKdpFTUXGYs1phz6YyzSJkQhEj5JlQA9A6VHwsxlflNwJ2gvyIyw4QybsKz9xfUVApmEX0Qow+G5oNi7mCTra6gYL0Kcjofzv0lfenMboaNUSpSSVBPXVT3qVk1uCEnRWCJkyBcvoc0gvBOH6OD5oVEGGKVgEDuKeGtXAj7p3Y0yquS61UNi95hZ+yX6BY5FO+gfyRPZP5XcscuQomWbTuuV1eRCMJ4HMIQjLmRfeweVnAhEbwI3hW2ejRi0Fx7BfE2ENxiJHkfpqg63/Iq15n273lUd7kwUpw6UnhXYZ0hUwCuyHIvd1wHSK5SlT+jAkYnWYriQFlwtQ13mOnCHAQK56i4txDbreMnzGs5hxGya2WsSDkDwh9ysXhyyQmiG1V6d/RdxgnkukPJTBwo/SGoKrVJYgm2KpQgpM5MQRT6eZ4+wuOYLB30O9Jk4n3GuADb4z1wBiE4dE+nVbIELQAj5PSWoQMAghCIPNmpcyR00/kvdH+Itcd4mLq+SALgxjIKnfOzyHBDLHWoR3w8B8KsyCD6u96kURWHO3rCvhTk28m+G24nWKFoXYluJg86+PyEar4fGxMPpTdZUOhQlv+dhyFA== x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?UNhS04btF1ll2vBoC/uDtuUcsKXB1dHuVvqTA/Ej+ZsvF/WnpE2+JJTOjO73?= =?us-ascii?Q?iihSAZFi4XgmYk3VKFyKiyEA8JwipSuYnePEbMYMUwLwaJwp4HDuaHFGQEam?= =?us-ascii?Q?zroaymQLjfkMCrpKIGcfvEanXGjkSX0Qy/PsFerqPAivQd8WGtPDPtRR15yY?= =?us-ascii?Q?kaR3jqa2ZRoIHjKqIfUGbz8rdoIlBDdm5kjAW9+umjoaFZokZ/8+eBVw5fld?= =?us-ascii?Q?w6Nay9U4A44Un7YXkLnebDL1chgxS3/5OIQgLQltNmakCn0Z79E/1s50eZO0?= =?us-ascii?Q?oeg/dqlwWBIsVTmhN+F/wa45P0jFEsOpGBP1Wtyus1L+CFIK4qAJGJ991wym?= =?us-ascii?Q?0a6gz+X4lSiLpSdBvUvudoQGohyAROnROnmHW035rNRWai1zfzkcLzSTIX+Q?= =?us-ascii?Q?+l2XMFJFjJ57i+s2C7bKk/dPtKIOasIeBqdb5c+448TFWbpUtkCTlgxrNMkc?= =?us-ascii?Q?NrrmXsWiJaugl/gcxqnK9L4nUhW4/SQ1DWZNsC5NEumbbw81pu8gcashPtUZ?= =?us-ascii?Q?yTTv+mhN80o0FxYAwV2xg8/8+dlxtxEiUGkP4Snv113qhUOVbyyd9hhNDgoe?= =?us-ascii?Q?COD0POn9Pyao28OW5m+stEVzuFM8mITeHyY5bfI8hJOsRXuIJ2v7ejVykAqS?= =?us-ascii?Q?kZ8UIMJkuWGpslCiSQ4GQfrWkilNZwJvyYSAFL9XrVD9rfu4vwzdAwDVYazS?= =?us-ascii?Q?zMIynBLphjYaXb5awPNGR8ELqvbN6BXN6Cogoz+lbclC4I7MxiKIcKSJ6+hI?= =?us-ascii?Q?8lxxMHnWsPZmpPTufNFyCdcxlHEVAQ3Dp+LwtzS6+29juQv4hK0WO+baLNPd?= =?us-ascii?Q?9IGtLDV5jYftl6LFxjiSI1KcARiNpu7wOfYxS2O3+Xu2C/ylbrCDkA+ILELj?= =?us-ascii?Q?SRPpQDTwqbAV1XwAZHMneCWOWuBYhED/uCUcTAuSnfqP3cB/S0I0E7QBZEpM?= =?us-ascii?Q?IcGG2DFHK7OCl+D0x67oa4CX9thDPAMnkqgCWomCPkRypWb5Nezz9S6fgrHq?= =?us-ascii?Q?+iSpoPS44aaS3rSiJumettA+7HnpFKzbDZK1RGwwC5LEkedk91ArQXQh7k9l?= =?us-ascii?Q?ELTb/Iir2BVZocq2EqRw3RsjZCtNWP1suXUAnSu318NJ57f38hxUY29BkN5R?= =?us-ascii?Q?rMCEpCRg6JdnjQr21DBEanNnXDppb69UOBHpd9iIN8mingElJBDh0Ut4hO40?= =?us-ascii?Q?vpzTdKo4SE1aI3u2T5AhA3CaBKw6phLryBZqMDkihbAVwFeEuwd3JuJN39P8?= =?us-ascii?Q?gRuok4UXQb6EnNwzC0CZz3D1UnmZ04qA1AKVg4uBUs5Rvl9Cn/6RqMi3Gu/K?= =?us-ascii?Q?FAgELGqVFPiJWAXwRMQVxiguB9Nt32cGO0+42eLKonn8bzhsuVWz24cVLyo0?= =?us-ascii?Q?XoKyQpAoPAXrXoYZL0iOFwGqcg0ex/Dw/tkJUtkdc7iHGV66jJV/v/mplJvt?= =?us-ascii?Q?POPfwRDADydfGSKKkuzfDhOd0oWI3BfecBLboruBSnTlgnjgexjhjp0TXb8s?= =?us-ascii?Q?4neFp187nORKR3nPGBpW7OblXGTfUVo/s0XYosvHtmcjXgDcJZlh5/5dyRmO?= =?us-ascii?Q?1aguJW//EKVndpXN72+tZppSp0dYWEDjo6GrFQoU?= MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: DM4PR11MB5280.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 6f827a15-982f-4885-9049-08dbf234206d X-MS-Exchange-CrossTenant-originalarrivaltime: 01 Dec 2023 06:09:49.8826 (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: kCck7bmpOsKkI6EZXLeZ/6ZtIO3jPjStMwr4pLIf5MgI6PbY7EakR1TdM5EH5JMfxwb/sBauSqYMAD7qKsqenw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR11MB8478 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,ashraf.ali.s@intel.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: r2gSZZ19LOfnhdr3LHTllOxsx7686176AA= 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=qpO0zut1; arc=reject ("signature check failed: fail, {[1] = sig:microsoft.com:reject}"); dmarc=fail reason="SPF not aligned (relaxed), DKIM not aligned (relaxed)" header.from=intel.com (policy=none); spf=pass (spool.mail.gandi.net: domain of bounce@groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce@groups.io Reviewed-by: S, Ashraf Ali Thanks., S, Ashraf Ali -----Original Message----- From: Desimone, Nathaniel L =20 Sent: Friday, December 1, 2023 7:26 AM To: devel@edk2.groups.io Cc: Ni, Ray ; Chiu, Chasel ; Dugga= pu, Chinni B ; Ng, Ray Han Lim ; Zeng, Star ; Kuo, Ted ;= S, Ashraf Ali ; Mohapatra, Susovan Subject: [PATCH] IntelFsp2Pkg/PatchFv: Fix syntax issue in markdown manual From: Ray Ni According to the markdown language syntax, headings should be after number = signs (#). The number of number signs correspond to the heading level. But current PatchFvUserManual.md doesn't insert a space between the number = signs and the heading title, resulting the markdown file is not rendered we= ll in markdown viewers. The patch doesn't change any content but only adds spaces to ensure the hea= dings are correctly recognized. Signed-off-by: Ray Ni Cc: Chasel Chiu Reviewed-by: Nate DeSimone Cc: Duggapu Chinni B Cc: Ray Han Lim Ng Cc: Star Zeng Cc: Ted Kuo Reviewed-by: Ashraf Ali S Cc: Susovan Mohapatra --- .../Tools/UserManuals/PatchFvUserManual.md | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/IntelFsp2Pkg/Tools/UserManuals/PatchFvUserManual.md b/IntelFsp= 2Pkg/Tools/UserManuals/PatchFvUserManual.md index f28eedf625..205ad57773 100644 --- a/IntelFsp2Pkg/Tools/UserManuals/PatchFvUserManual.md +++ b/IntelFsp2Pkg/Tools/UserManuals/PatchFvUserManual.md @@ -1,9 +1,9 @@ -#Name +# Name **_PatchFv.py_** - The python script that patches the firmware volumes (**= FV**) with in the flash device (**FD**) file post FSP build. From version 0.60, script is capable of patching flash device (**FD**) dir= ectly. =20 -#Synopsis +# Synopsis =20 ``` PatchFv FvBuildDir [FvFileBaseNames:]FdFileBaseNameToPatch ["Offset, Value= "]+ @@ -18,32 +18,32 @@ PatchFv FdFileDir FdFileName ["Offset, Value"]+ | ["Offset, Value, $Command, @Comment"]+ ``` =20 -#Description +# Description The **_PatchFv.py_** tool allows the developer to fix up FD images to foll= ow the Intel FSP Architecture specification. It also makes the FD image r= elocatable. The tool is written in Python and uses Python 2.7 or later to run. Consider using the tool in a build script. =20 -#FvBuildDir (Argument 1) +# FvBuildDir (Argument 1) This is the first argument that **_PatchFv.py_** requires. It is the buil= d directory for all firmware volumes created during the FSP build. The pat= h must be either an absolute path or a relevant path, relevant to the top = level of the FSP tree. =20 -####Example usage: +#### Example usage: ``` Build\YouPlatformFspPkg\%BD_TARGET%_%VS_VERSION%%VS_X86%\FV ``` =20 The example used contains Windows batch script %VARIABLES%. =20 -#FvFileBaseNames (Argument 2: Optional Part 1) +# FvFileBaseNames (Argument 2: Optional Part 1) The firmware volume file base names (**_FvFileBaseNames_**) are the indepe= ndent -Fv?s that are to be patched within the FD. (0 or more in the form -**FVFILEBASENAME:**) The colon **:** is used for delimiting the single +FVs that are to be patched within the FD. (0 or more in the form +**FvFileBaseNames:**) The colon **:** is used for delimiting the single argument and must be appended to the end of each (**_FvFileBaseNames_**). =20 -####Example usage: +#### Example usage: ``` STAGE1:STAGE2:MANIFEST:YOURPLATFORM ``` @@ -55,14 +55,14 @@ In the example **STAGE1** is **STAGE1.Fv** in **YOURPLA= TFORM.fd**. Firmware device file name to patch (**_FdFileNameToPatch_**) is the base n= ame of the FD file that is to be patched. (1 only, in the form **YOURPLATF= ORM**) =20 -####Example usage: +#### Example usage: ``` STAGE1:STAGE2:MANIFEST:YOURPLATFORM ``` =20 In the example **YOURPLATFORM** is from **_YOURPLATFORM.fd_** =20 -#"Offset, Value[, Command][, Comment]" (Argument 3) +# "Offset, Value[, Command][, Comment]" (Argument 3) The **_Offset_** can be a positive or negative number and represents where= the **_Value_** to be patched is located within the FD. The **_Value_** is wha= t will be written at the given **_Offset_** in the FD. Constants may be us= ed for @@ -79,10 +79,10 @@ The entire argument includes the quote marks lik= e in the example argument below: 0xFFFFFFC0, SomeCore:__EntryPoint - [0x000000F0],@SomeCore Entry ``` =20 -###Constants: +### Constants: Hexadecimal (use **0x** as prefix) | Decimal =20 -####Examples: +#### Examples: =20 | **Positive Hex** | **Negative Hex** | **Positive Decimal** | **Negative = Decimal** | | ---------------: | ---------------: | -------------------: |= -------------------: | @@ -93,7 +93,7 @@ ModuleName:FunctionName | ModuleN= ame:GlobalVariableName ModuleGuid:Offset ``` =20 -###Operators: +### Operators: =20 ``` =20 @@ -113,7 +113,7 @@ From version 0.60 tool allows to pass flash device file= path as Argument 1 and flash device name as Argument 2 and rules for pass= ing offset & value are same as explained in the previous sections. =20 -####Example usage: +#### Example usage: Argument 1 ``` YouPlatformFspBinPkg\ @@ -123,21 +123,21 @@ Argument 2 Fsp_Rebased_T ``` =20 -###Special Commands: +### Special Commands: Special commands must use the **$** symbol as a prefix to the command itse= lf. There is only one command available at this time. =20 ``` -$COPY ? Copy a binary block from source to destination. +$COPY Copy a binary block from source to destination. ``` =20 -####Example: +#### Example: =20 ``` 0x94, [PlatformInit:__gPcd_BinPatch_FvRecOffset] + 0x94, [0x98], $COPY, @S= ync up 2nd FSP Header ``` =20 -###Comments: +### Comments: Comments are allowed in the **Offset, Value [, Comment]** argument. Commen= ts must use the **@** symbol as a prefix. The comment will output to the b= uild window upon successful completion of patching along with the offset a= nd value data. -- 2.39.1.windows.1 GitPatchExtractor 1.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 (#111970): https://edk2.groups.io/g/devel/message/111970 Mute This Topic: https://groups.io/mt/102907649/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-