The sixteenth batch
[git/gitster.git] / meson_options.txt
blob1668f260a1858cd834234d0b69d9f75780b09a0b
1 # Configuration for Git installation
2 option('perllibdir', type: 'string', value: '',
3   description: 'Directory to install perl lib to. Defaults to <datadir>/perl5')
5 # Configuration for how Git behaves at runtime.
6 option('default_pager', type: 'string', value: 'less',
7   description: 'Fall-back pager.')
8 option('default_editor', type: 'string', value: 'vi',
9   description: 'Fall-back editor.')
10 option('gitconfig', type: 'string',
11   description: 'Path to the global git configuration file. (default: etc/gitconfig)')
12 option('gitattributes', type: 'string',
13   description: 'Path to the global git attributes file. (default: etc/gitattributes)')
14 option('pager_environment', type: 'string', value: 'LESS=FRX LV=-c',
15   description: 'Environment used when spawning the pager')
16 option('perl_cpan_fallback', type: 'boolean', value: true,
17   description: 'Install bundled copies of CPAN modules that serve as a fallback in case the modules are not available on the system.')
18 option('runtime_prefix', type: 'boolean', value: false,
19   description: 'Resolve ancillary tooling and support files relative to the location of the runtime binary instead of hard-coding them into the binary.')
20 option('sane_tool_path', type: 'array', value: [],
21   description: 'An array of paths to pick up tools from in case the normal tools are broken or lacking.')
23 # Build information compiled into Git and other parts like documentation.
24 option('build_date', type: 'string', value: '',
25   description: 'Build date reported by our documentation.')
26 option('built_from_commit', type: 'string', value: '',
27   description: 'Commit that Git was built from reported by git-version(1).')
28 option('user_agent', type: 'string', value: '',
29   description: 'User agent reported to remote servers.')
30 option('version', type: 'string', value: '',
31   description: 'Version string reported by git-version(1) and other tools.')
33 # Features supported by Git.
34 option('contrib', type: 'array', value: [ 'completion' ], choices: [ 'completion', 'contacts', 'subtree' ],
35   description: 'Contributed features to include.')
36 option('credential_helpers', type: 'array', value: [ ], choices: [ 'libsecret', 'netrc', 'osxkeychain', 'wincred' ],
37   description: 'Contributed features to include.')
38 option('curl', type: 'feature', value: 'enabled',
39   description: 'Build helpers used to access remotes with the HTTP transport.')
40 option('expat', type: 'feature', value: 'enabled',
41   description: 'Build helpers used to push to remotes with the HTTP transport.')
42 option('gettext', type: 'feature', value: 'auto',
43   description: 'Build translation files.')
44 option('gitweb', type: 'feature', value: 'auto',
45   description: 'Build Git web interface. Requires Perl.')
46 option('iconv', type: 'feature', value: 'auto',
47   description: 'Support reencoding strings with different encodings.')
48 option('pcre2', type: 'feature', value: 'auto',
49   description: 'Support Perl-compatible regular expressions in e.g. git-grep(1).')
50 option('perl', type: 'feature', value: 'auto',
51   description: 'Build tools written in Perl.')
52 option('python', type: 'feature', value: 'auto',
53   description: 'Build tools written in Python.')
54 option('regex', type: 'feature', value: 'auto',
55   description: 'Use the system-provided regex library instead of the bundled one.')
57 # Backends.
58 option('csprng_backend', type: 'combo', value: 'auto', choices: ['auto', 'arc4random', 'arc4random_bsd', 'getrandom', 'getentropy', 'rtlgenrandom', 'openssl', 'urandom'],
59   description: 'The backend to use for generating cryptographically-secure pseudo-random numbers.')
60 option('https_backend', type: 'combo', value: 'auto', choices: ['auto', 'openssl', 'CommonCrypto', 'none'],
61   description: 'The HTTPS backend to use when connecting to remotes.')
62 option('sha1_backend', type: 'combo', choices: ['openssl', 'block', 'sha1dc', 'CommonCrypto'], value: 'sha1dc',
63   description: 'The backend used for hashing objects with the SHA1 object format.')
64 option('sha1_unsafe_backend', type: 'combo', choices: ['openssl', 'block', 'CommonCrypto', 'none'], value: 'none',
65   description: 'The backend used for hashing data with the SHA1 object format in case no cryptographic security is needed.')
66 option('sha256_backend', type: 'combo', choices: ['openssl', 'nettle', 'gcrypt', 'block'], value: 'block',
67   description: 'The backend used for hashing objects with the SHA256 object format.')
68 option('zlib_backend', type: 'combo', choices: ['auto', 'zlib', 'zlib-ng'], value: 'auto',
69   description: 'The backend used for compressing objects and other data.')
71 # Build tweaks.
72 option('breaking_changes', type: 'boolean', value: false,
73   description: 'Enable upcoming breaking changes.')
74 option('macos_use_homebrew_gettext', type: 'boolean', value: true,
75   description: 'Use gettext from Homebrew instead of the slightly-broken system-provided one.')
77 # gitweb configuration.
78 option('gitweb_config', type: 'string', value: 'gitweb_config.perl')
79 option('gitweb_config_system', type: 'string', value: '/etc/gitweb.conf')
80 option('gitweb_config_common', type: 'string', value: '/etc/gitweb-common.conf')
81 option('gitweb_home_link_str', type: 'string', value: 'projects')
82 option('gitweb_sitename', type: 'string', value: '')
83 option('gitweb_projectroot', type: 'string', value: '/pub/git')
84 option('gitweb_project_maxdepth', type: 'string', value: '2007')
85 option('gitweb_export_ok', type: 'string', value: '')
86 option('gitweb_strict_export', type: 'string', value: '')
87 option('gitweb_base_url', type: 'string', value: '')
88 option('gitweb_list', type: 'string', value: '')
89 option('gitweb_hometext', type: 'string', value: 'indextext.html')
90 option('gitweb_css', type: 'string', value: 'static/gitweb.css')
91 option('gitweb_logo', type: 'string', value: 'static/git-logo.png')
92 option('gitweb_favicon', type: 'string', value: 'static/git-favicon.png')
93 option('gitweb_js', type: 'string', value: 'static/gitweb.js')
94 option('gitweb_site_html_head_string', type: 'string', value: '')
95 option('gitweb_site_header', type: 'string', value: '')
96 option('gitweb_site_footer', type: 'string', value: '')
97 option('highlight_bin', type: 'string', value: 'highlight')
99 # Documentation.
100 option('docs', type: 'array', choices: ['man', 'html'], value: [],
101   description: 'Which documenattion formats to build and install.')
102 option('default_help_format', type: 'combo', choices: ['man', 'html', 'platform'], value: 'platform',
103   description: 'Default format used when executing git-help(1).')
104 option('docs_backend', type: 'combo', choices: ['asciidoc', 'asciidoctor', 'auto'], value: 'auto',
105   description: 'Which backend to use to generate documentation.')
107 # Testing.
108 option('benchmarks', type: 'feature', value: 'auto',
109   description: 'Enable benchmarks. This requires Perl and GNU time.')
110 option('benchmark_repo', type: 'string', value: '',
111   description: 'Repository to copy for the performance tests. Should be at least the size of the Git repository.')
112 option('benchmark_large_repo', type: 'string', value: '',
113   description: 'Large repository to copy for the performance tests. Should be at least the size of the Linux repository.')
114 option('benchmark_repeat_count', type: 'integer', value: 3,
115   description: 'Number of times a test should be repeated for best-of-N measurements.')
116 option('coccinelle', type: 'feature', value: 'auto',
117   description: 'Provide a coccicheck target that generates a Coccinelle patch.')
118 option('tests', type: 'boolean', value: true,
119   description: 'Enable building tests. This requires Perl, but is separate from the "perl" option such that you can build tests without Perl features enabled.')
120 option('test_output_directory', type: 'string',
121   description: 'Path to the directory used to store test outputs')
122 option('test_utf8_locale', type: 'string',
123   description: 'Name of a UTF-8 locale used for testing.')
124 option('fuzzers', type: 'boolean', value: false,
125   description: 'Enable building fuzzers.')