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 AFAF074003A for ; Wed, 1 Nov 2023 13:12:05 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=EG5zJqCg01M4xeKrVdKDnh5fs4SWfT/DDWGjwRS8coM=; 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=1698844324; v=1; b=SqKKr5Vxo+ycNM3hD3u5VhVroRWFN6cvqG+nRnTdz8jKNSoDx+dFQJRR2k+Vf3lWKgeazjdN FrfKypnjxkzcDJkdJEn6orWqrjKc466PKmeYf+9XgswldnrwUthpu9zz7VKQTAZxoigYZFKfbHM q5BlBiQ4vA4cYg7bBfXu//uc= X-Received: by 127.0.0.2 with SMTP id uk3JYY7687511xyCf3dnJv1s; Wed, 01 Nov 2023 06:12:04 -0700 X-Received: from mgamail.intel.com (mgamail.intel.com [192.55.52.136]) by mx.groups.io with SMTP id smtpd.web10.6878.1698844323227642859 for ; Wed, 01 Nov 2023 06:12:03 -0700 X-IronPort-AV: E=McAfee;i="6600,9927,10880"; a="367834499" X-IronPort-AV: E=Sophos;i="6.03,268,1694761200"; d="scan'208";a="367834499" X-Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 01 Nov 2023 06:12:02 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10880"; a="710782461" X-IronPort-AV: E=Sophos;i="6.03,268,1694761200"; d="scan'208";a="710782461" X-Received: from orsmsx601.amr.corp.intel.com ([10.22.229.14]) by orsmga003.jf.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 01 Nov 2023 06:12:02 -0700 X-Received: from orsmsx611.amr.corp.intel.com (10.22.229.24) 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; Wed, 1 Nov 2023 06:12:02 -0700 X-Received: from orsmsx610.amr.corp.intel.com (10.22.229.23) by ORSMSX611.amr.corp.intel.com (10.22.229.24) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.34; Wed, 1 Nov 2023 06:12:01 -0700 X-Received: from ORSEDG601.ED.cps.intel.com (10.7.248.6) by orsmsx610.amr.corp.intel.com (10.22.229.23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.34 via Frontend Transport; Wed, 1 Nov 2023 06:12:01 -0700 X-Received: from NAM04-MW2-obe.outbound.protection.outlook.com (104.47.73.168) by edgegateway.intel.com (134.134.137.102) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.34; Wed, 1 Nov 2023 06:12:01 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Ywk716F2UXEl3qG1NyiUBHBfGR4lDUbTw+9MdubPLnnnDE+F3TS1Jyy5Jto0UclStz/2KoWhNcsyiNumasoI2GTO1uu5LK9KOwukQBGICgqJLZs0jkNNr/dgRMNt0ExoLSXv3uNHnRuIhhLZiUmeOJBpIDaAN91W1apqkFicy0stg0B/slLSgGFx7k8LaZsxUKWk6juQ83kEYHksZsBQJ/MX6dwTnWM16VdXykTcE2k07B6AnQXVIUtIWGr5xDSm4kezf4zODb6KPDwX2w5jcxNXa4zlwcXj0M7fz3lOd3uutiKQI5OVyuugC5tuzSVsPxrymlNyZyz8ZrK+9OS69g== 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=xTB0ZpZwcsO3/LvTuZqTd/CJ4H7OOXzVBv6/uudHQn8=; b=JVcvE3BZ+tK8/pCFLZMfEuMvaZOCsxtrjR3Ho1rjXxlWOIaDY+YN0DbIMx4KrBBQUw2nuBOe7QHE6es5bhVzVoULaUZa36XE79BwnKBCqorWkNnyrfqsX4w/wO+aX84G2cWLyYY1QIfx0ecpWLMjsRaC7WMAoTvIKw9vpEQ6temg3tIuqSaIYCBzUTKWaH/LSVafFIEZvcFJagZk4vt6E1ya0cQ6GU3bPz8RuPXO6tsky0yi8v2w08TgtR+jKIdfV3wn4D7OwV1AEi5zOEUqII2SmhdW0eAK+Quls5OqR/pQcixQqOlBYXIyAN0pSS81x9dUmiLA8Wtm72WMnVifig== 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 DS0PR11MB6376.namprd11.prod.outlook.com (2603:10b6:8:c8::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6907.33; Wed, 1 Nov 2023 13:11:59 +0000 X-Received: from DM4PR11MB5280.namprd11.prod.outlook.com ([fe80::efad:9d8e:4793:108a]) by DM4PR11MB5280.namprd11.prod.outlook.com ([fe80::efad:9d8e:4793:108a%4]) with mapi id 15.20.6933.029; Wed, 1 Nov 2023 13:11:59 +0000 From: "Ashraf Ali S" To: "Ni, Ray" , "devel@edk2.groups.io" CC: "Chiu, Chasel" , "Desimone, Nathaniel L" , "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: AQHaDKYnx4j33EDHKUeqKSc4dvoxsrBlcKNg Date: Wed, 1 Nov 2023 13:11:59 +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: DM4PR11MB5280:EE_|DS0PR11MB6376:EE_ x-ms-office365-filtering-correlation-id: 55632950-39a0-49e9-2049-08dbdadc2187 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam-message-info: 6vOq178vWUmNXvMnjvDCRDQCbbsmJ5mgNxmCkVoYi7zzjNhJhU98jr3nJvFHFrHK5+YqFd/59eSVSoQXo/wyD3fRylByNokPRM5iRPZZdDVBPdOf0ERmIX8XSFROT1XiGWLg7X+AJ4dTsRBcfPcrGKaSnQKsKFMVwb+OB+xdBLKSNnWZMcFFi4/oedGOoMbCTqtuZrEyBWOp1UqQoY8yow3FJBvL0hivKJckQXgSALerx1HRHHO2lccu6e4IHEWGVsj/fz65wv3KBPeA97/Q9v1MvWKj9OaWlabDqetS7Cq0W0pqeUUugml9ckJoYzH80S0di76xwBVzt+xdYXnjE8LL4MBWsVNGVu7vs1ywv4wSxEfZDq6QT1pQn9f1D+Bn/k6+jgg0DG/ub/MKus1Y4mObGGOCjCMUDnxxm3yTdZPnXTsZiJMBiHBANXaGjZlCt+dq5aV+BfiFVlCvAb2HWebMvkLbtLp2Zdo2ukPmJPNiilKrukYH+GmvykAwV5FLbNmF/6OfrLlWqfhtcmM1FihtqjmkX7JMJgWPoS4v6fks6Ti9yJTJaHgOgZKUpInT3U+ui8QIMN/bjjrwSMzzv6r5QZzEre20yQT8Wj0ChobaPBme0VsgXD8IsYx1b+7c9irhOzv+7l533ksUuHLTHA== x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?QnAS7LcHh/lk0PKXiEYnYATvP5DYJeMy4abCPqFesWfo1ZS8vIGY2BNBgdCx?= =?us-ascii?Q?g+WzYBzkXcNowfiVKPj7yWnUNnIvzz/NWoMbtGvTuf/oSK5HldpYrVvDzTRp?= =?us-ascii?Q?dIejtAvkBtVkmA/j2dlCUevqeuTlV18nrfaVGksYkWb4iMWASmeSDwTSULjL?= =?us-ascii?Q?Cm2QKM7Y/1JyOgSuB4ZHauaH2XRBNvbn5iJVXED/qgqgLWibP0+1yZprFlXM?= =?us-ascii?Q?2mwpJOwWUNpbyVAIlkuAYstUGgVtDdpwZ1YTIXekAUrfy8DnIIyknNXyE5AB?= =?us-ascii?Q?YkyiAGCMb6hvUtYV7rCPQsrwobh/0LHj5JT0SWOmRdrNkz5rk+NLWu1Y+An6?= =?us-ascii?Q?ruCXq1crcgSlj+zTiOhGCS+QtXNEb8Wgaeyn6swrvNhWw+N8/Zo0W6I78ZJe?= =?us-ascii?Q?Z/ue2QF3blpvS7op7NqyX5YNMCDvUqbpxHYUx+FTWt0XF+fralxPWhUCXAXK?= =?us-ascii?Q?+R7QTzQLyuSAk7DPlmqEMdVmOgVSzac8uoYsh1GTFxuEbyNlMR+O0A5CebDo?= =?us-ascii?Q?HurlB5CCu7vR1qIOtX0cq5h3KPQvnYDqOHm0oXObVQVYOEAPBa1pxBhm5irO?= =?us-ascii?Q?HeNAP8n6hD8WsVyw12RuMjxOYziM6C/2aa7H8/C69wOK9sIF3wubT0hf4BFU?= =?us-ascii?Q?DiekY+hDvK213p7pwZhtEJoq8CVo6d9NNY1MPbVV+DWJvvVFVxGt8d7DGBvQ?= =?us-ascii?Q?t0K9ynZEuUpteZ+sFfQDoQj/UGCfg0WI/WLKSeaxud1VKEMJRs59gVs0PdIv?= =?us-ascii?Q?Bdkp7J+8GHJbS8X/SNzBLpA6/LSMmtpv9lfRFjm3OR4aNA84wkJTW6DMaZtE?= =?us-ascii?Q?eYRVRRMr6o22Xf3BtgIAzDD08mxIDxV2Wyz/yoNZRaFIq3NixVBI4wIhqNhC?= =?us-ascii?Q?dDVQwfVb30QLlafOExOgW5DuCuMPO421sjubBY3GvIfZWOLcK27KlAOamVba?= =?us-ascii?Q?kyB3sVvbvXM3w/6JLQ1BF/VVV79IxqTfeMeK5ze5bB1/dj/eGNMw/yl7cUPk?= =?us-ascii?Q?sAK6XH/p3faHb9tsJxJDHWa5bsdqsY0BV16Nny8OJxQ0AO+8urwG3fvpZsBc?= =?us-ascii?Q?XtiFtNgvHrTDHuFqa7etY6uGQ9eYHmLeUHS7jJ+IhDTRGikRhWpQrlA7M5wY?= =?us-ascii?Q?ZCcDM5IioFNPAu/srNl/wGJfDRoOoYgmD8N3jHwRdPPgjDhB9cIx66SqcKfc?= =?us-ascii?Q?l3iHj899MBeNeEC3IgiTb6jZZnYoiVdTK4BP85pbV5Mm1hSc1Xru+se9MbnX?= =?us-ascii?Q?KzDLDsYNudLK4VIhTW1n+m1yRnV6zkgwxzT41/2UuEzJFbJF3Z5pIl6UJftq?= =?us-ascii?Q?WdeOljdyclpeAAAXwOHYx8bNcJbiYfzbG/q0r+RRX3MhHLo3qeVh4upzIuU1?= =?us-ascii?Q?lDbESFUDOwRmFJ4eHg1LC4zY7GBhzPwhpfeMCh4eAbZnGUVC41XH83xYt6Yd?= =?us-ascii?Q?QCNtwNDo5mKVPZguo+Gdeg9nTSwrpypA701MtLSDmyhsWEjQKM3CJGhXAnqw?= =?us-ascii?Q?V2smWwrHwzVZj7D3DY3asWUg2Pvg0MyJnzVer7nINeckFueEfxtmDUwU97mo?= =?us-ascii?Q?uQ6CyjcA+4FSCwL0XgeBc7253cXf99JtHSiplGco?= 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: 55632950-39a0-49e9-2049-08dbdadc2187 X-MS-Exchange-CrossTenant-originalarrivaltime: 01 Nov 2023 13:11:59.3120 (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: BkAkih8XYX6P+OtsrVnza1hlYe3nMpuZr/6bLQlrYbCZeudVR2EqcB1zdlEjfGeOH+tuRiuWGOpyxtcIxrUnqA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS0PR11MB6376 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: Tr211xoGjZ3Vjle3ZkS9D6sGx7686176AA= 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=SqKKr5Vx; 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; arc=reject ("signature check failed: fail, {[1] = sig:microsoft.com:reject}") Reviewed-by: Ashraf Ali S Thanks., S, Ashraf Ali -----Original Message----- From: Ni, Ray =20 Sent: Wednesday, November 1, 2023 3:00 PM 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 (#110479): https://edk2.groups.io/g/devel/message/110479 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-