Skip to content

Commit

Permalink
Restructure ES2K build instructions (#282)
Browse files Browse the repository at this point in the history
- Create separate index pages for building for the es2k host and
  building for the es2k acc.

Signed-off-by: Derek G Foster <[email protected]>
  • Loading branch information
ffoulkes authored Sep 14, 2023
1 parent d5bc5e4 commit c841363
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 6 deletions.
15 changes: 15 additions & 0 deletions docs/guides/building-for-es2k-acc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. Copyright 2023 Intel Corporation
SPDX-License-Identifier: Apache-2.0
=========================
Building for the ES2K ACC
=========================

.. toctree::
:maxdepth: 1

/guides/es2k/installing-acc-sdk
Defining the build environment </guides/es2k/defining-acc-environment>
Building host dependencies </guides/deps/building-stratum-deps>
Building ACC target dependencies </guides/deps/building-acc-stratum-deps>
Building P4 Control Plane </guides/es2k/building-acc-p4cp>
12 changes: 12 additions & 0 deletions docs/guides/building-for-es2k-host.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. Copyright 2023 Intel Corporation
SPDX-License-Identifier: Apache-2.0
==========================
Building for the ES2K Host
==========================

.. toctree::
:maxdepth: 1

/guides/setup/es2k-setup-guide
/guides/deps/building-stratum-deps
3 changes: 2 additions & 1 deletion docs/guides/setup/es2k-setup-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ This document explains how to install, build, and run P4 Control Plane
for the ES2K target.

P4 Control Plane can be built to run on an x86 host processor or the ARM
Compute Complex (ACC). The instructions here are for the host processor.
Compute Complex (ACC). These instructions are for the host processor.
For the ACC, see [Building for the ES2K ACC](/guides/building-for-es2k-acc).

## Setup

Expand Down
7 changes: 2 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,8 @@ P4 Control Plane User Guide
:maxdepth: 1
:caption: Building

guides/deps/building-stratum-deps
guides/deps/building-acc-stratum-deps
guides/es2k/installing-acc-sdk
guides/es2k/defining-acc-environment
guides/es2k/building-acc-p4cp
guides/building-for-es2k-host
guides/building-for-es2k-acc
scripts/helper-scripts

.. toctree::
Expand Down

0 comments on commit c841363

Please sign in to comment.