From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E0951A054F; Mon, 15 Feb 2021 13:00:10 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D15E31606CC; Mon, 15 Feb 2021 13:00:10 +0100 (CET) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by mails.dpdk.org (Postfix) with ESMTP id 4E34C1606C7 for <dev@dpdk.org>; Mon, 15 Feb 2021 13:00:08 +0100 (CET) IronPort-SDR: 3cFkph7MWv5d8AOy+s7Z1JqeT9PLWgecZEfV4bvHHXH7GCFKWP4mn0OmbrbGLitTv+n/+X7tqa Actf+PjIOAag== X-IronPort-AV: E=McAfee;i="6000,8403,9895"; a="180106426" X-IronPort-AV: E=Sophos;i="5.81,180,1610438400"; d="scan'208";a="180106426" Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Feb 2021 04:00:06 -0800 IronPort-SDR: Xxevj34Py+/6CE19DQDg3QKYL3f4tI9N9d9VJbeCLbsXiHtyEoqHlPUQpixcLHAbFBhfYkdwXI oe4iVUawP+NA== X-IronPort-AV: E=Sophos;i="5.81,180,1610438400"; d="scan'208";a="492717911" Received: from aburakov-mobl.ger.corp.intel.com (HELO [10.213.248.64]) ([10.213.248.64]) by fmsmga001-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Feb 2021 04:00:05 -0800 To: Thomas Monjalon <thomas@monjalon.net> Cc: dev@dpdk.org, ferruh.yigit@intel.com References: <6ba21a558bc1d6049a77d09ed52d12627055db8a.1605891269.git.anatoly.burakov@intel.com> <617638b7bdd97cf232289909fcd74bcc82d79545.1606224358.git.anatoly.burakov@intel.com> <2238841.hzaeQzyLfu@thomas> From: "Burakov, Anatoly" <anatoly.burakov@intel.com> Message-ID: <50e4a797-f7e9-8345-191d-fa161260ff6e@intel.com> Date: Mon, 15 Feb 2021 12:00:03 +0000 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:68.0) Gecko/20100101 Thunderbird/68.12.0 MIME-Version: 1.0 In-Reply-To: <2238841.hzaeQzyLfu@thomas> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Subject: Re: [dpdk-dev] [PATCH DPDK-KMODS v2] linux/igb_uio: add compile instructions X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org> 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