DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: Anatoly Burakov <anatoly.burakov@intel.com>
Cc: dev@dpdk.org, ferruh.yigit@intel.com
Subject: Re: [dpdk-dev] [PATCH DPDK-KMODS v2] linux/igb_uio: add compile instructions
Date: Mon, 15 Feb 2021 12:40:29 +0100
Message-ID: <2238841.hzaeQzyLfu@thomas> (raw)
In-Reply-To: <617638b7bdd97cf232289909fcd74bcc82d79545.1606224358.git.anatoly.burakov@intel.com>

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




  parent reply	other threads:[~2021-02-15 11:40 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-20 16:54 [dpdk-dev] [PATCH DPDK-KMODS] igb_uio: " Anatoly Burakov
2020-11-23 17:08 ` Ferruh Yigit
2020-11-24 13:26 ` [dpdk-dev] [PATCH DPDK-KMODS v2] linux/igb_uio: " Anatoly Burakov
2020-11-24 14:27   ` Ajit Khaparde
2021-02-11 11:04     ` Burakov, Anatoly
2021-02-15 11:40   ` Thomas Monjalon [this message]
2021-02-15 12:00     ` Burakov, Anatoly
2022-01-11 13:35       ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=2238841.hzaeQzyLfu@thomas \
    --to=thomas@monjalon.net \
    --cc=anatoly.burakov@intel.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ https://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git