From d818688c4d899e5865dd21fac891f55ac0dcda74 Mon Sep 17 00:00:00 2001 From: Patrick Venture Date: Tue, 9 Oct 2018 14:27:11 -0700 Subject: meta-google: restructured the README per norms Restructure the README per yocto layer norms. (From meta-google rev: 12726b4f3ab3dde321c13383e805018dc6083ed3) Change-Id: Ibf2eee161351d06647f0bd949c763b9c889908ac Signed-off-by: Patrick Venture Signed-off-by: Brad Bishop --- meta-google/README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 49 insertions(+), 3 deletions(-) (limited to 'meta-google/README.md') diff --git a/meta-google/README.md b/meta-google/README.md index b8d74d79b..21340f3ab 100644 --- a/meta-google/README.md +++ b/meta-google/README.md @@ -1,6 +1,52 @@ -# meta-google layer +This README file contains information on the contents of the meta-google layer. -## Purpose +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 + +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`: @@ -8,6 +54,6 @@ Including this layer adds the following packages to your `obmc-phosphor-image`: * [phosphor-ipmi-blobs](https://github.com/openbmc/phosphor-ipmi-blobs): OEM IPMI Blobs Handler for providing the framework for specific blob handlers. * [phosphor-ipmi-ethstats](https://github.com/openbmc/phosphor-ipmi-ethstats): OEM IPMI Handler for reporting ethernet device statistics from the BMCs ethernet devices. -## Customizations +III. Customizations Presently, this layer also enables the Google Iana for registering `phosphor-ipmi-ethstats` in addition to the OpenBMC one. -- cgit v1.2.1