From 0f59e55b88877d7fa27b7a4533b0ce3067754d41 Mon Sep 17 00:00:00 2001 From: Christopher Larson Date: Mon, 15 Aug 2016 12:59:56 -0700 Subject: [PATCH 1/8] README.md: use a proper md link for the repo Signed-off-by: Christopher Larson --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f1e1df6..c0ce09d 100644 --- a/README.md +++ b/README.md @@ -41,11 +41,9 @@ necessary. The tcmode performs a number of operations: Contributing ------------ -URL: https://github.com/MentorEmbedded/meta-sourcery - -To contribute to this layer, please fork and submit pull requests to the above -repository with github, or open issues for any bugs you find, or feature -requests you have. +To contribute to this layer, please fork and submit pull requests to the +github [repository](https://github.com/MentorEmbedded/meta-sourcery), or open +issues for any bugs you find, or feature requests you have. To Do List ---------- From ff0be6826d285cf523177ab0a16d0066efdf655f Mon Sep 17 00:00:00 2001 From: Christopher Larson Date: Mon, 15 Aug 2016 13:00:10 -0700 Subject: [PATCH 2/8] README.md: add layer dependencies section Signed-off-by: Christopher Larson --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index c0ce09d..efeb998 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ OpenEmbedded/Yocto layer for the Sourcery G++ toolchain ======================================================= +Layer Dependencies +------------------ + +- [openembedded-core](https://github.com/openembedded/openembedded-core), with + a matching branch (i.e. master of oe-core and master of meta-sourcery) + Usage & Instructions -------------------- From 57d161dd493d56b34796f3740dcec089e7f559a2 Mon Sep 17 00:00:00 2001 From: Christopher Larson Date: Mon, 15 Aug 2016 13:07:39 -0700 Subject: [PATCH 3/8] README.md: add bitbake and toolchain to deps Signed-off-by: Christopher Larson --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index efeb998..02a5b36 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ OpenEmbedded/Yocto layer for the Sourcery G++ toolchain ======================================================= -Layer Dependencies ------------------- +Dependencies +------------ -- [openembedded-core](https://github.com/openembedded/openembedded-core), with - a matching branch (i.e. master of oe-core and master of meta-sourcery) +- [openembedded-core](https://github.com/openembedded/openembedded-core) + layer, with a matching branch (i.e. master of oe-core and master of + meta-sourcery). +- [bitbake](https://github.com/openembedded/bitbake), with a matching branch. +- An installed Sourcery G++ toolchain Usage & Instructions -------------------- -- Ensure that you have the Sourcery G++ toolchain installed. - If it's an ia32 toolchain, make sure you did *not* let it modify your PATH, and if you did, remove it. From 9a11fb6f3d04e5159c49663aec06d6f7c4b96e1c Mon Sep 17 00:00:00 2001 From: Christopher Larson Date: Mon, 15 Aug 2016 13:08:50 -0700 Subject: [PATCH 4/8] README.md: use # prefixes for headings Signed-off-by: Christopher Larson --- README.md | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 02a5b36..d2f539c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ -OpenEmbedded/Yocto layer for the Sourcery G++ toolchain -======================================================= +# OpenEmbedded/Yocto layer for the Sourcery G++ toolchain -Dependencies ------------- +## Dependencies - [openembedded-core](https://github.com/openembedded/openembedded-core) layer, with a matching branch (i.e. master of oe-core and master of @@ -10,8 +8,7 @@ Dependencies - [bitbake](https://github.com/openembedded/bitbake), with a matching branch. - An installed Sourcery G++ toolchain -Usage & Instructions --------------------- +## Usage & Instructions - If it's an ia32 toolchain, make sure you did *not* let it modify your PATH, and if you did, remove it. @@ -24,8 +21,7 @@ Usage & Instructions priority over meta. - Set `EXTERNAL_TOOLCHAIN = "/path/to/your/sourcery-g++-install"` in `conf/local.conf`. -Optional Functionality ----------------------- +### Optional Functionality - If the user chooses to, they may optionally decide to rebuild the Sourcery G++ glibc from source, if they have downloaded the corresponding source archive from Mentor @@ -34,8 +30,7 @@ Optional Functionality must also set `SOURCERY_SRC_FILE = "/path/to/your/sourcery-g++-source-tarball"` or `SOURCERY_SRC_URI = "http://some.domain/some-path"`. -Description of Behavior ------------------------ +## Description of Behavior The meta-sourcery layer.conf automatically defines `TCMODE` for us, so this is no longer necessary. The tcmode performs a number of operations: @@ -46,14 +41,13 @@ necessary. The tcmode performs a number of operations: them from source, including cross recipes which link/wrap the toolchain cross binaries -Contributing ------------- +## Contributing To contribute to this layer, please fork and submit pull requests to the github [repository](https://github.com/MentorEmbedded/meta-sourcery), or open issues for any bugs you find, or feature requests you have. -To Do List +## To Do List ---------- -See [TODO.md](TODO.md) +See [TODO.md](TODO.md). From 7a20b474bdc0e2d39f3ade43bf091339f28f8548 Mon Sep 17 00:00:00 2001 From: Christopher Larson Date: Mon, 15 Aug 2016 13:08:58 -0700 Subject: [PATCH 5/8] README.md: add Maintainer section Signed-off-by: Christopher Larson --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d2f539c..a036194 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,12 @@ To contribute to this layer, please fork and submit pull requests to the github [repository](https://github.com/MentorEmbedded/meta-sourcery), or open issues for any bugs you find, or feature requests you have. +## Maintainer + +This layer is maintained by [Mentor Graphics +Corporation](https://www.mentor.com/). Please direct all support requests for +this layer to the GitHub repository issues interface. + ## To Do List ----------- See [TODO.md](TODO.md). From 981967acfb38fe4fc3d4d989e72d9c86226f7fb1 Mon Sep 17 00:00:00 2001 From: Christopher Larson Date: Mon, 15 Aug 2016 13:12:21 -0700 Subject: [PATCH 6/8] README.md: remove 'no longer necessary' This phrase implies knowledge of the build process or the layer history which is not always the case. Signed-off-by: Christopher Larson --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a036194..0cdc0ca 100644 --- a/README.md +++ b/README.md @@ -32,8 +32,8 @@ ## Description of Behavior -The meta-sourcery layer.conf automatically defines `TCMODE` for us, so this is no longer -necessary. The tcmode performs a number of operations: +The meta-sourcery layer.conf automatically defines `TCMODE` for us. The tcmode +performs a number of operations: - Sets `TARGET_PREFIX` appropriately, after determining what prefix is in use by the toolchain - Sanity checks `EXTERNAL_TOOLCHAIN`: does the path exist? does the expected sysroot exist? From 312eb216864eceeaf47131e184285cb9d0210d87 Mon Sep 17 00:00:00 2001 From: Christopher Larson Date: Mon, 15 Aug 2016 13:14:11 -0700 Subject: [PATCH 7/8] README.md: shorten 'Description of Behavior' This is a readme, I think it being descriptive is a given. Signed-off-by: Christopher Larson --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cdc0ca..fc4aff1 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ must also set `SOURCERY_SRC_FILE = "/path/to/your/sourcery-g++-source-tarball"` or `SOURCERY_SRC_URI = "http://some.domain/some-path"`. -## Description of Behavior +## Behavior The meta-sourcery layer.conf automatically defines `TCMODE` for us. The tcmode performs a number of operations: From 0bf26059b7ceab6a1d20fe8f43485d189741c881 Mon Sep 17 00:00:00 2001 From: Christopher Larson Date: Mon, 15 Aug 2016 13:17:58 -0700 Subject: [PATCH 8/8] README.md: mention a build directory in the deps Signed-off-by: Christopher Larson --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index fc4aff1..2134a53 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ meta-sourcery). - [bitbake](https://github.com/openembedded/bitbake), with a matching branch. - An installed Sourcery G++ toolchain +- An existing build directory configured for this bitbake and + openembedded-core. ## Usage & Instructions