svn commit: samba r26065 - in branches/4.0-python: . source/scripting/python/samba source/scripting/swig source/selftest

[jelmer at samba.org]

Author: jelmer
Date: 2007-11-20 13:42:07 +0000 (Tue, 20 Nov 2007)
New Revision: 26065

WebSVN: http://websvn.samba.org/cgi-bin/viewcvs.cgi?view=rev&root=samba&rev=26065

Log:
Add ability to generate API documentation for the python code.
Modified:
   branches/4.0-python/
   branches/4.0-python/.bzrignore
   branches/4.0-python/source/scripting/python/samba/upgrade.py
   branches/4.0-python/source/scripting/swig/config.mk
   branches/4.0-python/source/selftest/samba4_tests.sh


Changeset:

Property changes on: branches/4.0-python
___________________________________________________________________
Name: bzr:revision-info
...skipped...
Name: bzr:revision-id:v3-trunk0
...skipped...

Modified: branches/4.0-python/.bzrignore
===================================================================
--- branches/4.0-python/.bzrignore	2007-11-20 12:53:02 UTC (rev 26064)
+++ branches/4.0-python/.bzrignore	2007-11-20 13:42:07 UTC (rev 26065)
@@ -237,3 +237,5 @@
 source/auth/auth_util.h
 source/librpc/rpc/dcerpc_wrap.c
 source/librpc/rpc/dcerpc.py
+source/libcli/swig/libcli_nbt.py
+source/apidocs

Modified: branches/4.0-python/source/scripting/python/samba/upgrade.py
===================================================================
--- branches/4.0-python/source/scripting/python/samba/upgrade.py	2007-11-20 12:53:02 UTC (rev 26064)
+++ branches/4.0-python/source/scripting/python/samba/upgrade.py	2007-11-20 13:42:07 UTC (rev 26065)
@@ -1,3 +1,4 @@
+#!/usr/bin/python
 #
 #	backend code for upgrading from Samba3
 #	Copyright Jelmer Vernooij 2005-2007
@@ -4,6 +5,8 @@
 #	Released under the GNU GPL v3 or later
 #
 
+"""Support code for upgrading from Samba 3 to Samba 4."""
+
 from provision import findnss
 import provision
 import grp
@@ -28,6 +31,7 @@
 #
 
 def upgrade_registry(regdb,prefix,ldb):
+    """Migrate registry contents."""
     assert regdb is not None:
 	prefix_up = prefix.upper()
 	ldif = []
@@ -83,6 +87,7 @@
 	return ldif
 
 def upgrade_sam_account(ldb,acc,domaindn,domainsid):
+    """Upgrade a SAM account."""
     if acc.nt_username is None or acc.nt_username == "":
 		acc.nt_username = acc.username
 
@@ -135,6 +140,7 @@
 	return ldif
 
 def upgrade_sam_group(group,domaindn):
+    """Upgrade a SAM group."""
 	if group.sid_name_use == 5: # Well-known group
 		return None
 

Modified: branches/4.0-python/source/scripting/swig/config.mk
===================================================================
--- branches/4.0-python/source/scripting/swig/config.mk	2007-11-20 12:53:02 UTC (rev 26064)
+++ branches/4.0-python/source/scripting/swig/config.mk	2007-11-20 13:42:07 UTC (rev 26065)
@@ -11,3 +11,9 @@
 clean::
 	@echo "Removing SWIG output files"
 	@-rm -f scripting/swig/tdb.pyc scripting/swig/tdb.py
+
+
+PYDOCTOR_MODULES=bin/python/ldb.py bin/python/auth.py bin/python/credentials.py bin/python/registry.py
+
+pydoctor::
+	LD_LIBRARY_PATH=bin/shared PYTHONPATH=bin/python pydoctor --make-html --docformat=restructedtext --add-package scripting/python/samba/ $(addprefix --add-module , $(PYDOCTOR_MODULES))

Modified: branches/4.0-python/source/selftest/samba4_tests.sh
===================================================================
--- branches/4.0-python/source/selftest/samba4_tests.sh	2007-11-20 12:53:02 UTC (rev 26064)
+++ branches/4.0-python/source/selftest/samba4_tests.sh	2007-11-20 13:42:07 UTC (rev 26065)
@@ -237,8 +237,8 @@
 
 DATADIR=$samba4srcdir/../testdata
 
-plantest "parse samba3" none $samba4bindir/smbscript $DATADIR/samba3/verify $CONFIGURATION $DATADIR/samba3
-plantest "js.samba3sam" none $SCRIPTDIR/samba3sam.js $CONFIGURATION `pwd` $DATADIR/samba3/
+plantest "upgrade.samba3.verify" none $samba4bindir/smbscript $DATADIR/samba3/verify $CONFIGURATION $DATADIR/samba3
+plantest "upgrade.samba3.sam" none $SCRIPTDIR/samba3sam.js $CONFIGURATION `pwd` $DATADIR/samba3/
 
 rm -rf $PREFIX/upgrade
 mkdir -p $PREFIX/upgrade