aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexandru Avadanii <Alexandru.Avadanii@enea.com>2016-05-11 18:23:06 +0200
committerAlexandru Avadanii <Alexandru.Avadanii@enea.com>2016-05-11 19:51:26 +0000
commite8eb2af5712261c541811be63c64ed71251f1b3e (patch)
treefa06b18e6bff44e5bd4447aba6b0597fee0d3eab
parent54b6ac34045381804cb4670816f9e3cf1f4e4e18 (diff)
Cleanup: README.md small rework.
While doing minor reworking, also change submodule add intstr from ssh to https URLs, so simply building this does not require a github account to be locally configured. Change-Id: I915e9cdbbe0185e5d637bf9ddad96d92f94c0b01 (cherry picked from commit a0e1b11e7dccbc59c5664e59a70abebdebadd8ae)
-rw-r--r--README.md56
1 files changed, 42 insertions, 14 deletions
diff --git a/README.md b/README.md
index ea94089..9bc8d24 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,53 @@
-Armband Fuel test
-=================
+Armband Fuel@OPNFV
+==================
-This is a test repository to hold build scripts for Fuel 8 based OPNFV
-installer for aarch64 machines. Construction of this repository will change.
+This repository holds build scripts for Fuel 8.0 OPNFV installer
+for AArch64 machines.
Workflow
--------
The standard workflow should look as follows:
1. Clone the repository.
-2. All the sub-projects are registered as submodules. Call `make submodules-init` to initialize them.
-2. Apply patches from `patches/sub-project/*` to respective submodules via `make patches-import`. This will result in creation of a tag `armband-workbench-root` at the `HEAD` of the submodule and creation of a new branch `armband-workbench` which will hold all the armband related work. Then each patch is applied on this new branch with `git-am`.
-3. Modify sub-projects for whatever you need. Commit your changes when you want them taken into account in the build.
-4. Build with `make build`
-5. Re-create patches via `make patches-export`. Each commit on `armband-workbench` branch of each subproject will be exported to the `patches/subproject/` via `git format-patch`. Remember to commit only patches! Commiting changed submodules (`git diff` will list something like: `Subproject commit: {hash}`) will result in breaking them as the new commit hash is non-existant in the upstream repo. Hence anybody cloning the repository will fail on `make submodules-init`. Similarily commiting changes to patches which only report a new hash (`git diff` reports something like: `From {hash} {date}`) is not needed (although won't break anything) because `git am` will discard them anyway.
-6. Clean workbench branches and tags with `make submodules-clean`.
+2. All the sub-projects are registered as submodules. To initialize them, call:
+ $ make submodules-init
+
+3. Apply patches from `patches/<sub-project>/*` to respective submodules via:
+ $ 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.
+ Then each patch is applied on this new branch with `git-am`.
+
+4. Modify sub-projects for whatever you need.
+ Commit your changes when you want them taken into account in the build.
+
+5. Build with:
+ $ make build
+
+6. Re-create patches via:
+ $ make patches-export
+
+ Each commit on `armband-workbench` 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
Sub-projects
------------
-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@github.com:openstack/fuel-web.git upstream/fuel-web
-```
+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 \
+ https://github.com/openstack/fuel-web.git upstream/fuel-web