linux-modules.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [patch 0/2] Documentation fixes
@ 2014-09-17  3:12 Marco d'Itri
  2014-09-17  3:12 ` [patch 1/2] Document depmod --show in depmod(8) Marco d'Itri
  2014-09-17  3:12 ` [patch 2/2] Add the man page for kmod(8) Marco d'Itri
  0 siblings, 2 replies; 8+ messages in thread
From: Marco d'Itri @ 2014-09-17  3:12 UTC (permalink / raw)
  To: linux-modules

Add a missing option to depmod(8) and the kmod(8) man page.

-- 
ciao,
Marco


^ permalink raw reply	[flat|nested] 8+ messages in thread

* [patch 1/2] Document depmod --show in depmod(8)
  2014-09-17  3:12 [patch 0/2] Documentation fixes Marco d'Itri
@ 2014-09-17  3:12 ` Marco d'Itri
  2014-09-20 14:21   ` Lucas De Marchi
  2014-09-17  3:12 ` [patch 2/2] Add the man page for kmod(8) Marco d'Itri
  1 sibling, 1 reply; 8+ messages in thread
From: Marco d'Itri @ 2014-09-17  3:12 UTC (permalink / raw)
  To: linux-modules

--- a/man/depmod.xml
+++ b/man/depmod.xml
@@ -236,6 +236,9 @@
           <option>-n</option>
         </term>
         <term>
+          <option>--show</option>
+        </term>
+        <term>
           <option>--dry-run</option>
         </term>
         <listitem>



^ permalink raw reply	[flat|nested] 8+ messages in thread

* [patch 2/2] Add the man page for kmod(8)
  2014-09-17  3:12 [patch 0/2] Documentation fixes Marco d'Itri
  2014-09-17  3:12 ` [patch 1/2] Document depmod --show in depmod(8) Marco d'Itri
@ 2014-09-17  3:12 ` Marco d'Itri
  2014-09-20 14:20   ` Lucas De Marchi
  1 sibling, 1 reply; 8+ messages in thread
From: Marco d'Itri @ 2014-09-17  3:12 UTC (permalink / raw)
  To: linux-modules

--- /dev/null
+++ b/man/kmod.xml
@@ -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>jcm@jonmasters.org</email>
+      </author>
+      <author>
+        <contrib>Developer</contrib>
+        <firstname>Lucas</firstname>
+        <surname>De Marchi</surname>
+        <email>lucas.de.marchi@gmail.com</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>
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -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))



^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [patch 2/2] Add the man page for kmod(8)
  2014-09-17  3:12 ` [patch 2/2] Add the man page for kmod(8) Marco d'Itri
@ 2014-09-20 14:20   ` Lucas De Marchi
  2014-09-20 19:10     ` Marco d'Itri
  0 siblings, 1 reply; 8+ messages in thread
From: Lucas De Marchi @ 2014-09-20 14:20 UTC (permalink / raw)
  To: Marco d'Itri; +Cc: linux-modules

On Wed, Sep 17, 2014 at 12:12 AM, Marco d'Itri <md@linux.it> wrote:
> --- /dev/null
> +++ b/man/kmod.xml
> @@ -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>jcm@jonmasters.org</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.

[ ... ]

> +  <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.


-- 

Lucas De Marchi

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [patch 1/2] Document depmod --show in depmod(8)
  2014-09-17  3:12 ` [patch 1/2] Document depmod --show in depmod(8) Marco d'Itri
@ 2014-09-20 14:21   ` Lucas De Marchi
  0 siblings, 0 replies; 8+ messages in thread
From: Lucas De Marchi @ 2014-09-20 14:21 UTC (permalink / raw)
  To: Marco d'Itri; +Cc: linux-modules

On Wed, Sep 17, 2014 at 12:12 AM, Marco d'Itri <md@linux.it> wrote:
> --- a/man/depmod.xml
> +++ b/man/depmod.xml
> @@ -236,6 +236,9 @@
>            <option>-n</option>
>          </term>
>          <term>
> +          <option>--show</option>
> +        </term>
> +        <term>
>            <option>--dry-run</option>
>          </term>
>          <listitem>
>
>
> --

Applied.

-- 

Lucas De Marchi

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [patch 2/2] Add the man page for kmod(8)
  2014-09-20 14:20   ` Lucas De Marchi
@ 2014-09-20 19:10     ` Marco d'Itri
  2014-09-20 19:12       ` Marco d'Itri
  0 siblings, 1 reply; 8+ messages in thread
From: Marco d'Itri @ 2014-09-20 19:10 UTC (permalink / raw)
  To: Lucas De Marchi; +Cc: linux-modules

[-- Attachment #1: Type: text/plain, Size: 146 bytes --]

On Sep 20, Lucas De Marchi <lucas.de.marchi@gmail.com> wrote:

> I can't see how he could be an author of the kmod tool.
Better?

-- 
ciao,
Marco

[-- Attachment #2: add_kmod_man --]
[-- Type: text/plain, Size: 4169 bytes --]

Add the man page for kmod(8)

--- /dev/null
+++ b/man/kmod.xml
@@ -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>lucas.de.marchi@gmail.com</email>
+      </author>
+      <author>
+        <contrib>Developer</contrib>
+        <firstname>Lucas</firstname>
+        <surname>De Marchi</surname>
+        <email>lucas.de.marchi@gmail.com</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>
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -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))

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [patch 2/2] Add the man page for kmod(8)
  2014-09-20 19:10     ` Marco d'Itri
@ 2014-09-20 19:12       ` Marco d'Itri
  2014-09-22 12:06         ` Lucas De Marchi
  0 siblings, 1 reply; 8+ messages in thread
From: Marco d'Itri @ 2014-09-20 19:12 UTC (permalink / raw)
  To: Lucas De Marchi, linux-modules

[-- Attachment #1: Type: text/plain, Size: 154 bytes --]

On Sep 20, Marco d'Itri <md@linux.it> wrote:

> > I can't see how he could be an author of the kmod tool.
> Better?
No, let's try again.

-- 
ciao,
Marco

[-- Attachment #2: add_kmod_man --]
[-- Type: text/plain, Size: 3972 bytes --]

Add the man page for kmod(8)

--- /dev/null
+++ b/man/kmod.xml
@@ -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>lucas.de.marchi@gmail.com</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>
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -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))

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [patch 2/2] Add the man page for kmod(8)
  2014-09-20 19:12       ` Marco d'Itri
@ 2014-09-22 12:06         ` Lucas De Marchi
  0 siblings, 0 replies; 8+ messages in thread
From: Lucas De Marchi @ 2014-09-22 12:06 UTC (permalink / raw)
  To: Lucas De Marchi, linux-modules

On Sat, Sep 20, 2014 at 4:12 PM, Marco d'Itri <md@linux.it> wrote:
> On Sep 20, Marco d'Itri <md@linux.it> wrote:
>
>> > 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.

-- 
Lucas De Marchi

^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2014-09-22 12:06 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-09-17  3:12 [patch 0/2] Documentation fixes Marco d'Itri
2014-09-17  3:12 ` [patch 1/2] Document depmod --show in depmod(8) Marco d'Itri
2014-09-20 14:21   ` Lucas De Marchi
2014-09-17  3:12 ` [patch 2/2] Add the man page for kmod(8) Marco d'Itri
2014-09-20 14:20   ` Lucas De Marchi
2014-09-20 19:10     ` Marco d'Itri
2014-09-20 19:12       ` Marco d'Itri
2014-09-22 12:06         ` Lucas De Marchi

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).