From: Lucas De Marchi Date: Thu, 12 Jan 2012 15:47:21 +0000 (-0200) Subject: man: build depmod man page X-Git-Tag: v4~33 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6d96056303cd9e7cafc612b7d7fa19427b4bb0e8;p=thirdparty%2Fkmod.git man: build depmod man page --- diff --git a/man/Makefile.am b/man/Makefile.am index d7e0f9eb..2ce9f6e1 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1,5 +1,5 @@ MAN5 = depmod.d.5 modprobe.d.5 modules.dep.5 -MAN8 = +MAN8 = depmod.8 dist_man_MANS = $(MAN5) $(MAN8) $(MAN_STUB) diff --git a/man/depmod.sgml b/man/depmod.sgml deleted file mode 100644 index 97cc2c68..00000000 --- a/man/depmod.sgml +++ /dev/null @@ -1,285 +0,0 @@ -Debian GNU/Linux"> - DocBook"> - SGML"> -]> - - - - - -
- jcm@jonmasters.org -
- - Jon - Masters - - 2011-05-31 - - - depmod - 8 - - - depmod program to generate modules.dep and map files. - - - - depmod - - - - - - - - - - - - - depmod - - - - - - - - - - - - - - DESCRIPTION - - Linux kernel modules can provide services (called "symbols") for - other modules to use (using one of the EXPORT_SYMBOL variants in the - code). If a second module uses this symbol, that second module clearly - depends on the first module. These dependencies can get quite complex. - - - depmod creates a list of module dependencies - by reading each module under - /lib/modules/version - and determining what symbols it exports and what symbols it - needs. By default, this list is written to - modules.dep, and a binary hashed version named - modules.dep.bin, in the same directory. If - filenames are given on the command line, only those modules are - examined (which is rarely useful unless all modules are listed). - depmod also creates a list of symbols provided - by modules in the file named modules.symbols - and its binary hashed version, modules.symbols.bin. - Finally, depmod will output a file named - modules.devname if modules supply special - device names (devname) that should be populated in /dev on boot - (by a utility such as udev). - - - If a version is provided, then that - kernel version's module directory is used rather than the - current kernel version (as returned by uname -r). - - - - OPTIONS - - - - - - - Probe all modules. This option is enabled by default if no - file names are given in the command-line. - - - - - - - - - This option scans to see if any modules are newer than the - modules.dep file before any work is done: - if not, it silently exits rather than regenerating the files. - - - - - - - - - If your modules are not currently in the (normal) - directory - /lib/modules/version, - but in a staging area, you can specify a - basedir which is prepended to - the directory name. This - basedir is stripped from the - resulting modules.dep file, so it - is ready to be moved into the normal location. Use this option - if you are a distribution vendor who needs to pre-generate the - meta-data files rather than running depmod again later. - - - - - - - - - This option overrides the default configuration directory at - /etc/depmod.d/. - - - - - - - - - When combined with the option, this - reports any symbols which a module needs which are not - supplied by other modules or the kernel. Normally, any - symbols not provided by modules are assumed to be - provided by the kernel (which should be true in a - perfect world), but this assumption can break espencially - when additionally updated third party drivers are not - correctly installed or were built incorrectly. - - - - - - - - - When combined with the option, this - reports any symbol versions supplied by modules that do - not match with the symbol versions provided by the - kernel in its Module.symvers. - This option is mutually incompatible with . - - - - - - - - - Supplied with the System.map produced - when the kernel was built, this allows the - option to report unresolved symbols. - This option is mutually incompatible with . - - - - - - - - - Print the help message and exit. - - - - - - - - - This sends the resulting modules.dep and the various - map files to standard output rather than writing them into - the module directory. - - - - - - - - - Some architectures prefix symbols with an extraneous character. - This specifies a prefix character (for example '_') to ignore. - - - - - - - - - In verbose mode, depmod will print (to stdout) - all the symbols each module depends on and the module's file name - which provides that symbol. - - - - - - - - - Show version of program and exit. See below for caveats when - run on older kernels. - - - - - - - - - Warn on duplicate dependencies, aliases, symbol versions, etc. - - - - - - - COPYRIGHT - - - This manual page originally Copyright 2002, Rusty Russell, - IBM Corporation. Portions Copyright Jon Masters, and others. - - - - SEE ALSO - - - depmod.d5 - , - - modprobe8 - , - - modules.dep5 - - - - - - diff --git a/man/depmod.xml b/man/depmod.xml new file mode 100644 index 00000000..9f091488 --- /dev/null +++ b/man/depmod.xml @@ -0,0 +1,275 @@ + + + + + + depmod + kmod + + + + Developer + Jon + Masters + jcm@jonmasters.org + + + Developer + Robby + Workman + rworkman@slackware.com + + + Developer + Lucas + De Marchi + lucas.demarchi@profusion.mobi + + + + + + depmod + 8 + + + + depmod + + Generate modules.dep and map files. + + + + + + depmod + + + + + + + + + + + + + + depmod + + + + + + + + + + + + + + DESCRIPTION + + Linux kernel modules can provide services (called "symbols") for other + modules to use (using one of the EXPORT_SYMBOL variants in the code). If + a second module uses this symbol, that second module clearly depends on + the first module. These dependencies can get quite complex. + + depmod creates a list of module dependencies by + reading each module under + /lib/modules/version and + determining what symbols it exports and what symbols it needs. By + default, this list is written to modules.dep, and a + binary hashed version named modules.dep.bin, in the + same directory. If filenames are given on the command line, only those + modules are examined (which is rarely useful unless all modules are + listed). depmod also creates a list of symbols + provided by modules in the file named + modules.symbols and its binary hashed version, + modules.symbols.bin. Finally, + depmod will output a file named + modules.devname if modules supply special device + names (devname) that should be populated in /dev on boot (by a utility + such as udev). If a version is + provided, then that kernel version's module directory is used rather than + the current kernel version (as returned by uname -r). + + + OPTIONS + + + + + + + Probe all modules. This option is enabled by default if no + file names are given in the command-line. + + + + + + + + + This option scans to see if any modules are newer than the + modules.dep file before any work is done: + if not, it silently exits rather than regenerating the files. + + + + + + + + + + + If your modules are not currently in the (normal) directory + /lib/modules/version, + but in a staging area, you can specify a + basedir which is prepended to the + directory name. This basedir is + stripped from the resulting modules.dep file, + so it is ready to be moved into the normal location. Use this + option if you are a distribution vendor who needs to pre-generate + the meta-data files rather than running depmod again later. + + + + + + + + + This option overrides the default configuration directory at + /etc/depmod.d/. + + + + + + + + + When combined with the option, this reports any + symbols which a module needs which are not supplied by other + modules or the kernel. Normally, any symbols not provided by + modules are assumed to be provided by the kernel (which should be + true in a perfect world), but this assumption can break espencially + when additionally updated third party drivers are not correctly + installed or were built incorrectly. + + + + + + + + + When combined with the option, this + reports any symbol versions supplied by modules that do + not match with the symbol versions provided by the + kernel in its Module.symvers. + This option is mutually incompatible with . + + + + + + + + + Supplied with the System.map produced when the + kernel was built, this allows the option to + report unresolved symbols. This option is mutually incompatible + with . + + + + + + + + + Print the help message and exit. + + + + + + + + + This sends the resulting modules.dep and the various map files to + standard output rather than writing them into the module directory. + + + + + + + + + Some architectures prefix symbols with an extraneous character. + This specifies a prefix character (for example '_') to ignore. + + + + + + + + + In verbose mode, depmod will print (to stdout) + all the symbols each module depends on and the module's file name + which provides that symbol. + + + + + + + + + Show version of program and exit. See below for caveats when + run on older kernels. + + + + + + + + + Warn on duplicate dependencies, aliases, symbol versions, etc. + + + + + + + COPYRIGHT + + This manual page originally Copyright 2002, Rusty Russell, + IBM Corporation. Portions Copyright Jon Masters, and others. + + + + SEE ALSO + + + depmod.d5 + , + + modprobe8 + , + + modules.dep5 + + + +