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.bura...@intel.com> > Reviewed-by: Ferruh Yigit <ferruh.yi...@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
