summaryrefslogtreecommitdiff
path: root/docs/docbook/devdoc
diff options
context:
space:
mode:
authorGerald Carter <jerry@samba.org>2003-07-16 05:34:56 +0000
committerGerald Carter <jerry@samba.org>2003-07-16 05:34:56 +0000
commit4a090ba06a54f5da179ac02bb307cc03d08831bf (patch)
treeed652ef36be7f16682c358816334f969a22f1c27 /docs/docbook/devdoc
parent95fe82670032a3a43571b46d7bbf2c26bc8cdcd9 (diff)
downloadsamba-4a090ba06a54f5da179ac02bb307cc03d08831bf.tar.gz
samba-4a090ba06a54f5da179ac02bb307cc03d08831bf.tar.bz2
samba-4a090ba06a54f5da179ac02bb307cc03d08831bf.zip
trying to get HEAD building again. If you want the code
prior to this merge, checkout HEAD_PRE_3_0_0_BETA_3_MERGE (This used to be commit adb98e7b7cd0f025b52c570e4034eebf4047b1ad)
Diffstat (limited to 'docs/docbook/devdoc')
-rw-r--r--docs/docbook/devdoc/contributing.xml3
-rw-r--r--docs/docbook/devdoc/dev-doc.xml32
-rw-r--r--docs/docbook/devdoc/modules.xml16
-rw-r--r--docs/docbook/devdoc/rpc_plugin.xml7
4 files changed, 40 insertions, 18 deletions
diff --git a/docs/docbook/devdoc/contributing.xml b/docs/docbook/devdoc/contributing.xml
index d0fb1d41a3..2583c8727a 100644
--- a/docs/docbook/devdoc/contributing.xml
+++ b/docs/docbook/devdoc/contributing.xml
@@ -35,6 +35,7 @@
because someone else was working on the same thing or because your
implementation is not the correct one.
</para>
+ </listitem>
</varlistentry>
<varlistentry>
@@ -67,6 +68,8 @@
<member>Make sure your patch complies to the samba coding style as
suggested in the coding-suggestions chapter. </member>
</simplelist>
+ </para>
+ </listitem>
</varlistentry>
<varlistentry>
diff --git a/docs/docbook/devdoc/dev-doc.xml b/docs/docbook/devdoc/dev-doc.xml
index 0ed4275972..9236b18986 100644
--- a/docs/docbook/devdoc/dev-doc.xml
+++ b/docs/docbook/devdoc/dev-doc.xml
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE book SYSTEM "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
<!ENTITY NetBIOS SYSTEM "NetBIOS.xml">
<!ENTITY Architecture SYSTEM "architecture.xml">
<!ENTITY debug SYSTEM "debug.xml">
@@ -17,6 +18,8 @@
<!ENTITY modules SYSTEM "modules.xml">
<!ENTITY packagers SYSTEM "packagers.xml">
<!ENTITY contributing SYSTEM "contributing.xml">
+<!ENTITY vfs SYSTEM "vfs.xml">
+<!ENTITY windows-deb SYSTEM "windows-debug.xml">
]>
<book id="Samba-Developers-Guide">
@@ -28,13 +31,9 @@
<surname>SAMBA Team</surname>
</author>
<address><email>samba@samba.org</email></address>
-</bookinfo>
-
-<dedication>
-<title>Abstract</title>
-
+<abstract>
<para>
-<emphasis>Last Update</emphasis> : Mon Sep 30 15:23:53 CDT 2002
+<emphasis>Last Update</emphasis> : Fri Jun 6 00:45:54 CEST 2003
</para>
<para>
@@ -45,7 +44,7 @@ the internals of various parts of samba and the SMB protocol. It's still incompl
The most recent version of this document
can be found at <ulink url="http://devel.samba.org/">http://devel.samba.org/</ulink>.
Please send updates to <ulink
-url="mailto:jelmer@samba.org">Jelmer Veenrooij</ulink>.
+url="mailto:jelmer@samba.org">Jelmer Vernooij</ulink>.
</para>
<para>
@@ -55,7 +54,20 @@ distribution. A copy can be found on-line at <ulink
url="http://www.fsf.org/licenses/gpl.txt">http://www.fsf.org/licenses/gpl.txt</ulink>
</para>
-</dedication>
+</abstract>
+
+<legalnotice>
+
+<formalpara>
+ <title>Attributions</title>
+
+ <para>
+ &attributions-dev;
+ </para>
+</formalpara>
+
+</legalnotice>
+</bookinfo>
<!-- Contents -->
<toc/>
@@ -69,6 +81,7 @@ url="http://www.fsf.org/licenses/gpl.txt">http://www.fsf.org/licenses/gpl.txt</u
&parsing;
&unix-smb;
&Tracing;
+&windows-deb;
&cifsntdomain;
&printing;
&wins;
@@ -76,6 +89,7 @@ url="http://www.fsf.org/licenses/gpl.txt">http://www.fsf.org/licenses/gpl.txt</u
&encryption;
&modules;
&rpc-plugin;
+&vfs;
&packagers;
&contributing;
diff --git a/docs/docbook/devdoc/modules.xml b/docs/docbook/devdoc/modules.xml
index 0bcdadc66c..e2eb78d6c9 100644
--- a/docs/docbook/devdoc/modules.xml
+++ b/docs/docbook/devdoc/modules.xml
@@ -40,7 +40,7 @@ the passdb subsystem has:
</para>
<para><programlisting>
-BOOL smb_register_passdb(const char *name, pdb_init_function init, int version);
+NTSTATUS smb_register_passdb(int version, const char *name, pdb_init_function init);
</programlisting></para>
<para>
@@ -99,21 +99,21 @@ The prototype for these functions is:
</para>
<para><programlisting>
-int init_module(void);
+NTSTATUS init_module(void);
</programlisting></para>
<para>This function should call one or more
-registration functions. The function should return non-zero on success and zero on
-failure.</para>
+registration functions. The function should return NT_STATUS_OK on success and
+NT_STATUS_UNSUCCESSFUL or a more useful nt error code on failure.</para>
<para>For example, pdb_ldap_init() contains: </para>
<para><programlisting>
-int pdb_ldap_init(void)
+NTSTATUS pdb_ldap_init(void)
{
- smb_register_passdb("ldapsam", pdb_init_ldapsam, PASSDB_INTERFACE_VERSION);
- smb_register_passdb("ldapsam_nua", pdb_init_ldapsam_nua, PASSDB_INTERFACE_VERSION);
- return TRUE;
+smb_register_passdb(PASSDB_INTERFACE_VERSION, "ldapsam", pdb_init_ldapsam);
+smb_register_passdb(PASSDB_INTERFACE_VERSION, "ldapsam_nua", pdb_init_ldapsam_nua);
+ return NT_STATUS_OK;
}
</programlisting></para>
diff --git a/docs/docbook/devdoc/rpc_plugin.xml b/docs/docbook/devdoc/rpc_plugin.xml
index c83742a247..287e35b0be 100644
--- a/docs/docbook/devdoc/rpc_plugin.xml
+++ b/docs/docbook/devdoc/rpc_plugin.xml
@@ -50,12 +50,17 @@ rpc_pipe_register_commands(). This function takes the following arguments:
</para>
<para><programlisting>
-int rpc_pipe_register_commands(const char *clnt, const char *srv,
+NTSTATUS rpc_pipe_register_commands(int version, const char *clnt, const char *srv,
const struct api_struct *cmds, int size);
</programlisting></para>
<variablelist>
+<varlistentry><term>version</term>
+<listitem><para>Version number of the RPC interface. Use the define <emphasis>SMB_RPC_INTERFACE_VERSION</emphasis> for this
+argument.</para></listitem>
+</varlistentry>
+
<varlistentry><term>clnt</term>
<listitem><para>the Client name of the named pipe</para></listitem>
</varlistentry>