From: Lucas De Marchi Date: Mon, 9 Sep 2024 06:36:12 +0000 (-0500) Subject: man: Provide examples for paths X-Git-Tag: v34~374 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e2536ab434ec29c3b39c09a85e29714175253b48;p=thirdparty%2Fkmod.git man: Provide examples for paths Add some examples to help clarifying each part of the paths. Signed-off-by: Lucas De Marchi Link: https://github.com/kmod-project/kmod/pull/100 --- diff --git a/man/depmod.8.scd b/man/depmod.8.scd index 7179fd35..cb9cfb3d 100644 --- a/man/depmod.8.scd +++ b/man/depmod.8.scd @@ -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 , 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