README.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) 2017 Enea AB and others
   4
   5 Armband Fuel@OPNFV
   6 ==================
   7
   8 This repository holds build scripts for MCP Fuel OPNFV installer
   9 for AArch64 machines.
  10
  11 Development Workflow
  12 ====================
  13
  14 The standard workflow should look as follows:
  15
  16 #. Clone the repository.
  17
  18 #. All the sub-projects are registered as submodules. To initialize them, call:
  19
  20        .. code-block:: bash
  21
  22            $ make submodules-init
  23
  24 #. Apply patches from ``patches/<sub-project>/*`` to respective submodules via:
  25
  26        .. code-block:: bash
  27
  28            $ make patches-import
  29
  30    This will result in creation of:
  31
  32    - a tag called ``${A_OPNFV_TAG}-root`` at submodule remote branch HEAD;
  33    - a new branch ``opnfv-armband`` which will hold all the armband work.
  34
  35    Then each patch is applied on this new branch with ``git-am``.
  36
  37    The new HEAD is tagged with ``${A_OPNFV_TAG}``.
  38
  39 #. Modify sub-projects for whatever you need.
  40
  41    Commit your changes when you want them taken into account in the build.
  42
  43    *NOTE*: If you want to re-export patches, make sure to move the tag
  44    ``${A_OPNFV_TAG}`` to the latest commit that should be included.
  45
  46 #. Re-create patches and add default copyright header via:
  47
  48        .. code-block:: bash
  49
  50            $ make patches-export patches-copyright
  51
  52    Each commit on ``opnfv-armband`` branch of each subproject will be
  53    exported to ``patches/subproject/`` via ``git format-patch``.
  54
  55 #. Clean workbench branches and tags with:
  56
  57        .. code-block:: bash
  58
  59            $ make submodules-clean
  60
  61 Sub-projects
  62 ============
  63
  64 If you need to add another subproject, you can do it with ``git submodule``.
  65 Make sure that you specify branch (with ``-b``), short name (with ``--name``)
  66 and point it to ``upstream/*`` directory, i.e.:
  67
  68    .. code-block:: bash
  69
  70        $ git submodule -b stable/mitaka add --name fuel-web \
  71          https://github.com/openstack/fuel-web.git upstream/fuel-web