Skip to content

Commit

Permalink
Add build flow diagram
Browse files Browse the repository at this point in the history
Signed-off-by: Derek G Foster <[email protected]>
  • Loading branch information
ffoulkes committed Sep 11, 2023
1 parent 936173a commit da6c303
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
Binary file added docs/scripts/config-cross-recipe-flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 14 additions & 6 deletions docs/scripts/config-cross-recipe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ config-cross-recipe.sh
Helper script to configure CMake to cross-compile P4 Control Plane
for the Arm Compute Complex (ACC).

Build flow
==========

The ``config-cross-recipe.sh`` script is run after ``make-cross-ovs.sh``,
to configure the remainder of the P4 Control Plane build.

.. image:: config-cross-recipe-flow.png

After running this script, you will need to issue a separate command
to build and install the software. For example:

Expand Down Expand Up @@ -50,8 +58,8 @@ Paths

``--build=BLDDIR``, ``-B BLDDIR``
Directory that CMake will use to perform the build.

Will be created if it does not exist.

Specifies the value of the ``-B`` CMake option.
Can be used to create separate build directories for native and
cross-compiled builds.
Expand All @@ -60,7 +68,7 @@ Paths
``--deps=DEPS``, ``-D DEPS`` *(see note)*
Directory in which the Stratum dependencies for the runtime system
are installed.

P4 Control Plane will be linked with these libraries.
Supplies the value of the ``DEPEND_INSTALL_DIR`` listfile variable.
Defaults to the value of the ``DEPEND_INSTALL`` environment variable,
Expand Down Expand Up @@ -91,8 +99,8 @@ Paths

``--prefix=PREFIX``, ``-P PREFIX`` *(see note)*
Directory in which P4 Control Plane will be installed.
Will be created if it does not exist.

The directory will be created if it does not exist.
May be the same as the ``--ovs`` option, in which case OVS and
P4 Control Plane will be installed to the same directory tree.
Specifies the value of the ``CMAKE_INSTALL_PREFIX`` variable when
Expand All @@ -105,7 +113,7 @@ Paths
Defaults to the value of the ``SDE_INSTALL`` environment variable,
if defined.
Otherwise, defaults to ``//opt/p4sde``.

``--toolchain=FILE``, ``-T FILE``
Path to the CMake toolchain file.

Expand Down Expand Up @@ -139,7 +147,7 @@ Environment variables
May be overridden by ``--toolchain=TOOLFILE``.
Must be defined.

``DEPEND_INSTALL``
``DEPEND_INSTALL``
Directory in which the Stratum dependencies for the runtime system
are installed.
Supplies the default value of the ``--deps`` option.
Expand All @@ -148,7 +156,7 @@ Environment variables
Directory in which the Stratum dependencies for the development system
are installed.
Supplies the default value of the ``--host`` option.

``OVS_INSTALL``
Directory in which Open vSwitch is installed.
Supplies the default value of the ``--ovs`` option.
Expand Down

0 comments on commit da6c303

Please sign in to comment.