]> git.ipfire.org Git - thirdparty/kmod.git/commitdiff
man: Provide examples for paths
authorLucas De Marchi <lucas.de.marchi@gmail.com>
Mon, 9 Sep 2024 06:36:12 +0000 (01:36 -0500)
committerLucas De Marchi <lucas.de.marchi@gmail.com>
Tue, 10 Sep 2024 18:25:46 +0000 (13:25 -0500)
Add some examples to help clarifying each part of the paths.

Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/100
man/depmod.8.scd

index 7179fd35c0f477e7836adbbcb37216893c07237c..cb9cfb3d1e1482d312c12407816253416ba697eb 100644 (file)
@@ -59,12 +59,26 @@ rather than the current kernel version (as returned by *uname -r*).
        distribution vendor who needs to pre-generate the meta-data files rather
        than running *depmod* again later.
 
+       Example:
+               depmod -b /my/build/staging/dir/
+
+       This expects all input files under
+       _/my/build/staging/dir/@MODULE_DIRECTORY@/$(uname -r)_ and generates
+       index files under that same directory.
+
 *-m* _moduledir_
 *--moduledir* _moduledir_
        Override the module directory <MODULEDIR>, which defaults to
        @MODULE_DIRECTORY@ prefix set at build time. This is useful when
        building *modules.dep* file in _basedir_ for a system that uses a
-       different prefix.
+       different prefix, e.g. _/usr/lib/modules_ vs _/lib/modules_.
+
+       Example:
+               depmod -b /tmp/build -m /kernel-modules
+
+       This expects all input files under
+       _/tmp/build/kernel-modules/$(uname -r)_ and generates index files under
+       that same directory.
 
 *-o* _outdir_
 *--outdir* _outdir_
@@ -74,6 +88,13 @@ rather than the current kernel version (as returned by *uname -r*).
        _basedir_ it will result in the input being that directory, but the output
        being the one set by _outdir_.
 
+       Example:
+               depmod -o /my/build/staging/dir/
+
+       This expects all input files under
+       _@MODULE_DIRECTORY@/$(uname -r)_ and generates index files under
+       _/my/build/staging/dir@MODULE_DIRECTORY@/$(uname -r)_.
+
 *-C*  _file_ _or_ _directory_
 *--config* _file_ _or_ _directory_
        This option overrides the default configuration files. See