summary refs log tree commit diff
diff options
context:
space:
mode:
authorDomen Kožar <domen@dev.si>2016-05-20 11:55:20 +0100
committerDomen Kožar <domen@dev.si>2016-05-20 11:55:38 +0100
commit2d6d731f246fa93ce89cac8bd4c78f45c15a38fe (patch)
tree34bd3c11e59a15a9508fa39ef8cb28ffa242c55f
parentc2ee8e103316b411b7d52870a1c6e7f51042f49b (diff)
downloadnixpkgs-2d6d731f246fa93ce89cac8bd4c78f45c15a38fe.tar
nixpkgs-2d6d731f246fa93ce89cac8bd4c78f45c15a38fe.tar.gz
nixpkgs-2d6d731f246fa93ce89cac8bd4c78f45c15a38fe.tar.bz2
nixpkgs-2d6d731f246fa93ce89cac8bd4c78f45c15a38fe.tar.lz
nixpkgs-2d6d731f246fa93ce89cac8bd4c78f45c15a38fe.tar.xz
nixpkgs-2d6d731f246fa93ce89cac8bd4c78f45c15a38fe.tar.zst
nixpkgs-2d6d731f246fa93ce89cac8bd4c78f45c15a38fe.zip
nixos: add a small section about kernel module dev
-rw-r--r--nixos/doc/manual/configuration/linux-kernel.xml21
1 files changed, 21 insertions, 0 deletions
diff --git a/nixos/doc/manual/configuration/linux-kernel.xml b/nixos/doc/manual/configuration/linux-kernel.xml
index ffd7b354efe..0cdae4f6441 100644
--- a/nixos/doc/manual/configuration/linux-kernel.xml
+++ b/nixos/doc/manual/configuration/linux-kernel.xml
@@ -66,4 +66,25 @@ boot.kernel.sysctl."net.ipv4.tcp_keepalive_time" = 120;
 sets the kernel’s TCP keepalive time to 120 seconds.  To see the
 available parameters, run <command>sysctl -a</command>.</para>
 
+<section>
+  <title>Developing kernel modules</title>
+
+  <para>When developing kernel modules it's often convenient to run
+  edit-compile-run loop as quickly as possible.
+
+  See below snippet as an example of developing <literal>mellanix</literal>
+  drivers.
+  </para>
+
+  <screen><![CDATA[
+$ nix-build '<nixpkgs>' -A linuxPackages.kernel.dev
+$ nix-shell '<nixpkgs>' -A linuxPackages.kernel
+$ unpackPhase
+$ cd linux-*
+$ make -C $dev/lib/modules/*/build M=$(pwd)/drivers/net/ethernet/mellanox modules
+$ sudo insmod ./drivers/net/ethernet/mellanox/mlx5/core/mlx5_core.ko
+]]></screen>
+
+</section>
+
 </chapter>