From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 4BB3BA054F; Mon, 15 Feb 2021 12:40:34 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id B4D7416067A; Mon, 15 Feb 2021 12:40:33 +0100 (CET) Received: from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com [66.111.4.27]) by mails.dpdk.org (Postfix) with ESMTP id 99A6340FDF for ; Mon, 15 Feb 2021 12:40:32 +0100 (CET) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id EB0F25C0072; Mon, 15 Feb 2021 06:40:31 -0500 (EST) Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Mon, 15 Feb 2021 06:40:31 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=fm3; bh= f4/TOQvPKzG1mHZUA8IZfcU2gMX5EeAO2N3Zqsz6ttE=; b=sE+vLPYst2iviWi8 vXMg2ge1aO91uHNK0vK/6/qdnOQc7JUG/UtuXiqEgAmZnCJo9goaMC0PanvG7MXN zXblhuqnWfymlZbrnEfaEJZlehnJX/Oo90CGlf4T3wlJhwyG8vUFkSCfCzB768vf a4LOwUXl0iAKn/aDJ9JrPzJAu1iTSVkCwKt83z6YPPmY/Hilk+HHlEhGGtTDnQy+ IhmsnApMmI720CNK+nVOGJ5jqhCK/yPJle48GVWinY32h8Mjlchr/88SSbf3omYD u6MU+z7g21lVB2BZv+HtUpJdRt3dxjPwhuJ0i54fkZxJEUMxHI2gqaOO3O5IOMh/ 2vh/RA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm2; bh=f4/TOQvPKzG1mHZUA8IZfcU2gMX5EeAO2N3Zqsz6t tE=; b=lXGmJ0leGbRiKLWiDoyK+EC6dA4zZihQNif3JfiWXhJ8+OMcATrEUj2ke ijMeMWHvUGY3/mNswhPK2L2d+kgoldZB70LJCfGGdP8UqDpTe61v0QawBlOHnzjn InC04KCMCdCk8T1NO0ThWX9W/rQEEllStEa3N65sJ4OeW5gjxE2GrjDwesZ2qFAu +iSmJMeP9ohNt7zdb0BCnhw6EkH68oG1IrYr71P5YqoH/+JpLNas6x/w/jkbXnh1 1lqXPuNw/AX+A/hqPlMyC9Ow+jr1X3j2MM9uX6ulzBJwCP8o/sVWaQqPh5f71zmt N5ZsykY87W28T9gw4BCNH9/9T/QFg== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrieekgddvkecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvffufffkjghfggfgtgesthfuredttddtvdenucfhrhhomhepvfhhohhmrghs ucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenucggtf frrghtthgvrhhnpedugefgvdefudfftdefgeelgffhueekgfffhfeujedtteeutdejueei iedvffegheenucfkphepjeejrddufeegrddvtdefrddukeegnecuvehluhhsthgvrhfuih iivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhmrghssehmohhnjhgrlhho nhdrnhgvth X-ME-Proxy: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id E7690240064; Mon, 15 Feb 2021 06:40:30 -0500 (EST) From: Thomas Monjalon To: Anatoly Burakov Cc: dev@dpdk.org, ferruh.yigit@intel.com Date: Mon, 15 Feb 2021 12:40:29 +0100 Message-ID: <2238841.hzaeQzyLfu@thomas> In-Reply-To: <617638b7bdd97cf232289909fcd74bcc82d79545.1606224358.git.anatoly.burakov@intel.com> References: <6ba21a558bc1d6049a77d09ed52d12627055db8a.1605891269.git.anatoly.burakov@intel.com> <617638b7bdd97cf232289909fcd74bcc82d79545.1606224358.git.anatoly.burakov@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 > Reviewed-by: Ferruh Yigit > --- > +++ 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