u/fuel: Bump & rebase for state break & retry

[armband.git] / README.md

diff --git a/README.md b/README.md
index 9bc8d24..877664f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,11 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2017 Enea AB and others
+
 Armband Fuel@OPNFV
 ==================
 
-This repository holds build scripts for Fuel 8.0 OPNFV installer
+This repository holds build scripts for MCP Fuel OPNFV installer
 for AArch64 machines.
 
 Workflow
@@ -17,29 +21,26 @@ The standard workflow should look as follows:
    $ make patches-import
 
    This will result in creation of:
-   - a tag called `armband-workbench-root` at the `HEAD` of the submodule;
-   - a new branch `armband-workbench` which will hold all the armband work.
+   - a tag called `${A_OPNFV_TAG}-root` at submodule remote branch HEAD;
+   - a new branch `opnfv-armband` which will hold all the armband work.
    Then each patch is applied on this new branch with `git-am`.
+   The new HEAD is tagged with `${A_OPNFV_TAG}`.
 
 4. Modify sub-projects for whatever you need.
    Commit your changes when you want them taken into account in the build.
 
-5. Build with:
+   NOTE: If you want to re-export patches, make sure to move the tag
+   `${A_OPNFV_TAG}` to the latest commit that should be included.
+
+5. (not implemented yet for MCP) Build with:
    $ make build
 
 6. Re-create patches via:
    $ make patches-export
 
-   Each commit on `armband-workbench` branch of each subproject will be
+   Each commit on `opnfv-armband` branch of each subproject will be
    exported to `patches/subproject/` via `git format-patch`.
 
-   NOTE: DO NOT commit changed submodules. Remember to commit only patches!
-
-   Commiting changed submodules (`git diff` will list something like:
-   `Subproject commit: {hash}`) will break the repo, as the new commit hash
-   is non-existant in the upstream repo, hence anybody cloning the repository
-   later will fail on `make submodules-init`. 
-
 7. Clean workbench branches and tags with:
    $ make submodules-clean
 
@@ -49,5 +50,5 @@ If you need to add another subproject, you can do it with `git submodule`.
 Make sure that you specify branch (with `-b`), short name (with `--name`)
 and point it to `upstream/*` directory, i.e.:
 
-   $ git submodule -b stable/8.0 add --name fuel-web \
+   $ git submodule -b stable/mitaka add --name fuel-web \
      https://github.com/openstack/fuel-web.git upstream/fuel-web