Skip to content

Commit ad55d48

Browse files
committed
We are making module documentation self evident
Remove this now before we forget to remove it when we are done with the refactor
1 parent 2075fba commit ad55d48

File tree

1 file changed

+1
-21
lines changed

1 file changed

+1
-21
lines changed

README.adoc

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -784,26 +784,6 @@ enables all log levels, and is basically the same as:
784784

785785
except that you don't need to know what is the maximum level.
786786

787-
=== Module documentation
788-
789-
....
790-
head kernel_module/modulename.c
791-
grep 'insmod /modulename\.ko' README.adoc
792-
....
793-
794-
Many of the modules have userland test scripts / executables with the same name as the module, e.g. form inside the guest:
795-
796-
....
797-
/modulename.sh
798-
/modulename.out
799-
....
800-
801-
The sources of those tests will further clarify what the corresponding kernel modules does. To find them on the host, do a quick:
802-
803-
....
804-
git ls-files | grep modulename
805-
....
806-
807787
=== Rebuild
808788

809789
After making changes to a package, you must explicitly request it to be rebuilt.
@@ -3569,7 +3549,7 @@ Anonymous inodes allow getting multiple file descriptors from a single filesyste
35693549

35703550
Bibliography: https://stackoverflow.com/questions/4508998/what-is-an-anonymous-inode-in-linux
35713551

3572-
=== Linux kernel asynchronous
3552+
=== Linux kernel asynchronous APIs
35733553

35743554
In this section we will document asynchronous APIs of Linux kernel, especially kthread-related scheduled events.
35753555

0 commit comments

Comments
 (0)