[dpdk-dev] [PATCH DPDK-KMODS] igb_uio: add compile instructions

[dpdk-dev] [PATCH DPDK-KMODS] igb_uio: add compile instructions

[Anatoly Burakov]

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

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
-- 
2.17.1

Re: [dpdk-dev] [PATCH DPDK-KMODS] igb_uio: add compile instructions

[Ferruh Yigit]

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.

[dpdk-dev] [PATCH DPDK-KMODS v2] linux/igb_uio: add compile instructions

[Anatoly Burakov]

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>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 INSTALL          |  5 +++++
 linux/README.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+)
 create mode 100644 INSTALL
 create mode 100644 linux/README.rst

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..11dd501
--- /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
+``igb_uio`` directory:
+
+.. code-block:: console
+
+    cd 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
-- 
2.17.1

Re: [dpdk-dev] [PATCH DPDK-KMODS v2] linux/igb_uio: add compile instructions

[Ajit Khaparde]

On Tue, Nov 24, 2020 at 5:26 AM Anatoly Burakov
<anatoly.burakov@intel.com> 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.
>
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Reviewed-by: Ajit Khaparde <ajit.khaparde@broadcom.com>

> ---
>  INSTALL          |  5 +++++
>  linux/README.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 50 insertions(+)
>  create mode 100644 INSTALL
>  create mode 100644 linux/README.rst
>
> 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..11dd501
> --- /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
> +``igb_uio`` directory:
> +
> +.. code-block:: console
> +
> +    cd 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
> --
> 2.17.1

Re: [dpdk-dev] [PATCH DPDK-KMODS v2] linux/igb_uio: add compile instructions

[Burakov, Anatoly]

On 24-Nov-20 2:27 PM, Ajit Khaparde wrote:
> On Tue, Nov 24, 2020 at 5:26 AM Anatoly Burakov
> <anatoly.burakov@intel.com> 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.
>>
>> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
>> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 
> Reviewed-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> 

Is there anything preventing this patch from getting merged?

-- 
Thanks,
Anatoly

Re: [dpdk-dev] [PATCH DPDK-KMODS v2] linux/igb_uio: add compile instructions

[Thomas Monjalon]

About the title, I think "build" would be more generic than "compile".

24/11/2020 14:26, Anatoly Burakov:
> 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>
> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
> +++ 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.

I would suggest "README file in the respective sub-directory".


> +++ b/linux/README.rst
> @@ -0,0 +1,45 @@
> +Building Linux Drivers
> +======================

What about "Building Out-of-Tree Kernel Drivers for Linux" ?

> +
> +Prerequisites
> +-------------
> +
> +The system must have relevant Linux kernel headers or source code installed.
> +
> +Build
> +-----

We are supposed to insert 2 blank lines before titles.

> +
> +To build ``igb_uio`` driver, simple run ``make`` command inside the

s/simple/simply/

> +``igb_uio`` directory:
> +
> +.. code-block:: console
> +
> +    cd igb_uio
> +    make

It looks nicer if indented with 3 spaces, aligning with ".. "

> +
> +If compiling against a specific kernel source directory is required, it is

Please wrap the line after the comma.

> +possible to specify the kernel source directory using the ``KSRC`` variable:

If it make line too long here, you can wrap before using.
The idea is to have one idea per line, so wrapping is more logic.

> +
> +.. code-block:: console
> +
> +    make KSRC=/path/to/custom/kernel/source
> +
> +Load the driver
> +---------------

Previous title was just "Build". So this one can be just "Load".

> +
> +The ``igb_uio`` driver requires the UIO driver to be loaded beforehand (these
> +commands are to be run as ``root`` user):

Wrapping should isolate the full parenthesis on the second line.

> +
> +.. code-block:: console
> +
> +    modprobe uio
> +    insmod igb_uio.ko

Note: uio could be built-in.

> +
> +Clean the build directory
> +-------------------------
> +
> +To clean the build directory, the following command can be run:
> +
> +.. code-block:: console
> +
> +    make clean

Re: [dpdk-dev] [PATCH DPDK-KMODS v2] linux/igb_uio: add compile instructions

[Burakov, Anatoly]

