[PATCH] update the man pages for the prefork process model

[Gary Lockyer]

Update the samba man page and document the process models for the -M
option. including the new prefork option.

Review appreciated.

Gary
-------------- next part --------------
From 482ea06e9dcd6efc757a180e7d4e67eff3f07550 Mon Sep 17 00:00:00 2001
From: Gary Lockyer <gary at catalyst.net.nz>
Date: Wed, 20 Sep 2017 09:14:10 +1200
Subject: [PATCH] man pages: document prefrok proces model

Document the process model options -M

Signed-off-by: Gary Lockyer <gary at catalyst.net.nz>
---
 docs-xml/manpages/samba.8.xml                | 31 ++++++++++++++++++++++++----
 docs-xml/smbdotconf/base/preforkchildren.xml |  4 +++-
 2 files changed, 30 insertions(+), 5 deletions(-)

diff --git a/docs-xml/manpages/samba.8.xml b/docs-xml/manpages/samba.8.xml
index d4c5568..c7b1449 100644
--- a/docs-xml/manpages/samba.8.xml
+++ b/docs-xml/manpages/samba.8.xml
@@ -105,10 +105,33 @@
 		<listitem><para>This parameter can be used to specify the
 		"process model" samba should use. This determines
 		how concurrent clients are handled. Available process
-		models include <emphasis>single</emphasis> (everything in
-		a single process), <emphasis>standard</emphasis> (similar
-		behaviour to that of Samba 3), <emphasis>thread</emphasis>
-		(single process, different threads.
+		models include
+		<itemizedlist>
+			<listitem><para><emphasis>single</emphasis></para>
+			<para>All services run in a single process, not
+			recommended for production configurations.
+			</para></listitem>
+
+			<listitem><para><emphasis>standard</emphasis></para>
+			<para>A process is created for each service,
+			and for those services that support it (currently only
+			ldap and netlogon) a new processes is started
+			for each new connection.</para></listitem>
+
+			<listitem><para><emphasis>prefork</emphasis></para>
+			<para>A process is started for each service, and extra
+			worker processes are started for those services that
+			support it (currently only ldap).
+			Requests for services not supporting prefork are handled
+			by a single process for that service.</para>
+			<para>The number of worker processes started is
+			controlled by the
+			<citerefentry><refentrytitle>smb.conf</refentrytitle>
+			<manvolnum>5</manvolnum></citerefentry> parameter
+		        <smbconfoption name="prefork children"/>
+			, which defaults to 1.
+			</para></listitem>
+		</itemizedlist>
 		</para></listitem>
 		</varlistentry>
 
diff --git a/docs-xml/smbdotconf/base/preforkchildren.xml b/docs-xml/smbdotconf/base/preforkchildren.xml
index 720e439..c4bf1ab 100644
--- a/docs-xml/smbdotconf/base/preforkchildren.xml
+++ b/docs-xml/smbdotconf/base/preforkchildren.xml
@@ -4,7 +4,9 @@
                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 <description>
 	<para>This option controls the number of worker processes that are
-		started for each service when prefork process model is enabled.
+		started for each service when prefork process model is enabled
+		(see <citerefentry><refentrytitle>samba</refentrytitle>
+			<manvolnum>8</manvolnum></citerefentry> -M)
 		The prefork children are only started for those services that
 		support prefork (currently only ldap). For processes that don't
 		support preforking all requests are handled by a single process
-- 
2.7.4

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 473 bytes
Desc: OpenPGP digital signature
URL: <http://lists.samba.org/pipermail/samba-technical/attachments/20170920/24f8747e/signature.sig>