Skip to content

Commit

Permalink
cleanup: thread onload-dev requirement through release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
abower-amd committed Oct 3, 2024
1 parent 17634fa commit 767b17e
Showing 1 changed file with 31 additions and 17 deletions.
48 changes: 31 additions & 17 deletions doc/ReleaseNotes
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,6 @@ TCPDirect-9.0.0
derives from those supported by Onload.


Public Onload/ef_vi control plane API
-------------------------------------

The Onload control plane in this Onload-9.0.0 is presented via a new
public API that can be used by ef_vi applications. As an ef_vi application,
TCPDirect now uses this API to query the control plane server.


TCPDirect distributed as source code
------------------------------------

Expand All @@ -27,26 +19,41 @@ TCPDirect distributed as source code
suitable new build and installation workflows for the TCPDirect source
package.

There is no longer a 'tarball' distribution type as the RPM and DEB source
packages are suitable for all supported OSs.
In particular, this means an additional Onload development package
is required, which contains the necessary headers for building TCPDirect.


New onload-devel package required
---------------------------------
New onload development package
------------------------------

Onload now includes a package containing headers required by ef_vi
applications like TCPDirect. Installing this package is now required to
install TCPDirect binaries as well as to build TCPDirect applications.
build TCPDirect and TCPDirect applications.

Please ensure the openonload-devel RPM or onload-dev DEB is installed
after building Onload before attempting to build TCPDirect.


Headers can also be installed via new '--headers' option in 'onload_install'
as of Onload-9.0.0.
Public Onload/ef_vi control plane API
-------------------------------------

The Onload control plane in this Onload-9.0.0 is presented via a new
public API that can be used by ef_vi applications. As an ef_vi application,
TCPDirect now uses this API to query the control plane server.


Installation
------------

To install TCPDirect from a Source RPM:

0. The source RPM package depends on the Onload userspace and development
packaged in addition to any other dependencies on standard system
packages:

- openonload
- openonload-devel

0. The Source RPM depends upon the openonload and openonload-devel packages
in addition to any other dependencies.

Expand All @@ -70,8 +77,12 @@ Installation

To install TCPDirect from a DEB:

0. The DEB package depends on *onload-user and *onload-dev packages in
addition to any other dependencies.
0. The DEB source package depends on the Onload userspace and development
packaged in addition to any other dependencies on standard system
packages:

- onload-user
- onload-dev

1. Extract debian-source tarball:

Expand All @@ -93,6 +104,9 @@ Installation

dpkg -i tcpdirect_<version>-1_amd64.deb

There is no longer a 'tarball' distribution type as the RPM and DEB source
packages are suitable for all supported OSs.


SPDX-License-Identifier: MIT
SPDX-FileCopyrightText: (c) 2023-2024 Advanced Micro Devices, Inc.

0 comments on commit 767b17e

Please sign in to comment.