diff options
author | Patrick Venture <venture@google.com> | 2019-03-13 03:32:50 +0300 |
---|---|---|
committer | Andrew Geissler <geissonator@yahoo.com> | 2019-03-13 15:37:11 +0300 |
commit | 602b38aeb523c5ddbfa672be19ef14ed132885e5 (patch) | |
tree | dea2c65b2e51247d57f527de4fe052c537488761 /meta-google/README | |
parent | 925bbd05851909b3ec5af58572c0b3aad4b85f84 (diff) | |
download | openbmc-602b38aeb523c5ddbfa672be19ef14ed132885e5.tar.xz |
meta-google: rework README to be non-markdown
Rework the README to not use markdown.
(From meta-google rev: e95ffa4345393be4ea00f05060f51f2a6af3833b)
Change-Id: Ie4b25a0af5817358ab48d184cc358bce262521a3
Signed-off-by: Patrick Venture <venture@google.com>
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Diffstat (limited to 'meta-google/README')
-rw-r--r-- | meta-google/README | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/meta-google/README b/meta-google/README new file mode 100644 index 0000000000..9965f427a4 --- /dev/null +++ b/meta-google/README @@ -0,0 +1,60 @@ +This README file contains information on the contents of the meta-google layer. + +Please see the corresponding sections below for details. + + +Dependencies +============ + +This layer depends on: + + URI: https://github.com/openbmc/meta-phosphor + branch: master + +Patches +======= + +Please submit any patches against the meta-google layer to the OpenBMC gerrit https://gerrit.openbmc-project.xyz/ + +Layer maintainer: Patrick Venture <venture@google.com> + +When sending patches, following [OpenBMC guidelines](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md). + +Table of Contents +================= + + I. Adding the filesystems layer to your build + II. Purpose +III. Customizations + + +I. Adding the meta-google layer to your build +================================================= + +In order to use this layer, you need to make the build system aware of +it. + +Assuming the meta-google layer exists at the top-level of your +yocto build tree, you can add it to the build system by adding the +location of the meta-google layer to bblayers.conf, along with any +other layers needed. e.g.: + + BBLAYERS ?= " \ + /path/to/yocto/meta-phosphor \ + /path/to/yocto/meta-google \ + " + + +II. Purpose +============ + +Including this layer adds the following packages to your obmc-phosphor-image: + +* google-ipmi-sys: OEM IPMI Handler for providing specific information to the host. +* phosphor-ipmi-blobs: OEM IPMI Blobs Handler for providing the framework for specific blob handlers. +* phosphor-ipmi-ethstats: OEM IPMI Handler for reporting ethernet device statistics from the BMCs ethernet devices. +* phosphor-ipmi-flash: OEM IPMI Handler for controlling in-band firmware updates. + +III. Customizations + +Presently, this layer also enables the Google Iana for registering phosphor-ipmi-ethstats in addition to the OpenBMC one. |