Add Rust documentation (#175)

Adds documents that explain: - How to build with Rust in Project Mu - Documentation conventions for Rust code in Project Mu - Motivation to adopt Rust in Project Mu Signed-off-by: Michael Kubacki <[email protected]>
microsoft · Sep 1, 2023 · 69515fe · 69515fe
1 parent 206a7c5
commit 69515fe
Show file tree

Hide file tree

Showing 5 changed files with 745 additions and 110 deletions.
diff --git a/cspell.json b/cspell.json
@@ -16,137 +16,150 @@
     ],
     // words - list of words to be always considered correct - use dictionary for all words
     "words": [
-        "uefi",
-        "tiano",
-        "ibv",
-        "ibvs",
-        "oem",
-        "oems",
+        "AARCH",
         "ACPI",
-        "MSRC",
-        "tianocore",
+        "acpica",
+        "afile",
+        "asl",
+        "ASLR",
+        "azurepipelines",
+        "backported",
+        "basecore",
+        "basetools",
+        "bootable",
+        "bootstrapper",
+        "brotli",
+        "buildid",
+        "buildreport",
+        "buildreporting",
+        "buildsha",
+        "buildtime",
+        "buildtools",
+        "certfile",
+        "certreq",
+        "cleanonly",
+        "cmocka",
+        "codebases",
+        "commitlink",
+        "componentization",
+        "corebuild",
+        "customizations",
+        "datacenter",
+        "debuggability",
+        "depex",
+        "DFCI",
+        "Donath",
         "doxygen",
-        "nvme",
-        "esrt",
-        "Infineon",
-        "pbkdf",
-        "EdkII",
         "Edk2",
-        "pkcs",
-        "guids",
-        "guid",
-        "uuid",
-        "uuids",
+        "EdkII",
+        "efiapi",
         "eku",
         "ekus",
-        "memmap",
-        "whitepaper",
-        "pcr",
-        "pcrs",
-        "pcd",
-        "pcds",
-        "DFCI",
-        "linaro",
-        "nuget",
+        "emojione",
+        "enablement",
+        "esrt",
+        "extdep",
+        "fdsizereport",
+        "flake8",
+        "Franceschetti",
+        "genrsa",
+        "gitattributes",
+        "gitignore",
+        "gitmodules",
+        "guid",
+        "guidgen",
+        "guids",
+        "howto",
         "iasl",
-        "asl",
-        "brotli",
-        "nasm",
-        "acpica",
-        "VSTS",
-        "commitlink",
-        "efiapi",
+        "ibv",
+        "ibvs",
         "inf",
+        "Infineon",
         "infs",
-        "openssl",
-        "redfish",
-        "muchange",
-        "guidgen",
-        "certreq",
-        "datacenter",
-        "bootable",
-        "mkdir",
-        "newcerts",
+        "inkey",
+        "jinja",
         "keyfile",
-        "privkey",
         "keyid",
-        "genrsa",
-        "outform",
-        "inkey",
-        "smime",
-        "certfile",
-        "afile",
-        "OVERRIDELOG",
-        "buildid",
-        "buildreporting",
-        "buildreport",
-        "fdsizereport",
-        "ndisasm",
-        "basetools",
-        "overrider",
-        "buildsha",
-        "corebuild",
+        "linaro",
         "lzturbo",
-        "depex",
-        "skippostbuild",
-        "cleanonly",
-        "skipbuild",
-        "skipprebuild",
+        "lzturbo",
+        "markdownlint",
         "mathlib",
-        "norestart",
-        "nocache",
-        "buildtools",
-        "bootstrapper",
+        "memmap",
+        "microcontrollers",
+        "mkdir",
         "mkdocs",
-        "gitignore",
-        "gitmodules",
-        "gitattributes",
-        "pymdown",
-        "repo",
-        "repos",
-        "basecore",
-        "submodules",
-        "submodule",
-        "howto",
         "mscore",
-        "signtool",
-        "emojione",
+        "MSRC",
+        "msvc",
+        "muchange",
+        "nasm",
+        "ndisasm",
+        "newcerts",
+        "nocache",
+        "norestart",
+        "nuget",
+        "nvme",
+        "oem",
+        "oems",
+        "omnicache",
         "opencode",
-        "buildtime",
-        "componentization",
-        "customizations",
-        "enablement",
+        "openssl",
+        "outform",
+        "OVERRIDELOG",
+        "overrider",
+        "ovmf",
+        "pbkdf",
+        "pcd",
+        "pcds",
+        "pcr",
+        "pcrs",
+        "pip",
+        "pkcs",
         "pluggable",
-        "upstreams",
-        "upstream",
+        "privkey",
         "projectmu",
-        "jinja",
-        "lzturbo",
-        "rebased",
-        "backported",
+        "pymdown",
         "pytest",
-        "pip",
-        "flake8",
-        "workspaces",
-        "venv",
-        "omnicache",
-        "roadmap",
-        "roadmaps",
-        "wdksetup",
-        "cmocka",
-        "toolchains",
-        "toolchain",
-        "ovmf",
         "pytool",
         "pytools",
+        "rebased",
+        "redfish",
+        "repo",
+        "repos",
+        "rlib",
+        "roadmap",
+        "roadmaps",
+        "rustfmt",
+        "rustup",
+        "signtool",
+        "skipbuild",
+        "skippostbuild",
+        "skipprebuild",
+        "smime",
+        "staticlib",
+        "struct",
+        "structs",
+        "submodule",
+        "submodules",
         "superfences",
-        "markdownlint",
+        "TCMORPH",
+        "tiano",
+        "tianocore",
+        "timeframe",
+        "toolchain",
+        "toolchains",
+        "uefi",
         "UINTN",
-        "azurepipelines",
-        // Names and Attributions
-        "Franceschetti",
-        "Donath",
-        "extdep",
-        "TCMORPH"
+        "upstream",
+        "upstreams",
+        "usize",
+        "uuid",
+        "uuids",
+        "venv",
+        "VSTS",
+        "wdksetup",
+        "whitepaper",
+        "workspaces"
     ]
 }