[DPDK-KMODS] igb_uio: add compile instructions
diff mbox series

Message ID 6ba21a558bc1d6049a77d09ed52d12627055db8a.1605891269.git.anatoly.burakov@intel.com
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • [DPDK-KMODS] igb_uio: add compile instructions
Related show

Checks

Context Check Description
ci/iol-testing warning Testing issues
ci/Intel-compilation success Compilation OK
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/checkpatch warning coding style issues

Commit Message

Burakov, Anatoly Nov. 20, 2020, 4:54 p.m. UTC
Currently, compilation instructions for igb_uio are missing. Add them,
as well as a top-level INSTALL file referring users to per-OS
subdirectories.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
---
 INSTALL          |  5 +++++
 linux/README.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+)
 create mode 100644 INSTALL
 create mode 100644 linux/README.rst

Comments

Ferruh Yigit Nov. 23, 2020, 5:08 p.m. UTC | #1
On 11/20/2020 4:54 PM, Anatoly Burakov wrote:
> Currently, compilation instructions for igb_uio are missing. Add them,
> as well as a top-level INSTALL file referring users to per-OS
> subdirectories.

patch title should start with 'linux/igb_uio:'

> 
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Thanks for doc update.

<...>

> @@ -0,0 +1,45 @@
> +Building Linux Drivers
> +======================
> +
> +Prerequisites
> +-------------
> +
> +The system must have relevant Linux kernel headers or source code installed.
> +
> +Build
> +-----
> +
> +To build ``igb_uio`` driver, simple run ``make`` command inside the
> +``linux/igb_uio`` directry:
> +

Just detail but since we are in the 'linux' folder while reading this file, I 
wonder if the reference path should be ``igb_uio`` instead of ``linux/igb_uio``?
Both are OK I think.

Patch
diff mbox series

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..f9ef15c
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,5 @@ 
+Installing DPDK Kernel Drivers
+==============================
+
+For instructions on how to install kernel drivers for each OS, please refer to
+the respective subdirectories' ``README`` files.
diff --git a/linux/README.rst b/linux/README.rst
new file mode 100644
index 0000000..fc9c7a7
--- /dev/null
+++ b/linux/README.rst
@@ -0,0 +1,45 @@ 
+Building Linux Drivers
+======================
+
+Prerequisites
+-------------
+
+The system must have relevant Linux kernel headers or source code installed.
+
+Build
+-----
+
+To build ``igb_uio`` driver, simple run ``make`` command inside the
+``linux/igb_uio`` directry:
+
+.. code-block:: console
+
+    cd linux/igb_uio
+    make
+
+If compiling against a specific kernel source directory is required, it is
+possible to specify the kernel source directory using the ``KSRC`` variable:
+
+.. code-block:: console
+
+    make KSRC=/path/to/custom/kernel/source
+
+Load the driver
+---------------
+
+The ``igb_uio`` driver requires the UIO driver to be loaded beforehand (these
+commands are to be run as ``root`` user):
+
+.. code-block:: console
+
+    modprobe uio
+    insmod igb_uio.ko
+
+Clean the build directory
+-------------------------
+
+To clean the build directory, the following command can be run:
+
+.. code-block:: console
+
+    make clean