docs: Fix typo.
[Samba/wip.git] / wscript
blob83c82e354087743366c675a8eba949df7badda1f
1 #!/usr/bin/env python
3 srcdir = '.'
4 blddir = 'bin'
6 APPNAME='samba'
7 VERSION=None
9 import sys, os, tempfile
10 sys.path.insert(0, srcdir+"/buildtools/wafsamba")
11 import wafsamba, Options, samba_dist, Scripting, Utils, samba_version
14 samba_dist.DIST_DIRS('.')
15 samba_dist.DIST_BLACKLIST('.gitignore .bzrignore source4/selftest/provisions/alpha13 source4/selftest/provisions/release-4-0-0/')
17 # install in /usr/local/samba by default
18 Options.default_prefix = '/usr/local/samba'
20 # This callback optionally takes a list of paths as arguments:
21 # --with-system_mitkrb5 /path/to/krb5 /another/path
22 def system_mitkrb5_callback(option, opt, value, parser):
23 setattr(parser.values, option.dest, True)
24 value = []
25 for arg in parser.rargs:
26 # stop on --foo like options
27 if arg[:2] == "--" and len(arg) > 2:
28 break
29 value.append(arg)
30 if len(value)>0:
31 del parser.rargs[:len(value)]
32 setattr(parser.values, option.dest, value)
34 def set_options(opt):
35 opt.BUILTIN_DEFAULT('NONE')
36 opt.PRIVATE_EXTENSION_DEFAULT('samba4')
37 opt.RECURSE('lib/replace')
38 opt.RECURSE('dynconfig')
39 opt.RECURSE('lib/ldb')
40 opt.RECURSE('lib/ntdb')
41 opt.RECURSE('selftest')
42 opt.RECURSE('source4/lib/tls')
43 opt.RECURSE('lib/nss_wrapper')
44 opt.RECURSE('lib/socket_wrapper')
45 opt.RECURSE('lib/uid_wrapper')
46 opt.RECURSE('pidl')
47 opt.RECURSE('source3')
48 opt.RECURSE('lib/util')
50 opt.add_option('--with-system-mitkrb5',
51 help='enable system MIT krb5 build (includes Samba 4 client and Samba 3 code base).'+
52 'You may specify list of paths where Kerberos is installed (e.g. /usr/local /usr/kerberos) to search krb5-config',
53 action='callback', callback=system_mitkrb5_callback, dest='with_system_mitkrb5', default=False)
55 opt.add_option('--without-ad-dc',
56 help='disable AD DC functionality (enables Samba 4 client and Samba 3 code base).',
57 action='store_true', dest='without_ad_dc', default=False)
59 opt.add_option('--with-pie',
60 help=("Build Position Independent Executables " +
61 "(default if supported by compiler)"),
62 action="store_true", dest='enable_pie')
63 opt.add_option('--without-pie',
64 help=("Disable Position Independent Executable builds"),
65 action="store_false", dest='enable_pie')
67 gr = opt.option_group('developer options')
70 opt.tool_options('python') # options for disabling pyc or pyo compilation
71 # enable options related to building python extensions
74 def configure(conf):
75 version = samba_version.load_version(env=conf.env)
77 conf.DEFINE('CONFIG_H_IS_FROM_SAMBA', 1)
78 conf.DEFINE('_SAMBA_BUILD_', version.MAJOR, add_to_cflags=True)
79 conf.DEFINE('HAVE_CONFIG_H', 1, add_to_cflags=True)
81 if Options.options.developer:
82 conf.ADD_CFLAGS('-DDEVELOPER -DDEBUG_PASSWORD')
83 conf.env.DEVELOPER = True
85 conf.ADD_EXTRA_INCLUDES('#include/public #source4 #lib #source4/lib #source4/include #include #lib/replace')
87 conf.RECURSE('lib/replace')
89 conf.find_program('perl', var='PERL', mandatory=True)
90 conf.find_program('xsltproc', var='XSLTPROC')
92 conf.SAMBA_CHECK_PYTHON(mandatory=True, version=(2,5,0))
93 conf.SAMBA_CHECK_PYTHON_HEADERS(mandatory=True)
95 if sys.platform == 'darwin' and not conf.env['HAVE_ENVIRON_DECL']:
96 # Mac OSX needs to have this and it's also needed that the python is compiled with this
97 # otherwise you face errors about common symbols
98 if not conf.CHECK_SHLIB_W_PYTHON("Checking if -fno-common is needed"):
99 conf.ADD_CFLAGS('-fno-common')
100 if not conf.CHECK_SHLIB_W_PYTHON("Checking if -undefined dynamic_lookup is not need"):
101 conf.env.append_value('shlib_LINKFLAGS', ['-undefined', 'dynamic_lookup'])
103 if sys.platform == 'darwin':
104 conf.ADD_LDFLAGS('-framework CoreFoundation')
106 if int(conf.env['PYTHON_VERSION'][0]) >= 3:
107 raise Utils.WafError('Python version 3.x is not supported by Samba yet')
109 conf.RECURSE('dynconfig')
110 conf.RECURSE('lib/ldb')
112 if Options.options.with_system_mitkrb5:
113 conf.PROCESS_SEPARATE_RULE('system_mitkrb5')
114 if not (Options.options.without_ad_dc or Options.options.with_system_mitkrb5):
115 conf.DEFINE('AD_DC_BUILD_IS_ENABLED', 1)
116 # Only process heimdal_build for non-MIT KRB5 builds
117 # When MIT KRB5 checks are done as above, conf.env.KRB5_VENDOR will be set
118 # to the lowcased output of 'krb5-config --vendor'.
119 # If it is not set or the output is 'heimdal', we are dealing with
120 # system-provided or embedded Heimdal build
121 if conf.CONFIG_GET('KRB5_VENDOR') in (None, 'heimdal'):
122 conf.RECURSE('source4/heimdal_build')
123 conf.RECURSE('source4/lib/tls')
124 conf.RECURSE('source4/ntvfs/sysdep')
125 conf.RECURSE('lib/util')
126 conf.RECURSE('lib/ccan')
127 conf.RECURSE('lib/ntdb')
128 conf.RECURSE('lib/zlib')
129 conf.RECURSE('lib/util/charset')
130 conf.RECURSE('source4/auth')
131 conf.RECURSE('lib/nss_wrapper')
132 conf.RECURSE('nsswitch')
133 conf.RECURSE('lib/socket_wrapper')
134 conf.RECURSE('lib/uid_wrapper')
135 conf.RECURSE('lib/popt')
136 conf.RECURSE('lib/iniparser/src')
137 conf.RECURSE('lib/subunit/c')
138 conf.RECURSE('libcli/smbreadline')
139 conf.RECURSE('lib/crypto')
140 conf.RECURSE('pidl')
141 conf.RECURSE('selftest')
142 conf.RECURSE('source3')
144 conf.SAMBA_CHECK_UNDEFINED_SYMBOL_FLAGS()
146 # gentoo always adds this. We want our normal build to be as
147 # strict as the strictest OS we support, so adding this here
148 # allows us to find problems on our development hosts faster.
149 # It also results in faster load time.
151 if not sys.platform.startswith("openbsd"):
152 conf.env.asneeded_ldflags = conf.ADD_LDFLAGS('-Wl,--as-needed', testflags=True)
154 if not conf.CHECK_NEED_LC("-lc not needed"):
155 conf.ADD_LDFLAGS('-lc', testflags=False)
157 # we don't want PYTHONDIR in config.h, as otherwise changing
158 # --prefix causes a complete rebuild
159 del(conf.env.defines['PYTHONDIR'])
160 del(conf.env.defines['PYTHONARCHDIR'])
162 if not conf.CHECK_CODE('#include "tests/summary.c"',
163 define='SUMMARY_PASSES',
164 addmain=False,
165 execute=True,
166 msg='Checking configure summary'):
167 raise Utils.WafError('configure summary failed')
169 conf.SAMBA_CONFIG_H('include/config.h')
171 if Options.options.enable_pie != False:
172 if Options.options.enable_pie == True:
173 need_pie = True
174 else:
175 # not specified, only build PIEs if supported by compiler
176 need_pie = False
177 if conf.check_cc(cflags='-fPIE', ldflags='-pie', mandatory=need_pie,
178 msg="Checking compiler for PIE support"):
179 conf.env['ENABLE_PIE'] = True
181 def etags(ctx):
182 '''build TAGS file using etags'''
183 import Utils
184 source_root = os.path.dirname(Utils.g_module.root_path)
185 cmd = 'rm -f %s/TAGS && (find %s -name "*.[ch]" | egrep -v \.inst\. | xargs -n 100 etags -a)' % (source_root, source_root)
186 print("Running: %s" % cmd)
187 os.system(cmd)
189 def ctags(ctx):
190 "build 'tags' file using ctags"
191 import Utils
192 source_root = os.path.dirname(Utils.g_module.root_path)
193 cmd = 'ctags --python-kinds=-i $(find %s -name "*.[ch]" | grep -v "*_proto\.h" | egrep -v \.inst\.) $(find %s -name "*.py")' % (source_root, source_root)
194 print("Running: %s" % cmd)
195 os.system(cmd)
197 # putting this here enabled build in the list
198 # of commands in --help
199 def build(bld):
200 '''build all targets'''
201 samba_version.load_version(env=bld.env, is_install=bld.is_install)
202 pass
205 def pydoctor(ctx):
206 '''build python apidocs'''
207 bp = os.path.abspath('bin/python')
208 mpaths = {}
209 for m in ['talloc', 'tdb', 'ldb', 'ntdb']:
210 f = os.popen("PYTHONPATH=%s python -c 'import %s; print %s.__file__'" % (bp, m, m), 'r')
211 try:
212 mpaths[m] = f.read().strip()
213 finally:
214 f.close()
215 cmd='PYTHONPATH=%s pydoctor --introspect-c-modules --project-name=Samba --project-url=http://www.samba.org --make-html --docformat=restructuredtext --add-package bin/python/samba --add-module %s --add-module %s --add-module %s' % (
216 bp, mpaths['tdb'], mpaths['ldb'], mpaths['talloc'], mpaths['ntdb'])
217 print("Running: %s" % cmd)
218 os.system(cmd)
221 def pep8(ctx):
222 '''run pep8 validator'''
223 cmd='PYTHONPATH=bin/python pep8 -r bin/python/samba'
224 print("Running: %s" % cmd)
225 os.system(cmd)
228 def wafdocs(ctx):
229 '''build wafsamba apidocs'''
230 from samba_utils import recursive_dirlist
231 os.system('pwd')
232 list = recursive_dirlist('../buildtools/wafsamba', '.', pattern='*.py')
234 cmd='PYTHONPATH=bin/python pydoctor --project-name=wafsamba --project-url=http://www.samba.org --make-html --docformat=restructuredtext'
235 print(list)
236 for f in list:
237 cmd += ' --add-module %s' % f
238 print("Running: %s" % cmd)
239 os.system(cmd)
242 def dist():
243 '''makes a tarball for distribution'''
244 sambaversion = samba_version.load_version(env=None)
246 os.system(srcdir + "/release-scripts/build-manpages-nogit")
247 samba_dist.DIST_FILES('bin/docs:docs', extend=True)
249 if sambaversion.IS_SNAPSHOT:
250 # write .distversion file and add to tar
251 if not os.path.isdir(blddir):
252 os.makedirs(blddir)
253 distversionf = tempfile.NamedTemporaryFile(mode='w', prefix='.distversion',dir=blddir)
254 for field in sambaversion.vcs_fields:
255 distveroption = field + '=' + str(sambaversion.vcs_fields[field])
256 distversionf.write(distveroption + '\n')
257 distversionf.flush()
258 samba_dist.DIST_FILES('%s:.distversion' % distversionf.name, extend=True)
260 samba_dist.dist()
261 distversionf.close()
262 else:
263 samba_dist.dist()
266 def distcheck():
267 '''test that distribution tarball builds and installs'''
268 samba_version.load_version(env=None)
269 import Scripting
270 d = Scripting.distcheck
273 def wildcard_cmd(cmd):
274 '''called on a unknown command'''
275 from samba_wildcard import run_named_build_task
276 run_named_build_task(cmd)
278 def main():
279 from samba_wildcard import wildcard_main
280 wildcard_main(wildcard_cmd)
281 Scripting.main = main
283 def reconfigure(ctx):
284 '''reconfigure if config scripts have changed'''
285 import samba_utils
286 samba_utils.reconfigure(ctx)