1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
# Zmake
<!-- Auto-generated contents! Run "zmake generate-readme" to update. -->
[TOC]
## Usage
**Usage:** `zmake [-h] [--checkout CHECKOUT] [-j JOBS] [--goma] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL} | -D] [-L] [--log-label] [--modules-dir MODULES_DIR] [--zephyr-base ZEPHYR_BASE] subcommand ...`
Chromium OS's meta-build tool for Zephyr
#### Positional Arguments
| | |
|---|---|
| `subcommand` | Subcommand to run |
#### Optional Arguments
| | |
|---|---|
| `-h`, `--help` | show this help message and exit |
| `--checkout CHECKOUT` | Path to ChromiumOS checkout |
| `-j JOBS`, `--jobs JOBS` | Degree of multiprogramming to use |
| `--goma` | Enable hyperspeed compilation with Goma! (Googlers only) |
| `-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}`, `--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}` | Set the logging level (default=INFO) |
| `-D`, `--debug` | Alias for --log-level=DEBUG |
| `-L`, `--no-log-label` | Turn off logging labels |
| `--log-label` | Turn on logging labels |
| `--modules-dir MODULES_DIR` | The path to a directory containing all modules needed. If unspecified, zmake will assume you have a Chrome OS checkout and try locating them in the checkout. |
| `--zephyr-base ZEPHYR_BASE` | Path to Zephyr OS repository |
## Subcommands
### zmake configure
**Usage:** `zmake configure [-h] [--bringup] [--clobber] [--static] [--save-temps] [--allow-warnings] [-B BUILD_DIR] [-c] [--delete-intermediates] [-t TOOLCHAIN] [--extra-cflags EXTRA_CFLAGS] (-a | project_name [project_name ...])`
#### Positional Arguments
| | |
|---|---|
| `project_name` | Name(s) of the project(s) to build |
#### Optional Arguments
| | |
|---|---|
| `-h`, `--help` | show this help message and exit |
| `--bringup` | Enable bringup debugging features |
| `--clobber` | Delete existing build directories, even if configuration is unchanged |
| `--static` | Generate static version information for reproducible builds |
| `--save-temps` | Save the temporary files containing preprocessor output |
| `--allow-warnings` | Do not treat warnings as errors |
| `-B BUILD_DIR`, `--build-dir BUILD_DIR` | Root build directory, project files will be in ${build_dir}/${project_name} |
| `-c`, `--coverage` | Enable CONFIG_COVERAGE Kconfig. |
| `--delete-intermediates` | Delete intermediate files to save disk space |
| `-t TOOLCHAIN`, `--toolchain TOOLCHAIN` | Name of toolchain to use |
| `--extra-cflags EXTRA_CFLAGS` | Additional CFLAGS to use for target builds |
| `-a`, `--all` | Select all projects |
### zmake build
**Usage:** `zmake build [-h] [--bringup] [--clobber] [--static] [--save-temps] [--allow-warnings] [-B BUILD_DIR] [-c] [--delete-intermediates] [-t TOOLCHAIN] [--extra-cflags EXTRA_CFLAGS] (-a | project_name [project_name ...])`
#### Positional Arguments
| | |
|---|---|
| `project_name` | Name(s) of the project(s) to build |
#### Optional Arguments
| | |
|---|---|
| `-h`, `--help` | show this help message and exit |
| `--bringup` | Enable bringup debugging features |
| `--clobber` | Delete existing build directories, even if configuration is unchanged |
| `--static` | Generate static version information for reproducible builds |
| `--save-temps` | Save the temporary files containing preprocessor output |
| `--allow-warnings` | Do not treat warnings as errors |
| `-B BUILD_DIR`, `--build-dir BUILD_DIR` | Root build directory, project files will be in ${build_dir}/${project_name} |
| `-c`, `--coverage` | Enable CONFIG_COVERAGE Kconfig. |
| `--delete-intermediates` | Delete intermediate files to save disk space |
| `-t TOOLCHAIN`, `--toolchain TOOLCHAIN` | Name of toolchain to use |
| `--extra-cflags EXTRA_CFLAGS` | Additional CFLAGS to use for target builds |
| `-a`, `--all` | Select all projects |
### zmake compare-builds
**Usage:** `zmake compare-builds [-h] [--ref1 REF1] [--ref2 REF2] [-k] [-t TOOLCHAIN] [--extra-cflags EXTRA_CFLAGS] (-a | project_name [project_name ...])`
#### Positional Arguments
| | |
|---|---|
| `project_name` | Name(s) of the project(s) to build |
#### Optional Arguments
| | |
|---|---|
| `-h`, `--help` | show this help message and exit |
| `--ref1 REF1` | 1st git reference (commit, branch, etc), default=HEAD |
| `--ref2 REF2` | 2nd git reference (commit, branch, etc), default=HEAD~ |
| `-k`, `--keep-temps` | Keep temporary build directories on exit |
| `-t TOOLCHAIN`, `--toolchain TOOLCHAIN` | Name of toolchain to use |
| `--extra-cflags EXTRA_CFLAGS` | Additional CFLAGS to use for target builds |
| `-a`, `--all` | Select all projects |
### zmake list-projects
**Usage:** `zmake list-projects [-h] [--format FMT] [search_dir]`
#### Positional Arguments
| | |
|---|---|
| `search_dir` | Optional directory to search for BUILD.py files in. |
#### Optional Arguments
| | |
|---|---|
| `-h`, `--help` | show this help message and exit |
| `--format FMT` | Output format to print projects (str.format(config=project.config) is called on this for each project). |
### zmake test
**Usage:** `zmake test [-h] [--no-rebuild] [--bringup] [--clobber] [--static] [--save-temps] [--allow-warnings] [-B BUILD_DIR] [-c] [--delete-intermediates] [-t TOOLCHAIN] [--extra-cflags EXTRA_CFLAGS] (-a | project_name [project_name ...])`
#### Positional Arguments
| | |
|---|---|
| `project_name` | Name(s) of the project(s) to build |
#### Optional Arguments
| | |
|---|---|
| `-h`, `--help` | show this help message and exit |
| `--no-rebuild` | Do not configure or build before running tests. |
| `--bringup` | Enable bringup debugging features |
| `--clobber` | Delete existing build directories, even if configuration is unchanged |
| `--static` | Generate static version information for reproducible builds |
| `--save-temps` | Save the temporary files containing preprocessor output |
| `--allow-warnings` | Do not treat warnings as errors |
| `-B BUILD_DIR`, `--build-dir BUILD_DIR` | Root build directory, project files will be in ${build_dir}/${project_name} |
| `-c`, `--coverage` | Enable CONFIG_COVERAGE Kconfig. |
| `--delete-intermediates` | Delete intermediate files to save disk space |
| `-t TOOLCHAIN`, `--toolchain TOOLCHAIN` | Name of toolchain to use |
| `--extra-cflags EXTRA_CFLAGS` | Additional CFLAGS to use for target builds |
| `-a`, `--all` | Select all projects |
### zmake testall
**Usage:** `zmake testall [-h] [--clobber] [-B BUILD_DIR] [--static]`
#### Optional Arguments
| | |
|---|---|
| `-h`, `--help` | show this help message and exit |
| `--clobber` | Delete existing build directories, even if configuration is unchanged |
| `-B BUILD_DIR`, `--build-dir BUILD_DIR` | Build directory |
| `--static` | Generate static version information for reproducible builds |
### zmake generate-readme
**Usage:** `zmake generate-readme [-h] [-o OUTPUT_FILE] [--diff]`
#### Optional Arguments
| | |
|---|---|
| `-h`, `--help` | show this help message and exit |
| `-o OUTPUT_FILE`, `--output-file OUTPUT_FILE` | File to write to. It will only be written if changed. |
| `--diff` | If specified, diff the README with the expected contents instead of writing out. |
|
