aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 28 insertions, 11 deletions
diff --git a/README.md b/README.md
index 05563eed..fd360eaa 100644
--- a/README.md
+++ b/README.md
@@ -17,30 +17,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 same commit as Fuel@OPNFV
- hard sets in `build/config.mk` (inside fuel 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.
+ 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. 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
@@ -52,3 +48,24 @@ and point it to `upstream/*` directory, i.e.:
$ git submodule -b stable/mitaka add --name fuel-web \
https://github.com/openstack/fuel-web.git upstream/fuel-web
+
+Fuel@OPNFV submodule patch development
+--------------------------------------
+Fuel-submodules (fuel-astute, ... , fuel-ui) patches also reside in Armband,
+like previously described patches that are applied to Armband submodules,
+but they are not directly applied to any submodule in Armband.
+Instead, they are copied (staged) to Fuel@OPNFV submodule, which will
+automatically pick them up and apply them to its own submodules
+(fuel-astute, ... , fuel-ui) during ISO build.
+
+The following helpers are available for working with patches for
+Fuel-submodules (fuel-astute, ... , fuel-ui):
+
+1. Clean Fuel-submodules (fuel-astute, ... , fuel-ui) patches
+ $ make fuel-patches-clean
+
+2. Import Fuel-submodules staged patches
+ $ make fuel-patches-import
+
+3. Export Fuel-submodules patches
+ $ make fuel-patches-export