From 223299a029c6c1769fc4dd87252609f79d6ac9c7 Mon Sep 17 00:00:00 2001 From: Sean Brogan Date: Wed, 19 Dec 2018 20:18:28 -0800 Subject: [PATCH] Add code dev overview page and make a few minor updates. (#51) --- docs/CodeDevelopment/overview.md | 19 ++++++++++++++++++- docs/CodeDevelopment/requirements.md | 2 ++ docs/CodeDevelopment/test.md | 2 +- docs/DeveloperDocs/build_community_docs.md | 1 + docs/How/downstream_integration.md | 5 ----- docs/How/upstream_integration.md | 3 --- mkdocs_base.yml | 2 -- 7 files changed, 22 insertions(+), 12 deletions(-) delete mode 100644 docs/How/downstream_integration.md delete mode 100644 docs/How/upstream_integration.md diff --git a/docs/CodeDevelopment/overview.md b/docs/CodeDevelopment/overview.md index 5c0990f52..8b024dcc1 100644 --- a/docs/CodeDevelopment/overview.md +++ b/docs/CodeDevelopment/overview.md @@ -1,4 +1,21 @@ # Code Development Overview -*Todo* +## Tools +First you will need to setup your UEFI development environment. Project Mu leverages most of the tools from _TianoCore EDK2_. We have streamlined the process for the tool chains and systems we use but our project's goals are to support various tool chains and development environments. For the best experience or for those new to UEFI and Project Mu we have provided guidance in our [prerequisites](/CodeDevelopment/prerequisites) page. + +## Code + +Next you will need to clone a repository or set of repositories to work on. + +For __core__ work (Project Mu Repos) you can clone the desired repo, make your changes, run CI builds, run your tests, and submit a PR. + +For __platform__ work (outside of Project Mu) you will need to clone the platform repository and then follow the platform setup process. + +See details on the [compile](/CodeDevelopment/compile) page for more information about CI builds and how to compile a package or platform. + +Code should follow best practices. We are working to add some best practices on the [requirements](/CodeDevelopment/requirements) page. We also attempt to enforce these best practices thru our CI build process. + +## Tests + +One area of focus for Project Mu is on testing. Firmware testing has traditionally been hard and very manual. We hope to describe techniques and provide resources to make this easier and more automated. Testing needs to be part of the code development process. Check out the [testing](/CodeDevelopment/test) page for more details. \ No newline at end of file diff --git a/docs/CodeDevelopment/requirements.md b/docs/CodeDevelopment/requirements.md index 60792f6cb..9922f0445 100644 --- a/docs/CodeDevelopment/requirements.md +++ b/docs/CodeDevelopment/requirements.md @@ -39,4 +39,6 @@ 2. Use STATIC on each non-public function and non-public global to avoid conflicts with other modules. 3. Use EFIAPI on all public library class functions. +## More info +For general Edk2 and UEFI development additional information can be found at the [TianoCore.org](https://www.tianocore.org/) website. \ No newline at end of file diff --git a/docs/CodeDevelopment/test.md b/docs/CodeDevelopment/test.md index ccf224d9c..db4eafa39 100644 --- a/docs/CodeDevelopment/test.md +++ b/docs/CodeDevelopment/test.md @@ -1,6 +1,6 @@ # Tests -Testing firmware is hard. Lets just stop there. :poop: If you want to read on please do at your own risk. Project Mu supports a few types of testing and this page will help provide some high level info and links for more information. +Testing firmware is hard. Lets just stop there. :sob: If you want to read on please do at your own risk. Project Mu supports a few types of testing and this page will help provide some high level info and links for more information. ## Static Code Tests (analysis) diff --git a/docs/DeveloperDocs/build_community_docs.md b/docs/DeveloperDocs/build_community_docs.md index b88a48c23..06b8473ef 100644 --- a/docs/DeveloperDocs/build_community_docs.md +++ b/docs/DeveloperDocs/build_community_docs.md @@ -7,6 +7,7 @@ ## Get the docs repository First, you need to clone the project mu docs repository. + ``` cmd git clone https://github.com/Microsoft/mu.git ``` diff --git a/docs/How/downstream_integration.md b/docs/How/downstream_integration.md deleted file mode 100644 index d9b862d7d..000000000 --- a/docs/How/downstream_integration.md +++ /dev/null @@ -1,5 +0,0 @@ -# Downstream Project Integration - -Describe successful patterns for integrating downstream for Common, Silicon, and Platform layers. -Describe impacts of rebase process -Describe how to report back integration status and errors (automation) \ No newline at end of file diff --git a/docs/How/upstream_integration.md b/docs/How/upstream_integration.md deleted file mode 100644 index 796011ef1..000000000 --- a/docs/How/upstream_integration.md +++ /dev/null @@ -1,3 +0,0 @@ -# Upstream Integration - -## Tianocore integration diff --git a/mkdocs_base.yml b/mkdocs_base.yml index 8d12c14dd..335965e20 100644 --- a/mkdocs_base.yml +++ b/mkdocs_base.yml @@ -51,9 +51,7 @@ nav: - External Resources: 'Where/external_resources.md' - How: - Release Process: 'How/release_process.md' - - Downstream Integration: 'How/downstream_integration.md' - Contributing: 'How/contributing.md' - - Upstream Integration: 'How/upstream_integration.md' - Developing Docs: - Overview: "DeveloperDocs/developer_docs.md" - How To Build: "DeveloperDocs/build_community_docs.md"