On 15-Feb-21 11:40 AM, Thomas Monjalon wrote:
> About the title, I think "build" would be more generic than "compile".
> 
> 24/11/2020 14:26, Anatoly Burakov:
>> 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>
>> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
>> ---
>> +++ 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.
> 
> I would suggest "README file in the respective sub-directory".
> 
> 
>> +++ b/linux/README.rst
>> @@ -0,0 +1,45 @@
>> +Building Linux Drivers
>> +======================
> 
> What about "Building Out-of-Tree Kernel Drivers for Linux" ?
> 
>> +
>> +Prerequisites
>> +-------------
>> +
>> +The system must have relevant Linux kernel headers or source code installed.
>> +
>> +Build
>> +-----
> 
> We are supposed to insert 2 blank lines before titles.
> 
>> +
>> +To build ``igb_uio`` driver, simple run ``make`` command inside the
> 
> s/simple/simply/
> 
>> +``igb_uio`` directory:
>> +
>> +.. code-block:: console
>> +
>> +    cd igb_uio
>> +    make
> 
> It looks nicer if indented with 3 spaces, aligning with ".. "
> 
>> +
>> +If compiling against a specific kernel source directory is required, it is
> 
> Please wrap the line after the comma.
> 
>> +possible to specify the kernel source directory using the ``KSRC`` variable:
> 
> If it make line too long here, you can wrap before using.
> The idea is to have one idea per line, so wrapping is more logic.
> 
>> +
>> +.. code-block:: console
>> +
>> +    make KSRC=/path/to/custom/kernel/source
>> +
>> +Load the driver
>> +---------------
> 
> Previous title was just "Build". So this one can be just "Load".
> 
>> +
>> +The ``igb_uio`` driver requires the UIO driver to be loaded beforehand (these
>> +commands are to be run as ``root`` user):
> 
> Wrapping should isolate the full parenthesis on the second line.
> 
>> +
>> +.. code-block:: console
>> +
>> +    modprobe uio
>> +    insmod igb_uio.ko
> 
> Note: uio could be built-in.
> 
>> +
>> +Clean the build directory
>> +-------------------------
>> +
>> +To clean the build directory, the following command can be run:
>> +
>> +.. code-block:: console
>> +
>> +    make clean
> 
> 
> 

Thanks for your review, Thomas, i'll submit a new version addressing the 
feedback!

-- 
Thanks,
Anatoly

Re: [dpdk-dev] [PATCH DPDK-KMODS v2] linux/igb_uio: add compile instructions

[Thomas Monjalon]

Hello

15/02/2021 13:00, Burakov, Anatoly:
> Thanks for your review, Thomas, i'll submit a new version addressing the 
> feedback!

It seems this patch was forgotten.
Please could you update?

[kmods PATCH v3] linux/igb_uio: add build instructions

[Thomas Monjalon]

From: Anatoly Burakov <anatoly.burakov@intel.com>

Currently, compilation instructions for igb_uio are missing.
Add them, as well as referring users to per-OS subdirectories.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
Reviewed-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
v3: improvements suggested one year ago

No need to wait one more year, this patch is directly applied.
---
 README           |  3 +++
 linux/README.rst | 58 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 61 insertions(+)
 create mode 100644 linux/README.rst

diff --git a/README b/README
index e71dbba..c514cf0 100644
--- a/README
+++ b/README
@@ -8,3 +8,6 @@ Now the preference is to contribute kernel modules to the upstream project
 if possible, otherwise to host kernel code in dpdk-kmods.git.
 
 The license can be BSD-3-Clause or GPL-2.0.
+
+For specific instructions per OS,
+please refer to the README file in the respective sub-directory.
diff --git a/linux/README.rst b/linux/README.rst
new file mode 100644
index 0000000..6c60a3d
--- /dev/null
+++ b/linux/README.rst
@@ -0,0 +1,58 @@
+Building Out-of-Tree Kernel Drivers for Linux
+=============================================
+
+Prerequisites
+-------------
+
+The system must have relevant Linux kernel headers or source code installed.
+
+
+Build
+-----
+
+To build ``igb_uio`` driver, simply run ``make`` command
+inside the ``igb_uio`` directory:
+
+.. code-block:: console
+
+   cd 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
+----
+
+.. note::
+
+   These commands are to be run as ``root`` user.
+
+The ``igb_uio`` driver requires the UIO driver to be loaded beforehand.
+If ``uio`` is not built-in:
+
+.. code-block:: console
+
+   modprobe uio
+
+Then the out-of-tree driver may be loaded.
+
+.. code-block:: console
+
+   insmod igb_uio.ko
+
+
+Clean
+-----
+
+To clean the build directory, the following command can be run:
+
+.. code-block:: console
+
+   make clean
-- 
2.39.1