Skip to content

Latest commit

 

History

History
191 lines (136 loc) · 8.26 KB

Readme.rst

File metadata and controls

191 lines (136 loc) · 8.26 KB
Raw

Project Mu IPMI Feature Repository

Host Type & Toolchain Build Status Test Status Code Coverage
Windows_VS WindowsCiBuild WindowsCiTest WindowsCiCoverage
Ubuntu_GCC5 UbuntuCiBuild UbuntuCiTest UbuntuCiCoverage

This repository is part of Project Mu. Please see Project Mu for details.

This IPMI feature repo contains the generic IPMI code from TianoCore's edk2-platforms repo which has been refactored to support more general use and with added functionality.

Detailed Feature Information

Far more details about using this repo can be found in: IPMI Feature Package Readme.

Repository Philosophy

Unlike other Project MU repositories, the IPMI feature repo does not strictly follow the EDKII releases, but rather has a continuous main branch which will periodically receive cherry-picks of needed changes from EDKII. For stable builds, release tags will be used instead to determine commit hashes at stable points in development. Release branches may be created as needed to facilitate a specific release with needed features, but this should be avoided.

Consuming the IPMI Feature Package

Since this project does not follow the release fork model, the code should be consumed from a release hash and should be consumed as a extdep in the platform repo. To include, create a file named feature_ipmi_ext_dep.json desired release tag hash. This could be in the root of the project or in a subdirectory as desired.

{

"scope": "global",

"type": "web",

"name": "mu-feature-ipmi",

"source": "https://github.com/microsoft/mu_feature_ipmi/archive/refs/tags/0.1.0.zip",

"version": "0.1.0",

"internal_path": "/mu_feature_ipmi-0.1.0/",

"sha256": "2d541735195fbef2bca07ae06391bfaf08db0cb8aeb780f0029f907d1943e595",

"compression_type": "zip",

"flags": ["set_build_var"],

"var_name": "IPMI_FEATURE_PATH"

}

Setting the the var_name and the set_build_var flags will allow the build scripts to reference the extdep location. To make sure that the package is discoverable for the build, the following line should also be added to the build configurations GetPackagesPath list.

shell_environment.GetBuildVars().GetValue("IPMI_FEATURE_PATH", "")

After this the package should be discoverable to can be used in the build like any other dependency.

Releases Versions

Releases of this repository will follow the Nuget versioning model. This will directly correspond to the version of the associated nuget package.

More Info

Please see the Project Mu docs for more information.

This project has adopted the Microsoft Open Source Code of Conduct.

For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Issues

Please open any issues in the Project Mu GitHub tracker. More Details

Contributing Code or Docs

Please follow the general Project Mu Pull Request process. More Details

Builds

Please follow the steps in the Project Mu docs to build for CI and local testing. More Details

Copyright & License

Copyright (C) Microsoft Corporation SPDX-License-Identifier: BSD-2-Clause-Patent

Upstream License (TianoCore)

Copyright (c) 2019, TianoCore and contributors. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Subject to the terms and conditions of this license, each copyright holder and contributor hereby grants to those receiving rights under this license a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except for failure to satisfy the conditions of this license) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer this software, where such license applies only to those patent claims, already acquired or hereafter acquired, licensable by such copyright holder or contributor that are necessarily infringed by:

  1. their Contribution(s) (the licensed copyrights of copyright holders and non-copyrightable additions of contributors, in source or binary form) alone; or
  2. combination of their Contribution(s) with the work of authorship to which such Contribution(s) was added by such copyright holder or contributor, if, at the time the Contribution is added, such addition causes such combination to be necessarily infringed. The patent license shall not apply to any other combinations which include the Contribution.

Except as expressly stated above, no rights or licenses from any copyright holder or contributor is granted under this license, whether expressly, by implication, estoppel or otherwise.

DISCLAIMER

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.