docs: Change smb encrypt default in docs to match s3 and lib/param
[Samba.git] / wscript
blob47b7b50639fda67bd8bd13ba8a7eeed55dfee330
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 opt.add_option('--with-relro',
68 help=("Build with full RELocation Read-Only (RELRO)" +
69 "(default if supported by compiler)"),
70 action="store_true", dest='enable_relro')
71 opt.add_option('--without-relro',
72 help=("Disable RELRO builds"),
73 action="store_false", dest='enable_relro')
75 gr = opt.option_group('developer options')
78 opt.tool_options('python') # options for disabling pyc or pyo compilation
79 # enable options related to building python extensions
82 def configure(conf):
83 version = samba_version.load_version(env=conf.env)
85 conf.DEFINE('CONFIG_H_IS_FROM_SAMBA', 1)
86 conf.DEFINE('_SAMBA_BUILD_', version.MAJOR, add_to_cflags=True)
87 conf.DEFINE('HAVE_CONFIG_H', 1, add_to_cflags=True)
89 if Options.options.developer:
90 conf.ADD_CFLAGS('-DDEVELOPER -DDEBUG_PASSWORD')
91 conf.env.DEVELOPER = True
93 conf.ADD_EXTRA_INCLUDES('#include/public #source4 #lib #source4/lib #source4/include #include #lib/replace')
95 conf.RECURSE('lib/replace')
97 conf.find_program('perl', var='PERL', mandatory=True)
98 conf.find_program('xsltproc', var='XSLTPROC')
100 conf.SAMBA_CHECK_PYTHON(mandatory=True, version=(2,5,0))
101 conf.SAMBA_CHECK_PYTHON_HEADERS(mandatory=True)
103 if sys.platform == 'darwin' and not conf.env['HAVE_ENVIRON_DECL']:
104 # Mac OSX needs to have this and it's also needed that the python is compiled with this
105 # otherwise you face errors about common symbols
106 if not conf.CHECK_SHLIB_W_PYTHON("Checking if -fno-common is needed"):
107 conf.ADD_CFLAGS('-fno-common')
108 if not conf.CHECK_SHLIB_W_PYTHON("Checking if -undefined dynamic_lookup is not need"):
109 conf.env.append_value('shlib_LINKFLAGS', ['-undefined', 'dynamic_lookup'])
111 if sys.platform == 'darwin':
112 conf.ADD_LDFLAGS('-framework CoreFoundation')
114 if int(conf.env['PYTHON_VERSION'][0]) >= 3:
115 raise Utils.WafError('Python version 3.x is not supported by Samba yet')
117 conf.RECURSE('dynconfig')
118 conf.RECURSE('lib/ldb')
120 if Options.options.with_system_mitkrb5:
121 conf.PROCESS_SEPARATE_RULE('system_mitkrb5')
122 if not (Options.options.without_ad_dc or Options.options.with_system_mitkrb5):
123 conf.DEFINE('AD_DC_BUILD_IS_ENABLED', 1)
124 # Only process heimdal_build for non-MIT KRB5 builds
125 # When MIT KRB5 checks are done as above, conf.env.KRB5_VENDOR will be set
126 # to the lowcased output of 'krb5-config --vendor'.
127 # If it is not set or the output is 'heimdal', we are dealing with
128 # system-provided or embedded Heimdal build
129 if conf.CONFIG_GET('KRB5_VENDOR') in (None, 'heimdal'):
130 conf.RECURSE('source4/heimdal_build')
131 conf.RECURSE('source4/lib/tls')
132 conf.RECURSE('source4/ntvfs/sysdep')
133 conf.RECURSE('lib/util')
134 conf.RECURSE('lib/ccan')
135 conf.RECURSE('lib/ntdb')
136 conf.RECURSE('lib/zlib')
137 conf.RECURSE('lib/util/charset')
138 conf.RECURSE('source4/auth')
139 conf.RECURSE('lib/nss_wrapper')
140 conf.RECURSE('nsswitch')
141 conf.RECURSE('lib/socket_wrapper')
142 conf.RECURSE('lib/uid_wrapper')
143 conf.RECURSE('lib/popt')
144 conf.RECURSE('lib/iniparser/src')
145 conf.RECURSE('lib/subunit/c')
146 conf.RECURSE('libcli/smbreadline')
147 conf.RECURSE('lib/crypto')
148 conf.RECURSE('pidl')
149 conf.RECURSE('selftest')
150 conf.RECURSE('source3')
152 conf.SAMBA_CHECK_UNDEFINED_SYMBOL_FLAGS()
154 # gentoo always adds this. We want our normal build to be as
155 # strict as the strictest OS we support, so adding this here
156 # allows us to find problems on our development hosts faster.
157 # It also results in faster load time.
159 if not sys.platform.startswith("openbsd"):
160 conf.env.asneeded_ldflags = conf.ADD_LDFLAGS('-Wl,--as-needed', testflags=True)
162 if not conf.CHECK_NEED_LC("-lc not needed"):
163 conf.ADD_LDFLAGS('-lc', testflags=False)
165 # we don't want PYTHONDIR in config.h, as otherwise changing
166 # --prefix causes a complete rebuild
167 del(conf.env.defines['PYTHONDIR'])
168 del(conf.env.defines['PYTHONARCHDIR'])
170 if not conf.CHECK_CODE('#include "tests/summary.c"',
171 define='SUMMARY_PASSES',
172 addmain=False,
173 execute=True,
174 msg='Checking configure summary'):
175 raise Utils.WafError('configure summary failed')
177 conf.SAMBA_CONFIG_H('include/config.h')
179 if Options.options.enable_pie != False:
180 if Options.options.enable_pie == True:
181 need_pie = True
182 else:
183 # not specified, only build PIEs if supported by compiler
184 need_pie = False
185 if conf.check_cc(cflags='-fPIE', ldflags='-pie', mandatory=need_pie,
186 msg="Checking compiler for PIE support"):
187 conf.env['ENABLE_PIE'] = True
189 if Options.options.enable_relro != False:
190 if Options.options.enable_relro == True:
191 need_relro = True
192 else:
193 # not specified, only build RELROs if supported by compiler
194 need_relro = False
195 if conf.check_cc(cflags='', ldflags='-Wl,-z,relro,-z,now', mandatory=need_relro,
196 msg="Checking compiler for full RELRO support"):
197 conf.env['ENABLE_RELRO'] = True
199 def etags(ctx):
200 '''build TAGS file using etags'''
201 import Utils
202 source_root = os.path.dirname(Utils.g_module.root_path)
203 cmd = 'rm -f %s/TAGS && (find %s -name "*.[ch]" | egrep -v \.inst\. | xargs -n 100 etags -a)' % (source_root, source_root)
204 print("Running: %s" % cmd)
205 os.system(cmd)
207 def ctags(ctx):
208 "build 'tags' file using ctags"
209 import Utils
210 source_root = os.path.dirname(Utils.g_module.root_path)
211 cmd = 'ctags --python-kinds=-i $(find %s -name "*.[ch]" | grep -v "*_proto\.h" | egrep -v \.inst\.) $(find %s -name "*.py")' % (source_root, source_root)
212 print("Running: %s" % cmd)
213 os.system(cmd)
215 # putting this here enabled build in the list
216 # of commands in --help
217 def build(bld):
218 '''build all targets'''
219 samba_version.load_version(env=bld.env, is_install=bld.is_install)
220 pass
223 def pydoctor(ctx):
224 '''build python apidocs'''
225 bp = os.path.abspath('bin/python')
226 mpaths = {}
227 for m in ['talloc', 'tdb', 'ldb', 'ntdb']:
228 f = os.popen("PYTHONPATH=%s python -c 'import %s; print %s.__file__'" % (bp, m, m), 'r')
229 try:
230 mpaths[m] = f.read().strip()
231 finally:
232 f.close()
233 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' % (
234 bp, mpaths['tdb'], mpaths['ldb'], mpaths['talloc'], mpaths['ntdb'])
235 print("Running: %s" % cmd)
236 os.system(cmd)
239 def pep8(ctx):
240 '''run pep8 validator'''
241 cmd='PYTHONPATH=bin/python pep8 -r bin/python/samba'
242 print("Running: %s" % cmd)
243 os.system(cmd)
246 def wafdocs(ctx):
247 '''build wafsamba apidocs'''
248 from samba_utils import recursive_dirlist
249 os.system('pwd')
250 list = recursive_dirlist('../buildtools/wafsamba', '.', pattern='*.py')
252 cmd='PYTHONPATH=bin/python pydoctor --project-name=wafsamba --project-url=http://www.samba.org --make-html --docformat=restructuredtext'
253 print(list)
254 for f in list:
255 cmd += ' --add-module %s' % f
256 print("Running: %s" % cmd)
257 os.system(cmd)
260 def dist():
261 '''makes a tarball for distribution'''
262 sambaversion = samba_version.load_version(env=None)
264 os.system(srcdir + "/release-scripts/build-manpages-nogit")
265 samba_dist.DIST_FILES('bin/docs:docs', extend=True)
267 if sambaversion.IS_SNAPSHOT:
268 # write .distversion file and add to tar
269 if not os.path.isdir(blddir):
270 os.makedirs(blddir)
271 distversionf = tempfile.NamedTemporaryFile(mode='w', prefix='.distversion',dir=blddir)
272 for field in sambaversion.vcs_fields:
273 distveroption = field + '=' + str(sambaversion.vcs_fields[field])
274 distversionf.write(distveroption + '\n')
275 distversionf.flush()
276 samba_dist.DIST_FILES('%s:.distversion' % distversionf.name, extend=True)
278 samba_dist.dist()
279 distversionf.close()
280 else:
281 samba_dist.dist()
284 def distcheck():
285 '''test that distribution tarball builds and installs'''
286 samba_version.load_version(env=None)
287 import Scripting
288 d = Scripting.distcheck
291 def wildcard_cmd(cmd):
292 '''called on a unknown command'''
293 from samba_wildcard import run_named_build_task
294 run_named_build_task(cmd)
296 def main():
297 from samba_wildcard import wildcard_main
298 wildcard_main(wildcard_cmd)
299 Scripting.main = main
301 def reconfigure(ctx):
302 '''reconfigure if config scripts have changed'''
303 import samba_utils
304 samba_utils.reconfigure(ctx)