From nobody Sun Apr 28 09:53:33 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+68197+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+68197+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1606936562; cv=none; d=zohomail.com; s=zohoarc; b=IF3lczm+FtxllzHakzlOO9jrij/K1hCFRtFKw7IoT7cWqr5taYj6IBt4XTvEhx/uec3bdAC0/l+heiZi6aJ2sgddXTiI09re8bawYlKvJ+5eWyu7Cgfz54vUJ0nWh/xE6MUgLWWss2i9ScAbLQAvBT5+xSKqC4UqPHDPW5RUjPM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1606936562; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Id:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Sender:Subject:To; bh=1sBFEHtadmdA4GqvTRxitCqDThA7Ccd3qEuCSL/q3IM=; b=JdHQPEubc0ECtVfu5D46q+ML32TjxXXDQHjhiJCn3C6pj9u8akS/feB0ngNS9NoR9YGQuRmbB1Kb+2cENB/ZIwqRgs/7H9NPJdPX1VyF0Wa9Yyxuv/V3YTH6yURl2BrrScqulXTwrVIlYRX37pghVaqEMpjFUzcw46PcYXXBnLg= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+68197+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 160693656283419.739526111476493; Wed, 2 Dec 2020 11:16:02 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id DUdVYY1788612xyR5sK4Yjj1; Wed, 02 Dec 2020 11:16:02 -0800 X-Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by mx.groups.io with SMTP id smtpd.web12.388.1606936556791014748 for ; Wed, 02 Dec 2020 11:15:56 -0800 IronPort-SDR: 1MpL/+qA2hi3ta2pIJSM/G4BR1wf5qv2lzAWsZWDp2GpxCEp7esRegbtR9ziZF2r05V/8WTr5G s8aKxKswRU+Q== X-IronPort-AV: E=McAfee;i="6000,8403,9823"; a="152898869" X-IronPort-AV: E=Sophos;i="5.78,387,1599548400"; d="scan'208";a="152898869" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga107.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Dec 2020 11:15:54 -0800 IronPort-SDR: ZsO3eGUjFfGqUXA3a1dFCRtaivXiJFNd1quuhP/cuL5N8qkMBvFr06yxQtIJriJp8aOUCn1XtX nH7qkrBns8pg== X-IronPort-AV: E=Sophos;i="5.78,387,1599548400"; d="scan'208";a="550185431" X-Received: from mdkinney-mobl2.amr.corp.intel.com ([10.212.175.143]) by orsmga005-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Dec 2020 11:15:53 -0800 From: "Michael D Kinney" To: devel@edk2.groups.io Cc: Laurie Jarlstrom Subject: [edk2-devel] [wiki][Patch] Update links to published documents in tianocore-docs Date: Wed, 2 Dec 2020 11:15:47 -0800 Message-Id: <20201202191547.488-1-michael.d.kinney@intel.com> MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: 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,michael.d.kinney@intel.com X-Gm-Message-State: vcZ9FiErwkk6aYUedAvrRlGtx1787277AA= Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1606936562; bh=v+9SxTmDThimzgwL+A0onemd7DZ/PyoQDC6ThIZR5us=; h=Cc:Content-Type:Date:From:Reply-To:Subject:To; b=jZNbYGNpsrxTbW2p+/CdzBchb+2ZGPGljxDnG4H60DXy4l67LnzJS6iw21gvqcORFiM y6Vktgc2p9BB5LZwPBxEVRhPvYmnlq56mGPKBSRexVA3RVu60vL4ek+lxeLU97t3pV0LL puak1VKflIePM6+IrWExdsStQzwuVU5yOjg= X-ZohoMail-DKIM: pass (identity @groups.io) Documents in tianocore-docs are now published using the Gitbook Action and the links to the published HTML, PDF, EPUB, and MOBI documents are now in the web pages published by GitHub from the gh-pages branch of each document repository. Cc: Laurie Jarlstrom Signed-off-by: Michael D Kinney Reviewed-by: Laurie Jarlstrom laurie.jarlstrom@intel.com --- CET-in-SMM.md | 2 +- DEC-FAQ.mediawiki | 2 +- Driver-Developer.mediawiki | 2 +- ECC-tool.md | 2 +- EDK-II-Draft-Specification.md | 88 ++++++++++---- EDK-II-Platforms.md | 2 +- EDK-II-Security-White-Papers.md | 8 +- EDK-II-Specifications.md | 111 ++++++------------ EDK-II-User-Documentation.mediawiki | 5 +- EDK-II-white-papers.mediawiki | 28 +++-- HTTP-Boot.md | 2 +- HTTPS-Boot.md | 2 +- How-To-Contribute.mediawiki | 2 +- Kaby-Lake-MinPlatform.md | 2 +- Minimum-Platform-Architecture--MinPlatform.md | 2 +- UEFI-Driver-Writer's-Guide.md | 9 +- Whiskey-Lake-MinPlatform.md | 2 +- 17 files changed, 145 insertions(+), 126 deletions(-) diff --git a/CET-in-SMM.md b/CET-in-SMM.md index 0f40db6..ade87f1 100644 --- a/CET-in-SMM.md +++ b/CET-in-SMM.md @@ -13,7 +13,7 @@ For detail of CET, please refer to Control-flow Enforceme= nt Technology whitepape =20 # Introduction =20 -EDKII has enabled different technology for security, such as memory level = protection [A Tour Beyound BIOS - Memory Protection in UEFI BIOS](https://= edk2-docs.gitbook.io/a-tour-beyond-bios-memory-protection-in-uefi-bios/), o= r buffer overflow mitigation [A Tour Beyound BIOS - Mitigate Buffer Overflo= w in UEFI](https://edk2-docs.gitbook.io/a-tour-beyond-bios-mitigate-buffer-= overflow-in-ue/). +EDKII has enabled different technology for security, such as memory level = protection [A Tour Beyound BIOS - Memory Protection in UEFI BIOS](https://= edk2-docs.gitbook.io/a-tour-beyond-bios-memory-protection-in-uefi-bios/), o= r buffer overflow mitigation [A Tour Beyound BIOS - Mitigate Buffer Overflo= w in UEFI](https://tianocore-docs.github.io/ATBB-Mitigate_Buffer_Overflow_i= n_UEFI/draft/). =20 Now EDKII can use CET to enforce the control-flow as well. The current sta= tus is that EDKII enabled ShadowStatck in SMM. =20 diff --git a/DEC-FAQ.mediawiki b/DEC-FAQ.mediawiki index 22bfc00..fbfe93e 100644 --- a/DEC-FAQ.mediawiki +++ b/DEC-FAQ.mediawiki @@ -4,7 +4,7 @@ =20 The [https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Specific= ations#dec| EDK II Declaration (DEC)] file format supports the building, pa= ckaging, and distribution of EDK II modules. The [https://github.com/tiano= core/tianocore.github.io/wiki/EDK-II-Specifications#dsc| EDK II Platform De= scription file (DSC)] format describes a platform, which is (basically) a c= ollection of DSC files. The [https://github.com/tianocore/tianocore.github.= io/wiki/EDK-II-Specifications#inf| EDK II build information (INF)] file for= mat describes how to build a single EDK II component, which generates a .EF= I file.=20 =20 -For more info on DEC, please review the specification: https://edk2-docs.g= itbook.io/edk-ii-dec-specification +For more info on DEC, please review the specification: https://tianocore-d= ocs.github.io/edk2-DecSpecification/draft/ =20 =3D=3D=3DHow many DEC and DSC files are in a build?=3D=3D=3D =20 diff --git a/Driver-Developer.mediawiki b/Driver-Developer.mediawiki index 78b1e38..b184623 100644 --- a/Driver-Developer.mediawiki +++ b/Driver-Developer.mediawiki @@ -22,7 +22,7 @@ This page is designed to support Unified Extensible Firmw= are Interface ([[UEFI]] =20 [[UEFI Driver Writer's Guide]] - The [[UEFI Driver Writer's Guide]] (DWG) is available in gitbook.<= /td> + The [[UEFI Driver Writer's Guide]] (DWG) is available in multiple = formats. =20 diff --git a/ECC-tool.md b/ECC-tool.md index b723cba..279b7cd 100644 --- a/ECC-tool.md +++ b/ECC-tool.md @@ -1,6 +1,6 @@ # 1. What is ECC tool? ECC is a python tool which helps to detect coding style issues.
-It reports errors for the codes which don't follow [EDK II C Coding Standa= rds Specification](https://edk2-docs.gitbooks.io/edk-ii-c-coding-standards-= specification/content/).
+It reports errors for the codes which don't follow [EDK II C Coding Standa= rds Specification](https://tianocore-docs.github.io/edk2-CCodingStandardsSp= ecification/draft/).
=20 # 2. Where is ECC tool? ECC tool is located in edk2/BaseTools/Source/Python/Ecc. diff --git a/EDK-II-Draft-Specification.md b/EDK-II-Draft-Specification.md index 4833ad0..9fd2622 100644 --- a/EDK-II-Draft-Specification.md +++ b/EDK-II-Draft-Specification.md @@ -1,12 +1,15 @@ -The documents in this page are the latest draft revisions published using = [Gitbook - Tianocore Docs](https://app.gitbook.com/@edk2-docs/spaces/). +The documents in this page are the latest draft revisions using the=20 +[Gitbook Markdown](https://github.com/GitbookIO/gitbook/blob/master/docs/s= yntax/markdown.md) +source format and published using the [Gitbook Action](https://github.com/= marketplace/actions/gitbook-action). The source content for these documents are in GIT repositories in the [Tianocore-docs](https://github.com/tianocore-docs) organization hosted by= [GitHub](https://github.com). -Feedback on these documents may be provided using the [Gitbook](https://ww= w.gitbook.com) commenting feature -available when reading the **HTML** versions of the documents. Document is= sues and feature requests can also -be entered in [Tianocore Bugzilla](https://bugzilla.tianocore.org). +Document feedback, issues, and feature requests can be entered in [Tianoco= re Bugzilla](https://bugzilla.tianocore.org). =20 * **_EDK II Build Specification_** \[=20 -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-build-specification/) , +[HTML ](https://tianocore-docs.github.io/edk2-BuildSpecification/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-BuildSpecification/draft/e= dk2-BuildSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-BuildSpecification/draft/e= dk2-BuildSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-BuildSpecification/draft/e= dk2-BuildSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-BuildSpecification) \] This document describes the EDK II Build Architecture. This specificati= on was designed to support new build requirements for building EDK II modules and= EDK @@ -14,7 +17,10 @@ components within the EDK II build infrastructure as wel= l as to generate binary firmware images and Unified Extensible Firmware Image (UEFI) applications. =20 * **_EDK II DEC Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-dec-specification), +[HTML ](https://tianocore-docs.github.io/edk2-DecSpecification/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-DecSpecification/draft/edk= 2-DecSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-DecSpecification/draft/edk= 2-DecSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-DecSpecification/draft/edk= 2-DecSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-DecSpecification) \] This document describes the EDK II Declaration (DEC) file format. This = format=20 was designed to support building packaging and distribution of EDK II modu= les, @@ -25,7 +31,10 @@ may also be created manually. The EDK II Build Infrastr= ucture supports generati of UEFI 2.5 and PI 1.4 (Unified EFI, Inc.) compliant binary images. =20 * **_EDK II INF Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-inf-specification), +[HTML ](https://tianocore-docs.github.io/edk2-InfSpecification/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-InfSpecification/draft/edk= 2-InfSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-InfSpecification/draft/edk= 2-InfSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-InfSpecification/draft/edk= 2-InfSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-InfSpecification) \] This document describes the EDK II build information (INF) file format.= This format=20 supports the new build requirements of build EDK components and EDK II mod= ules within @@ -34,7 +43,10 @@ binary images that comply with Unified EFI (UEFI) 2.5 an= d UEFI Platform Infrastr (PI) 1.4 specifications. =20 * **_EDK II DSC Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-dsc-specification/details), +[HTML ](https://tianocore-docs.github.io/edk2-DscSpecification/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-DscSpecification/draft/edk= 2-DscSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-DscSpecification/draft/edk= 2-DscSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-DscSpecification/draft/edk= 2-DscSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-DscSpecification) \] This document describes the EDK II Platform Description file (DSC) form= at. The EDK Build Tools are included as part of the EDK II compatibility package. In order to use = EDK II Modules or the @@ -45,7 +57,10 @@ The EDK II Build Infrastructure supports creation of bin= ary images that comply w (UEFI) 2.5 and UEFI Platform Infrastructure (PI) 1.4 specifications. =20 * **_EDK II FDF Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-fdf-specification), +[HTML ](https://tianocore-docs.github.io/edk2-FdfSpecification/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-FdfSpecification/draft/edk= 2-FdfSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-FdfSpecification/draft/edk= 2-FdfSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-FdfSpecification/draft/edk= 2-FdfSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-FdfSpecification) \] This document describes the EDK II Flash Description (FDF) file format.= This format was designed to support new build requirements of building EDK and EDK II modu= les within the @@ -55,20 +70,29 @@ describe the content and layout of binary images. Binar= y images described in thi be any combination of boot images, capsule images or PCI Options ROMs. =20 * **_EDK II UNI Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-uni-specification), +[HTML ](https://tianocore-docs.github.io/edk2-UniSpecification/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-UniSpecification/draft/edk= 2-UniSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-UniSpecification/draft/edk= 2-UniSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-UniSpecification/draft/edk= 2-UniSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-UniSpecification) \] This document describes the Multi-String build information (UNI) file f= ormat . See details in the Revision History in the document for more details. =20 * **_EDK II Image Definition IDF File Format Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-idf-specification), +[HTML ](https://tianocore-docs.github.io/edk2-IdfSpecification/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-IdfSpecification/draft/edk= 2-IdfSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-IdfSpecification/draft/edk= 2-IdfSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-IdfSpecification/draft/edk= 2-IdfSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-IdfSpecification) \] This document describes file format for Image Description files that ar= e used to create HII Image Packages introduced in the _Unified Extensible Firmware Interface Specification_, Version 2.1. =20 * **_EDK II VFR Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-vfr-specification), +[HTML ](https://tianocore-docs.github.io/edk2-VfrSpecification/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-VfrSpecification/draft/edk= 2-VfrSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-VfrSpecification/draft/edk= 2-VfrSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-VfrSpecification/draft/edk= 2-VfrSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-VfrSpecification) \] To simplify the creation of Internal Forms Representation (IFR), a high= -level Visual Forms Representation (VFR) language is described in this document. Using this la= nguage syntax, a @@ -76,19 +100,28 @@ compiler can be designed to take an ordinary text file= containing VFR as an inpu IFR for use in a user=E2=80=99s program. There are various methods to defi= ne the VFR language. =20 * **_EDK II Meta-Data Expression Syntax Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-meta-data-expression-syntax-= specification), +[HTML ](https://tianocore-docs.github.io/edk2-MetaDataExpressionSyntaxSp= ecification/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-MetaDataExpressionSyntaxSp= ecification/draft/edk2-MetaDataExpressionSyntaxSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-MetaDataExpressionSyntaxSp= ecification/draft/edk2-MetaDataExpressionSyntaxSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-MetaDataExpressionSyntaxSp= ecification/draft/edk2-MetaDataExpressionSyntaxSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-MetaDataExpressionSyntaxS= pecification) \] This document describes the syntax of expression statements for EDK II = Meta-data files used in data fields, feature flag expressions and conditional directive st= atements. =20 * **_EDK II PCD Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-pcd-specification), +[HTML ](https://tianocore-docs.github.io/edk2-PcdSpecification/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-PcdSpecification/draft/edk= 2-PcdSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-PcdSpecification/draft/edk= 2-PcdSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-PcdSpecification/draft/edk= 2-PcdSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-PcdSpecification) \] This document discusses the mechanisms and configuration entries requir= ed to make it=20 easy to write portable silicon modules and to port the Framework from plat= form to platform. =20 * **_EDK II C Coding Standards Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-c-coding-standards-specifica= tion), +[HTML ](https://tianocore-docs.github.io/edk2-CCodingStandardsSpecificat= ion/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-CCodingStandardsSpecificat= ion/draft/edk2-CCodingStandardsSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-CCodingStandardsSpecificat= ion/draft/edk2-CCodingStandardsSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-CCodingStandardsSpecificat= ion/draft/edk2-CCodingStandardsSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-CCodingStandardsSpecifica= tion) \] The EDK II C Coding Standards Specification establishes a set of rules = intended not as a constraint, but as an enabling philosophy which will: @@ -102,7 +135,10 @@ a constraint, but as an enabling philosophy which will: These rules apply to all code developed. =20 * **_EDK II Python Development Process Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-python-development-process-s= peicfication), +[HTML ](https://tianocore-docs.github.io/edk2-PythonDevelopmentProcessSp= ecification/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-PythonDevelopmentProcessSp= ecification/draft/edk2-PythonDevelopmentProcessSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-PythonDevelopmentProcessSp= ecification/draft/edk2-PythonDevelopmentProcessSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-PythonDevelopmentProcessSp= ecification/draft/edk2-PythonDevelopmentProcessSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-PythonDevelopmentProcessS= pecification) \] The EDK II Python Development Process Specification defines a set of py= thon coding standards, development flow, and tools to help to identify and fix @@ -117,7 +153,10 @@ deviations in written code. These standards, flow and = tools to establish: These rules apply to all code developed. =20 * **_EDK II Minimum Platform Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-minimum-platform-specificati= on), +[HTML ](https://tianocore-docs.github.io/edk2-MinimumPlatformSpecificati= on/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-MinimumPlatformSpecificati= on/draft/edk2-MinimumPlatformSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-MinimumPlatformSpecificati= on/draft/edk2-MinimumPlatformSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-MinimumPlatformSpecificati= on/draft/edk2-MinimumPlatformSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-MinimumPlatformSpecificat= ion) \] The EDK II Minimum Platform Specification describes the required and op= tional elements for an EDK II based platform with the following objectives: * Define a structure that enables developers to consistently navigate so= urce code, execution flow, and the functional results of bootstrapping a sy= stem. @@ -126,13 +165,19 @@ deviations in written code. These standards, flow and= tools to establish: * Enable large granularity binary solutions. =20 * **_EDK II Driver Writer's Guide for UEFI 2.3.1_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-uefi-driver-writer-s-guide), +[HTML ](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/dra= ft/), +[PDF ](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/dra= ft/edk2-UefiDriverWritersGuide-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/dra= ft/edk2-UefiDriverWritersGuide-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/dra= ft/edk2-UefiDriverWritersGuide-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-UefiDriverWritersGuide) \] This document is designed to aid in the development of UEFI Drivers usi= ng the EDK II open source project as a development environment. =20 * **_EDK II Module Writer's Guide_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-module-writer-s-guide), +[HTML ](https://tianocore-docs.github.io/edk2-ModuleWriteGuide/draft/), +[PDF ](https://tianocore-docs.github.io/edk2-ModuleWriteGuide/draft/edk= 2-ModuleWriteGuide-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-ModuleWriteGuide/draft/edk= 2-ModuleWriteGuide-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-ModuleWriteGuide/draft/edk= 2-ModuleWriteGuide-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-ModuleWriteGuide) \] This document is designed to aid in the development of EDK II Modules = using the EDK II open source project as a development environment. @@ -141,7 +186,10 @@ project as a development environment. --- =20 * **_EDK II Template Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-template-specification), +[HTML ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draf= t/), +[PDF ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draf= t/edk2-TemplateSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draf= t/edk2-TemplateSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draf= t/edk2-TemplateSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-TemplateSpecification) \] This document is a template that can be copied to start a new Tianocore= Gitbook document. It also provides examples for styles and formats commonly found in Tianoco= re specifications. diff --git a/EDK-II-Platforms.md b/EDK-II-Platforms.md index 4bc6066..b948a1e 100644 --- a/EDK-II-Platforms.md +++ b/EDK-II-Platforms.md @@ -11,7 +11,7 @@ Note: new platforms are being developed in the [edk2-plat= forms](https://github.c =20 ### Intel=C2=AE Processor Platforms =20 -Recent Intel platform EDK II implementations follow a software architectur= e intended to aid in uniform delivery of Intel platforms called EDK II Mini= mum Platform. That architecture is described and maintained in the [EDK II = Minimum Platform Specification draft](https://edk2-docs.gitbooks.io/edk-ii-= minimum-platform-specification). Brief and practical information regarding = the goals of a Minimum Platform and how to build are available in the Intel= platform [Readme.md](https://github.com/tianocore/edk2-platforms/blob/mast= er/Platform/Intel/Readme.md). +Recent Intel platform EDK II implementations follow a software architectur= e intended to aid in uniform delivery of Intel platforms called EDK II Mini= mum Platform. That architecture is described and maintained in the [EDK II = Minimum Platform Specification draft](https://tianocore-docs.github.io/edk2= -MinimumPlatformSpecification/draft/). Brief and practical information rega= rding the goals of a Minimum Platform and how to build are available in the= Intel platform [Readme.md](https://github.com/tianocore/edk2-platforms/blo= b/master/Platform/Intel/Readme.md). =20 #### EDK II Minimum Platforms =20 diff --git a/EDK-II-Security-White-Papers.md b/EDK-II-Security-White-Papers= .md index d8cb97b..2e9e5aa 100644 --- a/EDK-II-Security-White-Papers.md +++ b/EDK-II-Security-White-Papers.md @@ -15,12 +15,12 @@ A list of White Papers and information for EDK II Secur= ity from multiple sources =20 **EDK II Code:** * [A Tour Beyond BIOS - Security Design Guide in_EDK_II.pdf](https://githu= b.com/tianocore-docs/Docs/raw/master/White_Papers/A_Tour_Beyond_BIOS_Securi= ty_Design_Guide_in_EDK_II.pdf) (Sept 2016) -* [EDK II Secure Coding Guide ](https://edk2-docs.gitbook.io/edk-ii-secure= -coding-guide) (June 2019)=20 -* [EDK II Secure Code Review Guide ](https://edk2-docs.gitbook.io/edk-ii-s= ecure-code-review-guide) (June 2019) +* [EDK II Secure Coding Guide ](https://tianocore-docs.github.io/EDK_II_Se= cure_Coding_Guide/draft/) (June 2019)=20 +* [EDK II Secure Code Review Guide ](https://tianocore-docs.github.io/EDK_= II_Secure_Code_Review_Guide/draft/) (June 2019) =20 **Memory Protection:** * [A Tour Beyond BIOS =E2=80=93 Memory Protection in UEFI BIOS - gitbook](= https://edk2-docs.gitbook.io/a-tour-beyond-bios-memory-protection-in-uefi-b= ios) (March 2017) -* [A Tour Beyond BIOS - Mitigate Buffer Overflow in UEFI - gitbook](https:= //edk2-docs.gitbook.io/a-tour-beyond-bios-mitigate-buffer-overflow-in-ue) (= April 2018) +* [A Tour Beyond BIOS - Mitigate Buffer Overflow in UEFI](https://tianocor= e-docs.github.io/ATBB-Mitigate_Buffer_Overflow_in_UEFI/draft/) (April 2018) =20 **SMM Protection:** * [A Tour Beyond BIOS Secure SMM Communication](https://github.com/tianoco= re-docs/Docs/raw/master/White_Papers/A_Tour_Beyond_BIOS_Secure_SMM_Communic= ation.pdf) (April 2016) @@ -28,7 +28,7 @@ A list of White Papers and information for EDK II Securit= y from multiple sources =20 **SecureBoot/AuthVariable:** * [A Tour Beyond BIOS - Implementing UEFI Authenticated Variables in SMM w= ith EDK II](https://github.com/tianocore-docs/Docs/raw/master/White_Papers/= A_Tour_Beyond_BIOS_Implementing_UEFI_Authenticated_Variables_in_SMM_with_ED= KII_V2.pdf) (Oct 2015) -* [Understanding the UEFI Secure Boot Chain](https://edk2-docs.gitbook.io/= understanding-the-uefi-secure-boot-chain) (June 2019) +* [Understanding the UEFI Secure Boot Chain](https://tianocore-docs.github= .io/Understanding_UEFI_Secure_Boot_Chain/draft/) (June 2019) =20 **DMA:** [A Tour Beyond BIOS - Using IOMMU for DMA Protection in UEFI firmware](htt= ps://software.intel.com/sites/default/files/managed/8d/88/intel-whitepaper-= using-iommu-for-dma-protection-in-uefi.pdf ) (Oct 2017) diff --git a/EDK-II-Specifications.md b/EDK-II-Specifications.md index 2ce6cb0..53731b0 100644 --- a/EDK-II-Specifications.md +++ b/EDK-II-Specifications.md @@ -1,9 +1,10 @@ # **EDK II Specifications** -This page contains the released versions of the EDK II Specifications publ= ished using [Gitbook](https://gitbook.com/).
+This page contains the released versions of the EDK II Specifications publ= ished using +[Gitbook Action](https://github.com/marketplace/actions/gitbook-action). * The latest draft versions of the EDK II Specification can be found on th= e [[EDK II Draft Specification]] page. -* The previous versions of the EDK II Specifications can be found on the [= [EDK II Specifications Archived]] page.
+* The previous versions of the EDK II Specifications can be found on the [= [EDK II Specifications Archived]] page. =20 -For an understanding of the basic setup and to see examples of how to use = the EDK II Specification files [.DEC](#dec),[.DSC](#dsc) and [.INF](#inf), = see the wiki page [[Build Description Files]].
+For an understanding of the basic setup and to see examples of how to use = the EDK II Specification files [.DEC](#dec),[.DSC](#dsc) and [.INF](#inf), = see the wiki page [[Build Description Files]]. =20 The _EDK II Template Specification_ is an example document that may be use= d as a template=20 for a new document. For complete details on how to contribute to TianoCor= e documents, please @@ -13,98 +14,56 @@ see the information [here](https://github.com/tianocore= -docs/edk2-TemplateSpecif =20 | EDK II Specification | Revision | Date | Download | | ---------------------| --------- | ---- |-------------------------------= --------------| -|[Build](#build) |v1.30 | July 2019 | [Gitbook](https://edk2-docs.gitb= ook.io/edk-ii-build-specification/), [Github ](https://github.com/tianocore= -docs/edk2-BuildSpecification) | -|[DEC](#dec) |v1.29 | July 2019 |[Gitbook](https://edk2-docs.gitbook.= io/edk-ii-dec-specification), [Github ](https://github.com/tianocore-docs/e= dk2-DecSpecification)| -|[DSC](#dsc) |v1.30 | July 2019 | [Gitbook](https://edk2-docs.gitbo= ok.io/edk-ii-dsc-specification), [Github ](https://github.com/tianocore-doc= s/edk2-DscSpecification)| -|[FDF](#fdf) |v1.29 | March 2019 | [Gitbook](https://edk2-docs.git= book.io/edk-ii-fdf-specification), [Github ](https://github.com/tianocore-d= ocs/edk2-FdfSpecification)| -|[IDF](#idf) |v1.0 | April 2017 | [Gitbook](https://edk2-docs.gitbo= ok.io/edk-ii-idf-specification), [Github ](https://github.com/tianocore-doc= s/edk2-IdfSpecification/tree/release/1.00) | -|[INF](#inf) |v1.29 | July 2019 | [Gitbook](https://edk2-docs.gitb= ook.io/edk-ii-inf-specification), [Github ](https://github.com/tianocore-do= cs/edk2-InfSpecification) | -|[Meta-Data](#meta-data) | v1.30 | March 2018| [Gitbook](https://ed= k2-docs.gitbook.io/edk-ii-meta-data-expression-syntax-specification/), [Git= hub ](https://github.com/tianocore-docs/edk2-MetaDataExpressionSyntaxSpecif= ication/tree/release/1.30) | -|[PCD](#pcd) | v0.56 | April 2017 | [Gitbook](https://edk2-docs.gitbo= ok.io/edk-ii-pcd-specification), [Github ](https://github.com/tianocore-doc= s/edk2-PcdSpecification/tree/release/0.56) | -|[UNI](#uni) | v1.4 | May 2017 | [Gitbook](https://edk2-docs.gitbo= ok.io/edk-ii-uni-specification/), [Github ](https://github.com/tianocore-do= cs/edk2-UniSpecification/tree/release/1.40) | -|[VFR](#vfr) | v1.92 | April 2018 |[Gitbook](https://edk2-docs.gitboo= k.io/edk-ii-vfr-specification), [Github ](https://github.com/tianocore-docs= /edk2-VfrSpecification/tree/release/1.92) | -| [C Coding Standards](#c-coding-standards) | v 2.2 | June 2017 | [Gitbook= ](https://edk2-docs.gitbook.io/edk-ii-c-coding-standards-specification), [G= ithub ](https://github.com/tianocore-docs/edk2-CCodingStandardsSpecificatio= n/tree/release/2.20)| -|[Min-Platform](#Min-Platform) |v 0.7| May 2019 | [Gitbook](https://edk2-d= ocs.gitbook.io/edk-ii-minimum-platform-specification/), [Github ](https://g= ithub.com/tianocore-docs/edk2-MinimumPlatformSpecification) - - - - - - - - +|[Build](#build) |v1.28 | April 2018 | [HTML ](https://tianocore-doc= s.github.io/edk2-BuildSpecification/release-1.28/), [PDF ](https://tiano= core-docs.github.io/edk2-BuildSpecification/release-1.28/edk2-BuildSpecific= ation-release-1.28.pdf), [Mobi ](https://tianocore-docs.github.io/edk2-Bu= ildSpecification/release-1.28/edk2-BuildSpecification-release-1.28.mobi), [= ePub ](https://tianocore-docs.github.io/edk2-BuildSpecification/release-1= .28/edk2-BuildSpecification-release-1.28.epub), [Github ](https://github.co= m/tianocore-docs/edk2-BuildSpecification/tree/release/1.28) | +|[DEC](#dec) |v1.27 | April 2018 | [HTML ](https://tianocore-docs.= github.io/edk2-DecSpecification/release-1.27/), [PDF ](https://tianocore= -docs.github.io/edk2-DecSpecification/release-1.27/edk2-DecSpecification-re= lease-1.27.pdf), [Mobi ](https://tianocore-docs.github.io/edk2-DecSpecifi= cation/release-1.27/edk2-DecSpecification-release-1.27.mobi), [ePub ](htt= ps://tianocore-docs.github.io/edk2-DecSpecification/release-1.27/edk2-DecSp= ecification-release-1.27.epub), [Github ](https://github.com/tianocore-docs= /edk2-DecSpecification/tree/release/1.27) | +|[DSC](#dsc) |v1.28 | April 2018 | [HTML ](https://tianocore-docs= .github.io/edk2-DscSpecification/release-1.28/), [PDF ](https://tianocor= e-docs.github.io/edk2-DscSpecification/release-1.28/edk2-DscSpecification-r= elease-1.28.pdf), [Mobi ](https://tianocore-docs.github.io/edk2-DscSpecif= ication/release-1.28/edk2-DscSpecification-release-1.28.mobi), [ePub ](ht= tps://tianocore-docs.github.io/edk2-DscSpecification/release-1.28/edk2-DscS= pecification-release-1.28.epub), [Github ](https://github.com/tianocore-doc= s/edk2-DscSpecification/tree/release/1.28) | +|[FDF](#fdf) |v1.28.01 | June 2017 | [HTML ](https://tianocore-docs= .github.io/edk2-FdfSpecification/release-1.28.01/), [PDF ](https://tiano= core-docs.github.io/edk2-FdfSpecification/release-1.28.01/edk2-FdfSpecifica= tion-release-1.28.01.pdf), [Mobi ](https://tianocore-docs.github.io/edk2-= FdfSpecification/release-1.28.01/edk2-FdfSpecification-release-1.28.01.mobi= ), [ePub ](https://tianocore-docs.github.io/edk2-FdfSpecification/release= -1.28.01/edk2-FdfSpecification-release-1.28.01.epub), [Github ](https://git= hub.com/tianocore-docs/edk2-FdfSpecification/tree/release/1.28.01) | +|[IDF](#idf) |v1.0 | April 2017 | [HTML ](https://tianocore-docs.= github.io/edk2-IdfSpecification/release-1.00/), [PDF ](https://tianocore= -docs.github.io/edk2-IdfSpecification/release-1.00/edk2-IdfSpecification-re= lease-1.00.pdf), [Mobi ](https://tianocore-docs.github.io/edk2-IdfSpecifi= cation/release-1.00/edk2-IdfSpecification-release-1.00.mobi), [ePub ](htt= ps://tianocore-docs.github.io/edk2-IdfSpecification/release-1.00/edk2-IdfSp= ecification-release-1.00.epub), [Github ](https://github.com/tianocore-docs= /edk2-IdfSpecification/tree/release/1.00) | +|[INF](#inf) |v1.27 | April 2018 | [HTML ](https://tianocore-doc= s.github.io/edk2-InfSpecification/release-1.27/), [PDF ](https://tianoco= re-docs.github.io/edk2-InfSpecification/release-1.27/edk2-InfSpecification-= release-1.27.pdf), [Mobi ](https://tianocore-docs.github.io/edk2-InfSpeci= fication/release-1.27/edk2-InfSpecification-release-1.27.mobi), [ePub ](h= ttps://tianocore-docs.github.io/edk2-InfSpecification/release-1.27/edk2-Inf= Specification-release-1.27.epub), [Github ](https://github.com/tianocore-do= cs/edk2-InfSpecification/tree/release/1.27) | +|[Meta-Data](#meta-data) | v1.30 | March 2018 | [HTML ](https://ti= anocore-docs.github.io/edk2-MetaDataExpressionSyntaxSpecification/release-1= .30/), [PDF ](https://tianocore-docs.github.io/edk2-MetaDataExpressionSy= ntaxSpecification/release-1.30/edk2-MetaDataExpressionSyntaxSpecification-r= elease-1.30.pdf), [Mobi ](https://tianocore-docs.github.io/edk2-MetaDataE= xpressionSyntaxSpecification/release-1.30/edk2-MetaDataExpressionSyntaxSpec= ification-release-1.30.mobi), [ePub ](https://tianocore-docs.github.io/ed= k2-MetaDataExpressionSyntaxSpecification/release-1.30/edk2-MetaDataExpressi= onSyntaxSpecification-release-1.30.epub), [Github ](https://github.com/tian= ocore-docs/edk2-MetaDataExpressionSyntaxSpecification/tree/release/1.30) | +|[PCD](#pcd) | v0.56 | April 2017 | [HTML ](https://tianocore-docs.= github.io/edk2-PcdSpecification/release-0.56/), [PDF ](https://tianocore= -docs.github.io/edk2-PcdSpecification/release-0.56/edk2-PcdSpecification-re= lease-0.56.pdf), [Mobi ](https://tianocore-docs.github.io/edk2-PcdSpecifi= cation/release-0.56/edk2-PcdSpecification-release-0.56.mobi), [ePub ](htt= ps://tianocore-docs.github.io/edk2-PcdSpecification/release-0.56/edk2-PcdSp= ecification-release-0.56.epub), [Github ](https://github.com/tianocore-docs= /edk2-PcdSpecification/tree/release/0.56) | +|[UNI](#uni) | v1.4 | May 2017 | [HTML ](https://tianocore-docs.= github.io/edk2-UniSpecification/release-1.40/), [PDF ](https://tianocore= -docs.github.io/edk2-UniSpecification/release-1.40/edk2-UniSpecification-re= lease-1.40.pdf), [Mobi ](https://tianocore-docs.github.io/edk2-UniSpecifi= cation/release-1.40/edk2-UniSpecification-release-1.40.mobi), [ePub ](htt= ps://tianocore-docs.github.io/edk2-UniSpecification/release-1.40/edk2-UniSp= ecification-release-1.40.epub), [Github ](https://github.com/tianocore-docs= /edk2-UniSpecification/tree/release/1.40) | +|[VFR](#vfr) | v1.92 | April 2018 | [HTML ](https://tianocore-docs.= github.io/edk2-VfrSpecification/release-1.92/), [PDF ](https://tianocore= -docs.github.io/edk2-VfrSpecification/release-1.92/edk2-VfrSpecification-re= lease-1.92.pdf), [Mobi ](https://tianocore-docs.github.io/edk2-VfrSpecifi= cation/release-1.92/edk2-VfrSpecification-release-1.92.mobi), [ePub ](htt= ps://tianocore-docs.github.io/edk2-VfrSpecification/release-1.92/edk2-VfrSp= ecification-release-1.92.epub), [Github ](https://github.com/tianocore-docs= /edk2-VfrSpecification/tree/release/1.92) | +| [C Coding Standards](#c-coding-standards) | v 2.20 | June 2017 | [HTML = ](https://tianocore-docs.github.io/edk2-CCodingStandardsSpecification/rele= ase-2.20/), [PDF ](https://tianocore-docs.github.io/edk2-CCodingStandard= sSpecification/release-2.20/edk2-CCodingStandardsSpecification-release-2.20= .pdf), [Mobi ](https://tianocore-docs.github.io/edk2-CCodingStandardsSpec= ification/release-2.20/edk2-CCodingStandardsSpecification-release-2.20.mobi= ), [ePub ](https://tianocore-docs.github.io/edk2-CCodingStandardsSpecific= ation/release-2.20/edk2-CCodingStandardsSpecification-release-2.20.epub), [= Github ](https://github.com/tianocore-docs/edk2-CCodingStandardsSpecificati= on/tree/release/2.20) | +|[Min-Platform](#Min-Platform) |v 0.7| May 2019 | [HTML ](https://tianoc= ore-docs.github.io/edk2-MinimumPlatformSpecification/draft/), [PDF ](htt= ps://tianocore-docs.github.io/edk2-MinimumPlatformSpecification/draft/edk2-= MinimumPlatformSpecification-draft.pdf), [Mobi ](https://tianocore-docs.g= ithub.io/edk2-MinimumPlatformSpecification/draft/edk2-MinimumPlatformSpecif= ication-draft.mobi), [ePub ](https://tianocore-docs.github.io/edk2-Minimu= mPlatformSpecification/draft/edk2-MinimumPlatformSpecification-draft.epub),= [Github ](https://github.com/tianocore-docs/edk2-MinimumPlatformSpecificat= ion) | =20 --- =20 ## Build=20 -Build Specification -\[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-build-specification), -[GitHub ](https://github.com/tianocore-docs/edk2-BuildSpecification) -\] - This document describes the EDK II Build Architecture. This specifica= tion was designed to support new build requirements for building EDK II mod= ules and EDK components within the EDK II build infrastructure as well as t= o generate binary firmware images and Unified Extensible Firmware Image (UE= FI) applications. +Build Specification - This document describes the EDK II Build Architectur= e. This specification was designed to support new build requirements for bu= ilding EDK II modules and EDK components within the EDK II build infrastruc= ture as well as to generate binary firmware images and Unified Extensible F= irmware Image (UEFI) applications. =20 ## DEC -Declaration file format-\[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-dec-specification), -[GitHub ](https://github.com/tianocore-docs/edk2-DecSpecification) -\] - This document describes the EDK II Declaration (DEC) file format. Thi= s format was designed to support building packaging and distribution of EDK= II modules, as well as for building platforms and modules using the EDK II= build infrastructure. EDK II declaration files may be created during insta= llation of a distribution that follows the UEFI Platform Initialization Dis= tribution Package Specification. They may also be created manually. The EDK= II Build Infrastructure supports generation of UEFI 2.5 and PI 1.4 (Unifie= d EFI, Inc.) compliant binary images. +Declaration file format - This document describes the EDK II Declaration (= DEC) file format. This format was designed to support building packaging an= d distribution of EDK II modules, as well as for building platforms and mod= ules using the EDK II build infrastructure. EDK II declaration files may be= created during installation of a distribution that follows the UEFI Platfo= rm Initialization Distribution Package Specification. They may also be crea= ted manually. The EDK II Build Infrastructure supports generation of UEFI 2= .5 and PI 1.4 (Unified EFI, Inc.) compliant binary images. =20 ## DSC -Platform Description file format -\[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-dsc-specification/details), -[GitHub ](https://github.com/tianocore-docs/edk2-DscSpecification) -\] -This document describes the EDK II Platform Description file (DSC) for= mat. The EDK Build Tools are included as part of the EDK II compatibility p= ackage. In order to use EDK II Modules or the EDK II Build Tools, an EDK II= DSC and FDF file must be used. EDK II tools use INI style text based files= to describe components, platforms and firmware volumes. While similar to E= DK DSC files, the EDK II DSC file format is different, and new utilities ha= ve been provided to process these files. The EDK II Build Infrastructure su= pports creation of binary images that comply with Unified EFI (UEFI) 2.5 an= d UEFI Platform Infrastructure (PI) 1.4 specifications. +Platform Description file format - This document describes the EDK II Plat= form Description file (DSC) format. The EDK Build Tools are included as par= t of the EDK II compatibility package. In order to use EDK II Modules or th= e EDK II Build Tools, an EDK II DSC and FDF file must be used. EDK II tools= use INI style text based files to describe components, platforms and firmw= are volumes. While similar to EDK DSC files, the EDK II DSC file format is = different, and new utilities have been provided to process these files. The= EDK II Build Infrastructure supports creation of binary images that comply= with Unified EFI (UEFI) 2.5 and UEFI Platform Infrastructure (PI) 1.4 spec= ifications. =20 =20 ## FDF -Flash Description file format - \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-fdf-specification), -[GitHub ](https://github.com/tianocore-docs/edk2-FdfSpecification) -\] - This document describes the EDK II Flash Description (FDF) file forma= t. This format was designed to support new build requirements of building E= DK and EDK II modules within the EDK II build infrastructure. The EDK II Bu= ild Infrastructure supports generation of current Unified EFI, Inc. (UEFI 2= .5 and PI 1.4) compliant binary images. The FDF file is used to describe th= e content and layout of binary images. Binary images described in this file= may be any combination of boot images, capsule images or PCI Options ROMs. +Flash Description file format - This document describes the EDK II Flash D= escription (FDF) file format. This format was designed to support new build= requirements of building EDK and EDK II modules within the EDK II build in= frastructure. The EDK II Build Infrastructure supports generation of curren= t Unified EFI, Inc. (UEFI 2.5 and PI 1.4) compliant binary images. The FDF = file is used to describe the content and layout of binary images. Binary im= ages described in this file may be any combination of boot images, capsule = images or PCI Options ROMs. =20 ## IDF -Image Definition IDF File Format Specification - \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-idf-specification), -[GitHub ](https://github.com/tianocore-docs/edk2-IdfSpecification) -\] - -This document describes file format for Image Description files that are u= sed to create HII Image Packages introduced in the Unified Extensible Firmw= are Interface Specification, Version 2.1. +Image Definition IDF File Format Specification - This document describes f= ile format for Image Description files that are used to create HII Image Pa= ckages introduced in the Unified Extensible Firmware Interface Specificatio= n, Version 2.1. =20 ## INF -information file format - \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-inf-specification), -[GitHub ](https://github.com/tianocore-docs/edk2-InfSpecification) -\] - This document describes the EDK II build information (INF) file forma= t. This format supports the new build requirements of build EDK components = and EDK II modules within the EDK II build infrastructure. The EDK II Build= Infrastructure supports creation of binary images that comply with Unified= EFI (UEFI) 2.5 and UEFI Platform Infrastructure (PI) 1.4 specifications. +Information file format - This document describes the EDK II build informa= tion (INF) file format. This format supports the new build requirements of = build EDK components and EDK II modules within the EDK II build infrastruct= ure. The EDK II Build Infrastructure supports creation of binary images tha= t comply with Unified EFI (UEFI) 2.5 and UEFI Platform Infrastructure (PI) = 1.4 specifications. =20 ## Meta-Data -Meta-Data Expression Syntax Specification -\[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-meta-data-expression-syntax-= specification), -[GitHub ](https://github.com/tianocore-docs/edk2-MetaDataExpressionSyntaxS= pecification) -\] - This document describes the syntax of expression statements for EDK I= I Meta-data files used in data fields, feature flag expressions and conditi= onal directive statements. +Meta-Data Expression Syntax Specification - This document describes the sy= ntax of expression statements for EDK II Meta-data files used in data field= s, feature flag expressions and conditional directive statements. =20 ## PCD -EDK II PCD Specification -\[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-pcd-specification), -[GitHub ](https://github.com/tianocore-docs/edk2-PcdSpecification) -\] - This document discusses the mechanisms and configuration entries requ= ired to make it easy to write portable silicon modules and to port the Fram= ework from platform to platform. +EDK II PCD Specification - This document discusses the mechanisms and conf= iguration entries required to make it easy to write portable silicon module= s and to port the Framework from platform to platform. =20 =20 ## UNI -Unicode Format File Specification - \[ -[Gitbook](https://edk2-docs.gitbook.io/edk2-docs/edk-ii-uni-specification), -[GitHub ](https://github.com/tianocore-docs/edk2-UniSpecification) -\] - This document describes the Multi-String build information (UNI) file= format . See details in the Revision History in the document for more deta= ils. +Unicode Format File Specification - This document describes the Multi-Stri= ng build information (UNI) file format . See details in the Revision Histor= y in the document for more details. =20 ## VFR -Visual Form Representation Specification -\[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-vfr-specification), -[GitHub ](https://github.com/tianocore-docs/edk2-VfrSpecification) -\] - To simplify the creation of Internal Forms Representation (IFR), a hi= gh-level Visual Forms Representation (VFR) language is described in this do= cument. Using this language syntax, a compiler can be designed to take an o= rdinary text file containing VFR as an input, and output IFR for use in a u= ser=E2=80=99s program. There are various methods to define the VFR language. +Visual Form Representation Specification - To simplify the creation of Int= ernal Forms Representation (IFR), a high-level Visual Forms Representation = (VFR) language is described in this document. Using this language syntax, a= compiler can be designed to take an ordinary text file containing VFR as a= n input, and output IFR for use in a user=E2=80=99s program. There are vari= ous methods to define the VFR language. =20 =20 ## C Coding Standards -EDK II C Coding Standards Specification - \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-c-coding-standards-specifica= tion), -[GitHub ](https://github.com/tianocore-docs/edk2-CCodingStandardsSpecifica= tion) -\] - The EDK II C Coding Standards Specification establishes a set of rule= s intended not as +EDK II C Coding Standards Specification - The EDK II C Coding Standards Sp= ecification establishes a set of rules intended not as a constraint, but as an enabling philosophy which will: * Establish uniformity of style. * Set minimum information content requirements. @@ -116,17 +75,13 @@ a constraint, but as an enabling philosophy which will: These rules apply to all code developed. =20 ## Min-Platform -EDK II Minimum Platform Specification -\[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-minimum-platform-specificati= on/), [Github ](https://github.com/tianocore-docs/edk2-MinimumPlatformSpeci= fication)\] - - -This specification details the required and optional elements for an EDK II -based platform design with the following objectives:
+EDK II Minimum Platform Specification - This specification details the req= uired and optional elements for an EDK II +based platform design with the following objectives: 1. Define a structure that enables developers to consistently navigate sou= rce code, execution flow, and the functional results of bootstrapping a sys= tem. 2. Enable a minimal platform where minimal is defined as the minimal firmw= are implementation required to produce a basic solution that can be further= extended to meet a multitude of client, server, and embedded market needs. 3. Minimize coupling between common, silicon, platform, and board packages. 4. Enable large granularity binary solutions. -
+ A key aspect of these objectives is to improve the transparency and securi= ty quality across the client, server, and embedded ecosystems. =20 @@ -134,7 +89,9 @@ quality across the client, server, and embedded ecosyste= ms. --- =20 * **_EDK II Template Specification_** \[ -[Gitbook](https://edk2-docs.gitbook.io/edk-ii-template-specification), +[HTML ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draf= t/), +[PDF ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draf= t/edk2-TemplateSpecification-draft.pdf), +[MOBI ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draf= t/edk2-TemplateSpecification-draft.mobi), +[EPUB ](https://tianocore-docs.github.io/edk2-TemplateSpecification/draf= t/edk2-TemplateSpecification-draft.epub), [GitHub ](https://github.com/tianocore-docs/edk2-TemplateSpecification) \] This document is a template that can be copied to start a new Tianocore= Gitbook document. It also provides examples for styles and formats commonl= y found in Tianocore specifications. - diff --git a/EDK-II-User-Documentation.mediawiki b/EDK-II-User-Documentatio= n.mediawiki index 8682930..8da7918 100644 --- a/EDK-II-User-Documentation.mediawiki +++ b/EDK-II-User-Documentation.mediawiki @@ -53,7 +53,10 @@ NOTE SVNs: For Nt32Pkg requires -r13186, For OVMF Requir= es -r13160 beyond UDK201 =20 -[https://edk2-docs.gitbook.io/edk-ii-uefi-driver-writer-s-guide gitbook] +[https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft/ HTML] +[https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft/edk2-U= efiDriverWritersGuide-draft.pdf PDF] +[https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft/edk2-U= efiDriverWritersGuide-draft.mobi MOBI] +[https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft/edk2-U= efiDriverWritersGuide-draft.epub EPUB] =20 diff --git a/EDK-II-white-papers.mediawiki b/EDK-II-white-papers.mediawiki index d6c392e..f127aa4 100644 --- a/EDK-II-white-papers.mediawiki +++ b/EDK-II-white-papers.mediawiki @@ -36,18 +36,20 @@ We can remove many unnecessary silicon or platform feat= ures like Capsule update, =20 -[https://edk2-docs.gitbook.io/a-tour-beyond-bios-mitigate-buffer-overflow-= in-ue Gitbook] - +[https://tianocore-docs.github.io/ATBB-Mitigate_Buffer_Overflow_in_UEFI/dr= aft/ HTML] +[https://tianocore-docs.github.io/ATBB-Mitigate_Buffer_Overflow_in_UEFI/dr= aft/ATBB-Mitigate_Buffer_Overflow_in_UEFI-draft.pdf PDF] +[https://tianocore-docs.github.io/ATBB-Mitigate_Buffer_Overflow_in_UEFI/dr= aft/ATBB-Mitigate_Buffer_Overflow_in_UEFI-draft.mobi MOBI] +[https://tianocore-docs.github.io/ATBB-Mitigate_Buffer_Overflow_in_UEFI/dr= aft/ATBB-Mitigate_Buffer_Overflow_in_UEFI-draft.epub EPUB] =20 -[https://edk2-docs.gitbook.io/a-tour-beyond-bios-mitigate-buffer-overflow-= in-ue A Tour Beyond BIOS- Security Enhancement to Mitigate Buffer Overflow = in UEFI ] +[https://tianocore-docs.github.io/ATBB-Mitigate_Buffer_Overflow_in_UEFI/dr= aft/ A Tour Beyond BIOS- Security Enhancement to Mitigate Buffer Overflow i= n UEFI ] contributed by Jiewen Yao, Vincent Zimmer and Jian Wang
=20 =20 A buffer overflow is =E2=80=9Cone of the most important exploitation techn= iques in the history of computer security.=E2=80=9D [ [https://www.amazon.c= om/s/ref=3Ddp_byline_sr_book_1?ie=3DUTF8&field-author=3DAndrew+S.+Tanenbaum= &search-alias=3Dbooks&text=3DAndrew+S.+Tanenbaum&sort=3Drelevancerank Tanen= baum] ] =E2=80=9CBuffer overflows are ideally suited for introducing three = of the most important protection mechanisms available in most modern system= s: stack canaries, data execution protection, and address-space layout rand= omization.=E2=80=9D[ [https://www.amazon.com/s/ref=3Ddp_byline_sr_book_1?ie= =3DUTF8&field-author=3DAndrew+S.+Tanenbaum&search-alias=3Dbooks&text=3DAndr= ew+S.+Tanenbaum&sort=3Drelevancerank Tanenbaum] ] However, the current UEFI= firmware implementation only adopted a few of these mechanisms.
This paper will introduce how to enable the protection mechanisms in UEFI = firmware to harden the pre-boot phase. -* March 2018 [https://edk2-docs.gitbook.io/a-tour-beyond-bios-mitigate-buf= fer-overflow-in-ue V 2.0 Gitbook] +* March 2018 [https://tianocore-docs.github.io/ATBB-Mitigate_Buffer_Overfl= ow_in_UEFI/draft/ V 2.0 HTML] * October 2016 [https://github.com/tianocore-docs/Docs/raw/master/White_Pa= pers/A_Tour_Beyond_BIOS_Securiy_Enhancement_to_Mitigate_Buffer_Overflow_in_= UEFI.pdf V 1.0 PDF] =20 @@ -55,12 +57,13 @@ This paper will introduce how to enable the protection = mechanisms in UEFI firmwa =20 -[https://www.gitbook.com/book/edk2-docs/getting-started-guide-of-edk-ii-ht= tp-boot/details GitBook PDF] - - +[https://tianocore-docs.github.io/EDKIIHttpBootGettingStartedGuide/draft/ = HTML] +[https://tianocore-docs.github.io/EDKIIHttpBootGettingStartedGuide/draft/E= DKIIHttpBootGettingStartedGuide-draft.pdf PDF] +[https://tianocore-docs.github.io/EDKIIHttpBootGettingStartedGuide/draft/E= DKIIHttpBootGettingStartedGuide-draft.mobi MOBI] +[https://tianocore-docs.github.io/EDKIIHttpBootGettingStartedGuide/draft/E= DKIIHttpBootGettingStartedGuide-draft.epub EPUB] -[https://edk2-docs.gitbook.io/getting-started-guide-of-edk-ii-http-boot ED= K II HTTP Boot Getting Started Guide]- contributed by Ye Ting, Fu Siyuan, a= nd Zhang Lubo +[https://tianocore-docs.github.io/EDKIIHttpBootGettingStartedGuide/draft/ = EDK II HTTP Boot Getting Started Guide]- contributed by Ye Ting, Fu Siyuan,= and Zhang Lubo
This document is a getting started guide for using the HTTP boot capabilit= y introduced in the UEFI Specification, revision 2.5. * January 2018 Rev 0.9 @@ -69,12 +72,15 @@ This document is a getting started guide for using the = HTTP boot capability intr -[https://edk2-docs.gitbook.io/getting-started-with-uefi-https-boot-on-edk-= ii Gitbook PDF] +[https://tianocore-docs.github.io/EDKIIHttpsBootGettingStartedGuide/draft/= HTML] +[https://tianocore-docs.github.io/EDKIIHttpsBootGettingStartedGuide/draft/= EDKIIHttpsBootGettingStartedGuide-draft.pdf PDF] +[https://tianocore-docs.github.io/EDKIIHttpsBootGettingStartedGuide/draft/= EDKIIHttpsBootGettingStartedGuide-draft.mobi MOBI] +[https://tianocore-docs.github.io/EDKIIHttpsBootGettingStartedGuide/draft/= EDKIIHttpsBootGettingStartedGuide-draft.epub EPUB] -[https://edk2-docs.gitbook.io/getting-started-with-uefi-https-boot-on-edk-= ii Getting Started with UEFI HTTPS Boot on EDK II] contributed by Wu Jiaxin= , Fu Siyuan and Brian Richardson
+[https://tianocore-docs.github.io/EDKIIHttpsBootGettingStartedGuide/draft/= Getting Started with UEFI HTTPS Boot on EDK II] contributed by Wu Jiaxin, = Fu Siyuan and Brian Richardson
HTTP over TLS (HTTPS) boot is a standard implementation for securely booti= ng using the Unified Extensible Firmware Interface (UEFI) over a network de= vice. HTTPS Boot is especially important for clients using potentially inse= cure networks outside of corporate infrastructure. Security for UEFI HTTPS = Boot is provided by the underlying Transport Layer Security (TLS).=20 -This paper assumes the reader is familiar with the https://edk2-docs.gitbo= ok.io/getting-started-guide-of-edk-ii-http-boot EDK II HTTP Boot Getting St= arted Guide] +This paper assumes the reader is familiar with the [https://tianocore-docs= .github.io/EDKIIHttpBootGettingStartedGuide/draft/ EDK II HTTP Boot Getting= Started Guide] available on this page.
=20 diff --git a/HTTP-Boot.md b/HTTP-Boot.md index 337fe7e..eea9f0d 100644 --- a/HTTP-Boot.md +++ b/HTTP-Boot.md @@ -4,7 +4,7 @@ For a detailed description on UEFI HTTP Boot, see the "HTTP= Boot" section of the =20 ## HTTP Boot: Getting Started =20 -Please refer to the white paper [EDK II HTTP Boot Getting Started Guide](h= ttps://edk2-docs.gitbook.io/getting-started-guide-of-edk-ii-http-boot) for = a step by step guide of the HTTP Boot enabling and server configuration in = **corporate environment**. +Please refer to the white paper [EDK II HTTP Boot Getting Started Guide](h= ttps://tianocore-docs.github.io/EDKIIHttpBootGettingStartedGuide/draft/) fo= r a step by step guide of the HTTP Boot enabling and server configuration i= n **corporate environment**. =20 ## Vendor Documentation and Conference Presentations =20 diff --git a/HTTPS-Boot.md b/HTTPS-Boot.md index 847af98..e779453 100644 --- a/HTTPS-Boot.md +++ b/HTTPS-Boot.md @@ -4,7 +4,7 @@ The security of HTTPS boot is that of the underlying Transp= ort Layer Security (T =20 ## HTTPS Boot Getting Started =20 -Please refer to the [EDK II HTTPS Boot Getting Started Guide](https://edk2= -docs.gitbook.io/getting-started-with-uefi-https-boot-on-edk-ii) for a step= by step guide of the HTTPS Boot enabling and HTTPS server configuration. +Please refer to the [EDK II HTTPS Boot Getting Started Guide](https://tian= ocore-docs.github.io/EDKIIHttpsBootGettingStartedGuide/draft/) for a step b= y step guide of the HTTPS Boot enabling and HTTPS server configuration. =20 ## HTTPS Boot Authentication =20 diff --git a/How-To-Contribute.mediawiki b/How-To-Contribute.mediawiki index 36ce332..05852e7 100644 --- a/How-To-Contribute.mediawiki +++ b/How-To-Contribute.mediawiki @@ -11,7 +11,7 @@ If you are a developer, and would like to make [[Code Con= tributions]] to our com * Review our [[Member Types]] which documents requirements for contributin= g code * Review our [[Tasks]] page which documents some open projects * Review our [[Code Style]] page which documents coding styles and commit = log styles -* Review our secure coding documents [https://edk2-docs.gitbook.io/edk-ii-= secure-coding-guide] [https://edk2-docs.gitbook.io/edk-ii-secure-code-revie= w-guide] prior to sumbmitting a patch, along with creating a unit test and = performing some static analysis +* Review our secure coding documents [https://tianocore-docs.github.io/EDK= _II_Secure_Coding_Guide/draft/] [https://tianocore-docs.github.io/EDK_II_Se= cure_Code_Review_Guide/draft/] prior to sumbmitting a patch, along with cre= ating a unit test and performing some static analysis * Recommend following some of the practices at [https://google.github.io/e= ng-practices/review/reviewer/] * Do not post a patch to an unmitigated security issue. Instead follow gui= delines at [https://github.com/tianocore/tianocore.github.io/wiki/Reporting= -Security-Issues]=20 * If a proposed set of patches also requires a change to [[UEFI]] or other= industry standard specifications, then use the [[EDK II Code First Process= ]]. diff --git a/Kaby-Lake-MinPlatform.md b/Kaby-Lake-MinPlatform.md index 9adb324..cf22ace 100644 --- a/Kaby-Lake-MinPlatform.md +++ b/Kaby-Lake-MinPlatform.md @@ -7,4 +7,4 @@ This tree follows a "minimum platform" philosophy, providing boot to a UEF= I compliant operating system using the minimum number of EDK II modules. Th= e project uses the [Intel=C2=AE Firmware Support Package (Intel=C2=AE FSP)]= (https://github.com/IntelFsp/FSP/tree/master/KabylakeFspBinPkg) for platfor= m silicon initialization. =20 [Minimum Platform Readme File](https://github.com/tianocore/edk2-platforms= /blob/master/Platform/Intel/Readme.md) -[Minimum Platform Specification](https://edk2-docs.gitbooks.io/edk-ii-mini= mum-platform-specification/content/) +[Minimum Platform Specification](https://tianocore-docs.github.io/edk2-Min= imumPlatformSpecification/draft/) diff --git a/Minimum-Platform-Architecture--MinPlatform.md b/Minimum-Platfo= rm-Architecture--MinPlatform.md index 5e6d75f..f8a5796 100644 --- a/Minimum-Platform-Architecture--MinPlatform.md +++ b/Minimum-Platform-Architecture--MinPlatform.md @@ -15,5 +15,5 @@ The main MinPlatform Package ([MinPlatformPkg](https://gi= thub.com/tianocore/edk2 =20 #### Resources - [Open Source Firmware Conference (OSFC)](https://osfc.io/) Presentation = on [Minimum Platform Architecture (Sept 2019)](https://software.intel.com/s= ites/default/files/Open%20Source%20UEFI%20Firmware%20for%20Intel%20Platform= s.pdf) -- [EDK II Minimum Platform Architecture Specification](https://edk2-docs.g= itbooks.io/edk-ii-minimum-platform-specification/content/) +- [EDK II Minimum Platform Architecture Specification](https://tianocore-d= ocs.github.io/edk2-MinimumPlatformSpecification/draft/) - [A Tour Beyond BIOS Open Source IA Firmware Platform Design Guide in EDK= II (v 2)](https://github.com/tianocore/edk2-platforms/blob/master/Platform= /Intel/MinPlatformPkg/Docs/A_Tour_Beyond_BIOS_Open_Source_IA_Firmware_Platf= orm_Design_Guide_in_EFI_Developer_Kit_II%20-%20V2.pdf) diff --git a/UEFI-Driver-Writer's-Guide.md b/UEFI-Driver-Writer's-Guide.md index e7eca18..b7454b4 100644 --- a/UEFI-Driver-Writer's-Guide.md +++ b/UEFI-Driver-Writer's-Guide.md @@ -4,6 +4,11 @@ This document is provided to help developers prepare UEFI = drivers using the [[ED =20 ## Versions =20 -As of April 2018, the UEFI Driver Writer's Guide is available in gitbook f= ormat. +As of April 2018, the UEFI Driver Writer's Guide is available in the follo= wing formats. + +* [HTML](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draf= t/) +* [PDF](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draft= /edk2-UefiDriverWritersGuide-draft.pdf) +* [MOBI](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draf= t/edk2-UefiDriverWritersGuide-draft.mobi) +* [EPUB](https://tianocore-docs.github.io/edk2-UefiDriverWritersGuide/draf= t/edk2-UefiDriverWritersGuide-draft.epub) + =20 -https://edk2-docs.gitbooks.io/edk-ii-uefi-driver-writer-s-guide/ diff --git a/Whiskey-Lake-MinPlatform.md b/Whiskey-Lake-MinPlatform.md index 385466f..29ce133 100644 --- a/Whiskey-Lake-MinPlatform.md +++ b/Whiskey-Lake-MinPlatform.md @@ -7,4 +7,4 @@ This tree follows a "minimum platform" philosophy, providing boot to a UEF= I compliant operating system using the minimum number of EDK II modules. Th= e project uses the [Intel=C2=AE Firmware Support Package (Intel=C2=AE FSP)]= (https://github.com/IntelFsp/FSP/tree/master/CoffeeLakeFspBinPkg) for platf= orm silicon initialization. =20 [Minimum Platform Readme File](https://github.com/tianocore/edk2-platforms= /blob/master/Platform/Intel/Readme.md) -[Minimum Platform Specification](https://edk2-docs.gitbooks.io/edk-ii-mini= mum-platform-specification/content/) +[Minimum Platform Specification](https://tianocore-docs.github.io/edk2-Min= imumPlatformSpecification/draft/) --=20 2.29.2.windows.2 -=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 (#68197): https://edk2.groups.io/g/devel/message/68197 Mute This Topic: https://groups.io/mt/78667902/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-