Documentation fixes
cover Documentation fixes
Add a missing option to depmod(8) and the kmod(8) man page.
Signature · 2 lines
ciao, Marco
PATCH 1/2 Document depmod --show in depmod(8)
man/depmod.xml +3 -0
@@ -236,6 +236,9 @@ <option>-n</option> </term> <term> + <option>--show</option> + </term> + <term> <option>--dry-run</option> </term> <listitem>
Lucas De Marchi
AppliedRe: [patch 1/2] Document depmod --show in depmod(8)
Quoted 5 lines · Marco d'Itri
man/depmod.xml +0
-0@@ -236,6 +236,9 @@ <option>-n</option> </term>
man/depmod.xml
Quoted 10 lines
man/depmod.xml +3
-1<term> + <option>--show</option> + </term> + <term> <option>--dry-run</option> </term> <listitem> --
Applied.
Signature · 1 line
Lucas De Marchi
PATCH 2/2 Add the man page for kmod(8)
In reply to Marco d'Itriman/kmod.xml new file +126 -0
@@ -0,0 +1,126 @@ +<?xml version='1.0'?> +<!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<refentry id="kmod"> + <refentryinfo> + <title>kmod</title> + <productname>kmod</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Jon</firstname> + <surname>Masters</surname> + <email>[email protected]</email> + </author> + <author> + <contrib>Developer</contrib> + <firstname>Lucas</firstname> + <surname>De Marchi</surname> + <email>[email protected]</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>kmod</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>kmod</refname> + <refpurpose>Program to manage Linux Kernel modules</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>kmod</command> + <arg rep='repeat'><option>OPTIONS</option></arg> + <arg><replaceable>COMMAND</replaceable></arg> + <arg rep='repeat'><option>COMMAND_OPTIONS</option></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1><title>DESCRIPTION</title> + <para> + <command>kmod</command> is a multi-call binary which implements the + programs used to control Linux Kernel modules. Most users will only + run it using its other names. + </para> + </refsect1> + + <refsect1><title>OPTIONS</title> + <variablelist> + <varlistentry> + <term><option>-V</option> <option>--version</option> + </term> + <listitem> + <para>Show the program version and exit.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-h</option> <option>--help</option> + </term> + <listitem> + <para>Show the help message.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1><title>COMMANDS</title> + <variablelist> + <varlistentry> + <term><command>help</command></term> + <listitem> + <para>Show the help message.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><command>list</command></term> + <listitem> + <para>List the currently loaded modules.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><command>static-nodes</command></term> + <listitem> + <para>Output the static device nodes information provided by + the modules of the currently running kernel version.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>COPYRIGHT</title> + <para> + This manual page originally Copyright 2014, Marco d'Itri. + Maintained by Jon Masters and others. + </para> + </refsect1> + + <refsect1><title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>rmmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>insmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>modinfo</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> +</refentry>
man/Makefile.am +1 -1
@@ -1,5 +1,5 @@ MAN5 = depmod.d.5 modprobe.d.5 modules.dep.5 -MAN8 = depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8 modinfo.8 +MAN8 = kmod.8 depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8 modinfo.8 MAN_STUB = modules.dep.bin.5 AM_V_XSLT = $(AM_V_XSLT_$(V))
Re: [patch 2/2] Add the man page for kmod(8)
Quoted 9 lines · Marco d'Itri
man/kmod.xml new file +6
-0@@ -0,0 +1,126 @@ +<?xml version='1.0'?> +<!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<refentry id="kmod"> + <refentryinfo>
man/kmod.xml line 16
Quoted 10 lines
man/kmod.xml new file +10
-0+ <title>kmod</title> + <productname>kmod</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Jon</firstname> + <surname>Masters</surname> + <email>[email protected]</email> + </author>
I can't see how he could be an author of the kmod tool.
For other tools, it's ok since they have the same (or similar) interface as module-init-tools. But not for this one.
[ ... ]
man/kmod.xml line 100
Quoted 5 lines
man/kmod.xml new file +5
-0+ <refsect1> + <title>COPYRIGHT</title> + <para> + This manual page originally Copyright 2014, Marco d'Itri. + Maintained by Jon Masters and others.
He's not maintaining this.
Signature · 1 line
Lucas De Marchi
Re: [patch 2/2] Add the man page for kmod(8)
Quoted 1 line · Lucas De Marchi
I can't see how he could be an author of the kmod tool.
Better?
Signature · 2 lines
ciao, Marco
Add the man page for kmod(8)
man/kmod.xml new file +126 -0
@@ -0,0 +1,126 @@ +<?xml version='1.0'?> +<!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<refentry id="kmod"> + <refentryinfo> + <title>kmod</title> + <productname>kmod</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Lucas</firstname> + <surname>De Marchi</surname> + <email>[email protected]</email> + </author> + <author> + <contrib>Developer</contrib> + <firstname>Lucas</firstname> + <surname>De Marchi</surname> + <email>[email protected]</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>kmod</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>kmod</refname> + <refpurpose>Program to manage Linux Kernel modules</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>kmod</command> + <arg rep='repeat'><option>OPTIONS</option></arg> + <arg><replaceable>COMMAND</replaceable></arg> + <arg rep='repeat'><option>COMMAND_OPTIONS</option></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1><title>DESCRIPTION</title> + <para> + <command>kmod</command> is a multi-call binary which implements the + programs used to control Linux Kernel modules. Most users will only + run it using its other names. + </para> + </refsect1> + + <refsect1><title>OPTIONS</title> + <variablelist> + <varlistentry> + <term><option>-V</option> <option>--version</option> + </term> + <listitem> + <para>Show the program version and exit.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-h</option> <option>--help</option> + </term> + <listitem> + <para>Show the help message.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1><title>COMMANDS</title> + <variablelist> + <varlistentry> + <term><command>help</command></term> + <listitem> + <para>Show the help message.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><command>list</command></term> + <listitem> + <para>List the currently loaded modules.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><command>static-nodes</command></term> + <listitem> + <para>Output the static device nodes information provided by + the modules of the currently running kernel version.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>COPYRIGHT</title> + <para> + This manual page originally Copyright 2014, Marco d'Itri. + Maintained by Lucas De Marchi and others. + </para> + </refsect1> + + <refsect1><title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>rmmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>insmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>modinfo</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> +</refentry>
man/Makefile.am +1 -1
@@ -1,5 +1,5 @@ MAN5 = depmod.d.5 modprobe.d.5 modules.dep.5 -MAN8 = depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8 modinfo.8 +MAN8 = kmod.8 depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8 modinfo.8 MAN_STUB = modules.dep.bin.5 AM_V_XSLT = $(AM_V_XSLT_$(V))
Re: [patch 2/2] Add the man page for kmod(8)
Quoted 2 lines · Marco d'Itri
Quoted 1 line
I can't see how he could be an author of the kmod tool.
Better?
No, let's try again.
Signature · 2 lines
ciao, Marco
Add the man page for kmod(8)
man/kmod.xml new file +120 -0
@@ -0,0 +1,120 @@ +<?xml version='1.0'?> +<!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<refentry id="kmod"> + <refentryinfo> + <title>kmod</title> + <productname>kmod</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Lucas</firstname> + <surname>De Marchi</surname> + <email>[email protected]</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>kmod</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>kmod</refname> + <refpurpose>Program to manage Linux Kernel modules</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>kmod</command> + <arg rep='repeat'><option>OPTIONS</option></arg> + <arg><replaceable>COMMAND</replaceable></arg> + <arg rep='repeat'><option>COMMAND_OPTIONS</option></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1><title>DESCRIPTION</title> + <para> + <command>kmod</command> is a multi-call binary which implements the + programs used to control Linux Kernel modules. Most users will only + run it using its other names. + </para> + </refsect1> + + <refsect1><title>OPTIONS</title> + <variablelist> + <varlistentry> + <term><option>-V</option> <option>--version</option> + </term> + <listitem> + <para>Show the program version and exit.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-h</option> <option>--help</option> + </term> + <listitem> + <para>Show the help message.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1><title>COMMANDS</title> + <variablelist> + <varlistentry> + <term><command>help</command></term> + <listitem> + <para>Show the help message.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><command>list</command></term> + <listitem> + <para>List the currently loaded modules.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><command>static-nodes</command></term> + <listitem> + <para>Output the static device nodes information provided by + the modules of the currently running kernel version.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>COPYRIGHT</title> + <para> + This manual page originally Copyright 2014, Marco d'Itri. + Maintained by Lucas De Marchi and others. + </para> + </refsect1> + + <refsect1><title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>rmmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>insmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>modinfo</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> +</refentry>
man/Makefile.am +1 -1
@@ -1,5 +1,5 @@ MAN5 = depmod.d.5 modprobe.d.5 modules.dep.5 -MAN8 = depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8 modinfo.8 +MAN8 = kmod.8 depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8 modinfo.8 MAN_STUB = modules.dep.bin.5 AM_V_XSLT = $(AM_V_XSLT_$(V))
Lucas De Marchi
AppliedRe: [patch 2/2] Add the man page for kmod(8)
Quoted 5 lines · Marco d'Itri
Quoted 2 lines · Marco d'Itri
Quoted 1 line
I can't see how he could be an author of the kmod tool.
Better?
No, let's try again.
Applied, fixing line endings and properly formatting the patch.
Signature · 1 line
Lucas De Marchi