Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit make-all.sh user guide #275

Merged
merged 4 commits into from
Sep 12, 2023
Merged

Edit make-all.sh user guide #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
012ec17
Edit make-all.sh user guide
ffoulkes Sep 9, 2023
8fa576a
Improvements and corrections
ffoulkes Sep 11, 2023
6873027
Minor improvements
ffoulkes Sep 11, 2023
10d885c
Reword discussion of default build type
ffoulkes Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/scripts/make-all-build-flow.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 16 additions & 5 deletions docs/scripts/make-all.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ make-all.sh

Helper script to build and install the P4 Control Plane software.

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

The ``make-all.sh`` script builds and installs Open vSwitch (OVS), and then
builds and installs the rest of P4 Control Plane.

.. image:: make-all-build-flow.png

Syntax
======

Expand Down Expand Up @@ -45,7 +53,7 @@ Paths
``--deps=DEPS``, ``-D DEPS``
Directory in which the Stratum dependencies for the runtime system
are installed.

P4 Control Plane will be linked with these libraries.
Use this option instead of ``--host`` if are building for the native
system (not cross-compiling).
Expand Down Expand Up @@ -74,15 +82,15 @@ Paths

``--prefix=PREFIX``, ``-P PREFIX``
Directory in which P4 Control Plane will be installed.

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
building P4 Control Plane.

``--sde=SDE``, ``-S SDE``
Directory in which the SDK for the Intel® E2100 IPU is installed.
Directory in which the SDK for the P4 target is installed.

Supplies the value of the ``SDE_INSTALL_DIR`` listfile variable.
Defaults to the value of the ``SDE_INSTALL`` environment variable.
Expand Down Expand Up @@ -135,7 +143,7 @@ Configurations
Build with ``-DCMAKE_BUILD_TYPE=Debug``.
The compiler settings will default to ``-g``.

``--minsize``
``--minsize``
Build with ``-DCMAKE_BUILD_TYPE=MinSizeRel``.
The compiler settings will default to ``-Os -DNDEBUG``.

Expand All @@ -147,6 +155,9 @@ Configurations
Build with ``-DCMAKE_BUILD_TYPE=Release``.
The compiler settings will default to ``-O3 -DNDEBUG``.

If no configuration is specified, the CMake listfile currently defaults to
``RelWithDebInfo``.

Environment variables
=====================

Expand All @@ -156,7 +167,7 @@ Environment variables
May be overridden by ``--toolchain=TOOLFILE``.
Must be defined when cross-compiling.

``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 Down