Skip to content

Commit

Permalink
Rephrasing a little bit README.md and removing one false todo item fr…
Browse files Browse the repository at this point in the history
…om lkm_parameters
  • Loading branch information
tpiekarski committed Aug 21, 2020
1 parent 2760f0b commit 12a5453
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,22 @@
[Modules](#modules) / [Building](#building) / [Make](#make) / [Testing](#testing) / [PoC](#poc) / [Rehearsal](#rehearsal)
/ [Notes](#notes) / [Disclaimer](#disclaimer) / [License](#license) / [Books](#books) / [Links](#links)

The Linux Kernel Module (LKM) Sandbox is a collection of different modules to learn, test and experiment with
The Linux Kernel Module (LKM) Sandbox is a collection of different modules to learn, discover and experiment with
the development of Linux Kernel Modules. The purpose of this repository is also to practice development within
the Linux Kernel and study miscellaneous concepts before moving on to submit the very first patch to the kernel.

Most of the modules illustrate one concept and shows how to use the Kernel API. A few of the modules combine more
than one concept to present concepts working together. For example the module *[lkm_device](lkm_device.c)* is
accessing a character device and storing its major number in /proc and the module *[lkm_mem](lkm_mem.c)* is
exposing memory/swap information by files in /proc.
Most of the modules illustrate one concept and show how to use the Kernel API. A few of the modules combine more
than one concept to present how concepts are working together. For example the module *[lkm_device](lkm_device.c)*
is accessing a character device and storing its major number in /proc. Or the module *[lkm_mem](lkm_mem.c)* is
exposing memory/swap information by files in /proc as well.

I hope it can be valuable for other developers which try to approach the Linux Kernel.

## [Modules](#modules)

No.|Module|Source|Description
---|---|---|---
1|LKM DebugFS|[lkm_debugfs.c](lkm_debugfs.c)|Module showing how to use the debugging filesystem
1|LKM DebugFS|[lkm_debugfs.c](lkm_debugfs.c)|Module showing how to use the debugging filesystem *debugfs*
2|LKM Device|[lkm_device.c](lkm_device.c)|Module showing how to operate with character devices and storing device information in /proc
3|LKM Device Numbers|[lkm_device_numbers.c](lkm_device_numbers.c)|Illustrating statically and dynamically allocated device numbers
3|LKM Memory|[lkm_mem.c](lkm_mem.c)|Module exposing memory and swap information to /proc
Expand Down
2 changes: 1 addition & 1 deletion lkm_parameters.c
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ static int __init lkm_parameters_init(void)

static void __exit lkm_parameters_exit(void)
{
// nothing todo here
// nothing to do here
}

module_init(lkm_parameters_init);
Expand Down

0 comments on commit 12a5453

Please sign in to comment.