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 A360FAC1A7A for ; Fri, 3 Nov 2023 20:46:09 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=3Nxa16EG+Fd3jayjX89DzkZjlaZdei2cwDQFPRWxv2U=; 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=1699044368; v=1; b=kvOEZa8lIjMJpopea30LGOyCA9Aiy3XShI8TYvz4xCpLnCJl944+m5yLuTc7n+o+tCMqmYC5 WxGDsZaUPCd5jgwHtwATHSVYEVSmhqlOTUCn6FzLL+CbfGMPfjGwuNuySTT/kY3MDhHRrDTfopZ QJTOoAuHV41vCofy3cCxKrFU= X-Received: by 127.0.0.2 with SMTP id FR1NYY7687511xDPSFbKulbG; Fri, 03 Nov 2023 13:46:08 -0700 X-Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.7]) by mx.groups.io with SMTP id smtpd.web11.64315.1699044367781141181 for ; Fri, 03 Nov 2023 13:46:07 -0700 X-IronPort-AV: E=McAfee;i="6600,9927,10883"; a="10551519" X-IronPort-AV: E=Sophos;i="6.03,275,1694761200"; d="scan'208";a="10551519" X-Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmvoesa101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Nov 2023 13:46:07 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10883"; a="878764100" X-IronPort-AV: E=Sophos;i="6.03,275,1694761200"; d="scan'208";a="878764100" X-Received: from orsmsx603.amr.corp.intel.com ([10.22.229.16]) by fmsmga002.fm.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 03 Nov 2023 13:46:03 -0700 X-Received: from orsmsx612.amr.corp.intel.com (10.22.229.25) by ORSMSX603.amr.corp.intel.com (10.22.229.16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.34; Fri, 3 Nov 2023 13:46:02 -0700 X-Received: from orsmsx601.amr.corp.intel.com (10.22.229.14) by ORSMSX612.amr.corp.intel.com (10.22.229.25) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.34; Fri, 3 Nov 2023 13:46:01 -0700 X-Received: from ORSEDG602.ED.cps.intel.com (10.7.248.7) by orsmsx601.amr.corp.intel.com (10.22.229.14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.34 via Frontend Transport; Fri, 3 Nov 2023 13:46:01 -0700 X-Received: from NAM12-BN8-obe.outbound.protection.outlook.com (104.47.55.168) by edgegateway.intel.com (134.134.137.103) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.34; Fri, 3 Nov 2023 13:45:58 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=jnPdYmwHtb7Vsj2lzpaw4yZaAuA5yrPYDVvelt/aEnkOg19zFwcUlR0XImyMeILIgCJClPpadTqIcjBXTmg0w5QtnA4d+A83gmaNdf5ytiAz74tAkm3xoyBvYxXtRriHOhALBKE/pMdIWLUInxE+jCzlnssVU/Pl8eDjxTbE5Pb93kee20dsgrOaeMUGMBqpxo4oRX2R1p0l8mRNM57UTbBQPw0q2KnAf2wcwu3uvUar5fafok7QElPTbdxWTCBgJLhBd/SClGUFMYvSfgH1DTIVmvNoYsNxurYCriO4OwxlLMwZDuA+2aIdYKUCV38tfGso064W4GTfyRwJcEaaaA== 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=8/tr62MXH+ftDOygPC5C1pxOiXofQJSgf8kjl2cJXiY=; b=WqlVUL0rJCazs0MdED276UAvyPaT2v4DdyPyTq+57MNJ4iaUGoIgs9vID45U092YFcPZjhx6gWlmngRbKQ/4+mesnX5/HPgJH0b6x05OSpEkOYZRMlKuLdhm2nJlocb8IxL0NH3ZUm9gBRdWstGduGIp4MFdfhefSL+J6ZTPJwNJSP77FTPzYb7c5S26H08aqPy1V8EqnHrsFpGMb7/GzM5nc+sGkRgq+5UGpuMRsxQjKa5iUCFetR+HCv9Ajb1CqKdiQY56TYVsyzmNdykM+sFeRPCbcfxAEKjCK1MOGclYSrVcS3VXNd0YU8NLrTsDF0UqGvt+8dMh5eIDDZteng== 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 MW4PR11MB5821.namprd11.prod.outlook.com (2603:10b6:303:184::5) by CH3PR11MB8465.namprd11.prod.outlook.com (2603:10b6:610:1bc::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6954.24; Fri, 3 Nov 2023 20:45:56 +0000 X-Received: from MW4PR11MB5821.namprd11.prod.outlook.com ([fe80::c90f:1f62:c3fa:3ac8]) by MW4PR11MB5821.namprd11.prod.outlook.com ([fe80::c90f:1f62:c3fa:3ac8%6]) with mapi id 15.20.6954.019; Fri, 3 Nov 2023 20:45:56 +0000 From: "Nate DeSimone" To: "Ni, Ray" , "devel@edk2.groups.io" CC: "Chiu, Chasel" , "Duggapu, Chinni B" , "Ng, Ray Han Lim" , "Zeng, Star" , "Kuo, Ted" , "S, Ashraf Ali" , "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: AQHaDKYnpcc79F3vGEOUxwqQi3cQi7BpFBzA Date: Fri, 3 Nov 2023 20:45:56 +0000 Message-ID: References: <20231101093026.296-1-ray.ni@intel.com> In-Reply-To: <20231101093026.296-1-ray.ni@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ms-publictraffictype: Email x-ms-traffictypediagnostic: MW4PR11MB5821:EE_|CH3PR11MB8465:EE_ x-ms-office365-filtering-correlation-id: 8d4e3aca-a890-48f5-dc83-08dbdcade104 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam-message-info: k87vZq48fc7bmrKl404t/aLrhgJmBwD2uGNgKbhRT0K/sUPReZsQvgrKFUOjffEJv7Yu/RrjyI4UDas0Pkvok1SMXfWphoPBUZ4AxT0WbkwZoB4HdSXZME6tNN++dEuYnT7mWBNGmI022dI0Fv4Z9FrEmsFvLL/eidh9d6JEF6UH5tUyVQKqQjiXSOyLmC9mI3dUWdTpj4UauCheHf811UQzyt8WrNdVu7WiW+eDFKFbLniOxN+7oDNjCvYb9W2KWShbdybW5GLciBRx53i36ZBk73i13vvLQ2r35It6gYcq93/I2AsKCJTMqmrZ8kSJFq2o6A7hSY74PJGJ0kTsg+XnwDrcXfLTqt0f8UYuw9OeowaHe7qpOdY3bAgnFB6H85JFeL0Y2ugJhMO9eW868W6tU7b2W0mbfYDL8KOP39gJmce8DGXI5HdpkujsK++MBwSoB5pONxaBhRKHa/V7TuHJ58eBx7SCrp054lZb0L3AJfiPm7V22bclJw5sdkQQX71r14e9gwqSWn6LI7hVVG6+Wxw9+kSwCWTlX7iqtqTKtQB1L2xjrJE1eChH/vhXGXSvNa33lLD5Mg/9jN+qgQpeKSk4Aic8zQjo+2d02PkdOX1ERJMID5MQd9j69kItvme2lROB2RUXjMuPQTKDQw== x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?VDvET1Z88NDiwa2ivy0LCrG5uoZodUrhORoKW4a8vgW4ax/au2RxgdKAwVrm?= =?us-ascii?Q?SswviMB1Qn7Dap+swVUFgriAWsqaupFsowT5PxZqyFMHxdi6q2p+uZSgPCzc?= =?us-ascii?Q?OWDcSv7L3YlUia4g7/GHh6sC5CCNryMjBpumsSAUTrToLKoF14wlO7ICmCZL?= =?us-ascii?Q?SqABP+BxLs3ko3MbWL0o9a65LVOkEe2BO8JfKGgkk7LXgK3/86J1HPj162AT?= =?us-ascii?Q?BWd9WYgwjSSsUzp8kKvap9cTe9RaYS0XPxN/nf+daxPutXiBykS33VesNdS0?= =?us-ascii?Q?mo4Trn0Kt9yzSaBRxw2z2y0F6p5eTrqKsJmhuD1gVWselv3kBbl59iBscE8j?= =?us-ascii?Q?71dxRDyFFetlKPc7wA1Xl+1M0JXqqhHDq+3L3d1Svq7EjeDFUdAsGc0h9Byu?= =?us-ascii?Q?5eUDV+3qjQesR9bllIjhmySM0v/7RblDsT4eaQVGIIc7ZyQddkt6pKFgzo2x?= =?us-ascii?Q?fE7K3MDnjCVejWMvXe8fRpv9+k8I4V/vUjzB5yNXvhCiH29WHnOmLq02Ts33?= =?us-ascii?Q?TZCwLnGpwP60eN8Vt2YF3wVIsfeW+3gx4J4UL8t45smZLVBJU0qp6BVTfKZb?= =?us-ascii?Q?cNe7SuXAKzajMI5I1p4yVKXk9srUAv9N2DPn5oaTe6YWxJ0setCagcnK777g?= =?us-ascii?Q?j4lUA716Xtp2LSpzXXCQFyy+p8K2iRBhcNFS5TYx8yGdYj1ve9eu20yCABTn?= =?us-ascii?Q?CbQ4Z9M3KEpLjo8KhR5TE+80+XiNK+RwJwVIKAl/7fr8Z4/It+Z51QMgUSz7?= =?us-ascii?Q?tGM7uEtWqA9tJlZod86oQZHPBr+GK++DeglS7Ys2OxoUZGP+jyGg0+316PWY?= =?us-ascii?Q?eh7Wua6x/Qx2rh1XFeklv0yyYbIMNbDbv/jnqxnziwJ/obKo8KKeaDloFUAw?= =?us-ascii?Q?kiylUS7GbJdNkDJw8oCfxZhZ7NlKyjxGi8cAFpzIIu2tlMU1hirRJ6t7dAvs?= =?us-ascii?Q?5hvvsKuCLuA4CT+eQETNxtKBGv7QxCZJgwxTfsTtEr5syQoBGDMSa6YTd/wx?= =?us-ascii?Q?Ys8AjIQAe6Y4yZWQ4O3Es7ALm18FS8OuX2awRAy9gcxQTw4vTS5aKq96D2eg?= =?us-ascii?Q?vKuA3KE2c1rs0I84YzmGaWEpzZyDvsGPHaw5+/lY5H8HfjvKlVaDXt4QBw8R?= =?us-ascii?Q?ivbLR5glkckc3dGvEfEFm+TAW5Tf/iYpKUO1LimZjS8zdGmUeOfGoKYqJgcs?= =?us-ascii?Q?EmIGswO5E0xw+WMSME8eSJk1z+f8Vv/H2RM8K3g0aD7LUTXJUbsmijc2GiX3?= =?us-ascii?Q?kFHj5S7OfTpNHDSDH/KXDIh/Bszy+BHmx6ULJSks2Re1ghDNxhyy6cKzzDvi?= =?us-ascii?Q?gaK3LB0hfPrlGHoDFxdug6eCGuacs+4obLD1hV9QU+deGI0KkiXJgqvdr4rJ?= =?us-ascii?Q?1v+yz64tJqW44/O7BV6EilV/JrwaZBUtf6wDKg0uzK6h+zrb09bMhrPxg4zY?= =?us-ascii?Q?2fio9rnU2lxJQfH9hvBQPPIDy/vqMkS4+jm2DFOwX8iMyxU23pDOiwN+nu+m?= =?us-ascii?Q?ft2cBrVTOh0Kyjev4/JODDWRc+Ew07sQkGpYPZbjQRBSDn2LMWpue8i0PiE1?= =?us-ascii?Q?6gW9ZIURyDgKh9bjAzQYGbKXiF+o/K1m/39BS6j5/ZFHlocQfjzHz6uRHb4L?= =?us-ascii?Q?Uw=3D=3D?= MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: MW4PR11MB5821.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 8d4e3aca-a890-48f5-dc83-08dbdcade104 X-MS-Exchange-CrossTenant-originalarrivaltime: 03 Nov 2023 20:45:56.5309 (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: DLGgx/IzsZJI1Fc22oOsppg3vqkqN15uj6bWQQcYihy+UECHumgkmxUb9sh35Sw94WAKhquOqbDgDbwNpwRjzHiJaz0tEKgMq0GQnG1IkUQ= X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH3PR11MB8465 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,nathaniel.l.desimone@intel.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: lN2z86RMll0bp6XdN3rBFmWDx7686176AA= 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=kvOEZa8l; 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: Nate DeSimone -----Original Message----- From: Ni, Ray =20 Sent: Wednesday, November 1, 2023 2:30 AM To: devel@edk2.groups.io Cc: Chiu, Chasel ; Desimone, Nathaniel L ; Duggapu, Chinni B ; Ng, = Ray Han Lim ; Zeng, Star ; K= uo, Ted ; S, Ashraf Ali ; Mohapa= tra, Susovan Subject: [PATCH] IntelFsp2Pkg/PatchFv: Fix syntax issue in markdown manual 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 Cc: Nate DeSimone Cc: Duggapu Chinni B Cc: Ray Han Lim Ng Cc: Star Zeng Cc: Ted Kuo Cc: 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 firmwar= e volumes (**FV**) with in the flash device (**FD**) file post FSP build. F= rom version 0.60, script is capable of patching flash device (**FD**) direc= tly. -#Synopsis+# Synopsis ``` PatchFv FvBuildDir [FvFileBaseNames:]FdFile= BaseNameToPatch ["Offset, Value"]+@@ -18,32 +18,32 @@ PatchFv FdFileDir FdF= ileName ["Offset, Value"]+ | ["Offset, Value, $Command, @Comment"]+ ``` -#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 re= locatable. The tool is written in Python and uses Python 2.7 or later to ru= n. Consider using the tool in a build script. -#FvBuildDir (Argument 1)+# F= vBuildDir (Argument 1) This is the first argument that **_PatchFv.py_** req= uires. It is the build directory for all firmware volumes created during t= he FSP build. The path must be either an absolute path or a relevant path, = relevant to the top level of the FSP tree. -####Example usage:+#### Example= usage: ``` Build\YouPlatformFspPkg\%BD_TARGET%_%VS_VERSION%%VS_X86%\FV ``= ` The example used contains Windows batch script %VARIABLES%. -#FvFileBase= Names (Argument 2: Optional Part 1)+# FvFileBaseNames (Argument 2: Optional= Part 1) The firmware volume file base names (**_FvFileBaseNames_**) are th= e independent-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+**FvFileB= aseNames:**) The colon **:** is used for delimiting the single argument and= must be appended to the end of each (**_FvFileBaseNames_**). -####Example = usage:+#### Example usage: ``` STAGE1:STAGE2:MANIFEST:YOURPLATFORM ```@@ -5= 5,14 +55,14 @@ In the example **STAGE1** is **STAGE1.Fv** in **YOURPLATFORM= .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 **YOURPLATFO= RM**) -####Example usage:+#### Example usage: ``` STAGE1:STAGE2:MANIFEST:YO= URPLATFORM ``` In the example **YOURPLATFORM** is from **_YOURPLATFORM.fd_= ** -#"Offset, Value[, Command][, Comment]" (Argument 3)+# "Offset, Value[, = Command][, Comment]" (Argument 3) The **_Offset_** can be a positive or neg= ative number and represents where the **_Value_** to be patched is located = within the FD. The **_Value_** is what will be written at the given **_Offs= et_** in the FD. Constants may be used for@@ -79,10 +79,10 @@ The entire ar= gument includes the quote marks like in the example argument below: 0xFFFFFFC0, SomeCore:__EntryPoint - [0x000000F0],@SomeCore Entry ``` -###C= onstants:+### Constants: Hexadecimal (use **0x** as prefix) | Decimal -###= #Examples:+#### Examples: | **Positive Hex** | **Negative Hex** | **Positi= ve Decimal** | **Negative Decimal** | | ---------------: | ---------------:= | -------------------: | -------------------: |@@ -93,7 +93,7 @@ ModuleNam= e:FunctionName | ModuleName:GlobalVariableName ModuleGuid:Offset ``` -###O= perators:+### Operators: ``` @@ -113,7 +113,7 @@ From version 0.60 tool al= lows to pass flash device file path as Argument 1 and flash device name as= Argument 2 and rules for passing offset & value are same as explained in t= he previous sections. -####Example usage:+#### Example usage: Argument 1 ``= ` YouPlatformFspBinPkg\@@ -123,21 +123,21 @@ Argument 2 Fsp_Rebased_T ``` -###Special Commands:+### Special Commands: Special com= mands must use the **$** symbol as a prefix to the command itself. There is= only one command available at this time. ```-$COPY ? Copy a binary block = from source to destination.+$COPY Copy a binary block from source to dest= ination. ``` -####Example:+#### Example: ``` 0x94, [PlatformInit:__gPcd_Bi= nPatch_FvRecOffset] + 0x94, [0x98], $COPY, @Sync up 2nd FSP Header ``` -###= Comments:+### Comments: Comments are allowed in the **Offset, Value [, Comm= ent]** argument. Comments must use the **@** symbol as a prefix. The commen= t will output to the build window upon successful completion of patching al= ong with the offset and value data.--=20 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 (#110669): https://edk2.groups.io/g/devel/message/110669 Mute This Topic: https://groups.io/mt/102315223/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-