diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/Makefile | 5 | ||||
-rw-r--r-- | documentation/mega-manual/figures/buildhistory-web.png | bin | 0 -> 49966 bytes | |||
-rw-r--r-- | documentation/mega-manual/figures/buildhistory.png | bin | 0 -> 42062 bytes | |||
-rw-r--r-- | documentation/poky-ref-manual/figures/buildhistory-web.png | bin | 0 -> 49966 bytes | |||
-rw-r--r-- | documentation/poky-ref-manual/figures/buildhistory.png | bin | 0 -> 42062 bytes | |||
-rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 152 |
6 files changed, 155 insertions, 2 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index 0218211313..6cac5caeaa 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
@@ -176,7 +176,7 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures | |||
176 | else | 176 | else |
177 | TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \ | 177 | TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \ |
178 | figures/using-a-pre-built-image.png \ | 178 | figures/using-a-pre-built-image.png \ |
179 | figures/poky-title.png \ | 179 | figures/poky-title.png figures/buildhistory.png figures/buildhistory-web.png \ |
180 | figures/adt-title.png figures/bsp-title.png \ | 180 | figures/adt-title.png figures/bsp-title.png \ |
181 | figures/kernel-title.png figures/kernel-architecture-overview.png \ | 181 | figures/kernel-title.png figures/kernel-architecture-overview.png \ |
182 | figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ | 182 | figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ |
@@ -199,7 +199,8 @@ XSLTOPTS = --stringparam html.stylesheet ref-style.css \ | |||
199 | --stringparam section.label.includes.component.label 1 \ | 199 | --stringparam section.label.includes.component.label 1 \ |
200 | --xinclude | 200 | --xinclude |
201 | ALLPREQ = html pdf tarball | 201 | ALLPREQ = html pdf tarball |
202 | TARFILES = poky-ref-manual.html ref-style.css figures/poky-title.png | 202 | TARFILES = poky-ref-manual.html ref-style.css figures/poky-title.png \ |
203 | figures/buildhistory.png figures/buildhistory-web.png | ||
203 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf | 204 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf |
204 | FIGURES = figures | 205 | FIGURES = figures |
205 | STYLESHEET = $(DOC)/*.css | 206 | STYLESHEET = $(DOC)/*.css |
diff --git a/documentation/mega-manual/figures/buildhistory-web.png b/documentation/mega-manual/figures/buildhistory-web.png new file mode 100644 index 0000000000..f6db86c977 --- /dev/null +++ b/documentation/mega-manual/figures/buildhistory-web.png | |||
Binary files differ | |||
diff --git a/documentation/mega-manual/figures/buildhistory.png b/documentation/mega-manual/figures/buildhistory.png new file mode 100644 index 0000000000..614b8ee2e4 --- /dev/null +++ b/documentation/mega-manual/figures/buildhistory.png | |||
Binary files differ | |||
diff --git a/documentation/poky-ref-manual/figures/buildhistory-web.png b/documentation/poky-ref-manual/figures/buildhistory-web.png new file mode 100644 index 0000000000..f6db86c977 --- /dev/null +++ b/documentation/poky-ref-manual/figures/buildhistory-web.png | |||
Binary files differ | |||
diff --git a/documentation/poky-ref-manual/figures/buildhistory.png b/documentation/poky-ref-manual/figures/buildhistory.png new file mode 100644 index 0000000000..614b8ee2e4 --- /dev/null +++ b/documentation/poky-ref-manual/figures/buildhistory.png | |||
Binary files differ | |||
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index ac068228cf..282d9f3090 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml | |||
@@ -120,6 +120,158 @@ | |||
120 | </glossdef> | 120 | </glossdef> |
121 | </glossentry> | 121 | </glossentry> |
122 | 122 | ||
123 | <glossentry id='var-BB_DISKMON_DIRS'><glossterm>BB_DISKMON_DIRS</glossterm> | ||
124 | <glossdef> | ||
125 | <para> | ||
126 | Monitors disk space and available inodes during the build | ||
127 | and allows you to control the build based on these | ||
128 | parameters. | ||
129 | </para> | ||
130 | |||
131 | <para> | ||
132 | Disk space monitoring is disabled by default. | ||
133 | To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename> | ||
134 | variable to your <filename>conf/local.conf</filename> file found in the | ||
135 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | ||
136 | Use the following form: | ||
137 | <literallayout class='monospaced'> | ||
138 | BB_DISKMON_DIRS = "<action>,<dir>,<threshold> [...]" | ||
139 | |||
140 | where: | ||
141 | |||
142 | <action> is: | ||
143 | ABORT: Immediately abort the build when | ||
144 | a threshold is broken. | ||
145 | STOPTASKS: Stop the build after the currently | ||
146 | executing tasks have finished when | ||
147 | a threshold is broken. | ||
148 | WARN: Issue a warning but continue the | ||
149 | build when a threshold is broken. | ||
150 | Subsequent warnings are issued as | ||
151 | defined by the | ||
152 | <link linkend='var-BB_DISKMON_WARNINTERVAL'>BB_DISKMON_WARNINTERVAL</link> variable, | ||
153 | which must be defined in the | ||
154 | conf/local.conf file. | ||
155 | |||
156 | <dir> is: | ||
157 | Any directory you choose. You can specify one or | ||
158 | more directories to monitor by separating the | ||
159 | groupings with a space. If two directories are | ||
160 | on the same device, only the first directory | ||
161 | is monitored. | ||
162 | |||
163 | <threshold> is: | ||
164 | Either the minimum available disk space, | ||
165 | the minimum number of free inodes, or | ||
166 | both. You must specify at least one. To | ||
167 | omit one or the other, simply omit the value. | ||
168 | Specify the threshold using G, M, K for Gbytes, | ||
169 | Mbytes, and Kbytes, respectively. If you do | ||
170 | not specify G, M, or K, Kbytes is assumed by | ||
171 | default. Do not use GB, MB, or KB. | ||
172 | </literallayout> | ||
173 | </para> | ||
174 | |||
175 | <para> | ||
176 | Here are some examples: | ||
177 | <literallayout class='monospaced'> | ||
178 | BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K" | ||
179 | BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" | ||
180 | BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" | ||
181 | </literallayout> | ||
182 | The first example works only if you also provide | ||
183 | the <link linkend='var-BB_DISKMON_WARNINTERVAL'><filename>BB_DISKMON_WARNINTERVAL</filename></link> variable | ||
184 | in the <filename>conf/local.conf</filename>. | ||
185 | This example causes the build system to immediately | ||
186 | abort when either the disk space in <filename>${TMPDIR}</filename> drops | ||
187 | below 1 Gbyte or the available free inodes drops below | ||
188 | 100 Kbytes. | ||
189 | Because two directories are provided with the variable, the | ||
190 | build system also issue a | ||
191 | warning when the disk space in the | ||
192 | <filename>${SSTATE_DIR}</filename> directory drops | ||
193 | below 1 Gbyte or the number of free inodes drops | ||
194 | below 100 Kbytes. | ||
195 | Subsequent warnings are issued during intervals as | ||
196 | defined by the <filename>BB_DISKMON_WARNINTERVAL</filename> | ||
197 | variable. | ||
198 | </para> | ||
199 | |||
200 | <para> | ||
201 | The second example stops the build after all currently | ||
202 | executing tasks complete when the minimum disk space | ||
203 | in the <filename>${TMPDIR}</filename> directory drops | ||
204 | below 1 Gbyte. | ||
205 | No disk monitoring occurs for the free inodes in this case. | ||
206 | </para> | ||
207 | |||
208 | <para> | ||
209 | The final example immediately aborts the build when the | ||
210 | number of free inodes in the <filename>${TMPDIR}</filename> directory | ||
211 | drops below 100 Kbytes. | ||
212 | No disk space monitoring for the directory itself occurs | ||
213 | in this case. | ||
214 | </para> | ||
215 | </glossdef> | ||
216 | </glossentry> | ||
217 | |||
218 | <glossentry id='var-BB_DISKMON_WARNINTERVAL'><glossterm>BB_DISKMON_WARNINTERVAL</glossterm> | ||
219 | <glossdef> | ||
220 | <para> | ||
221 | Defines the disk space and free inode warning intervals. | ||
222 | To set these intervals, define the variable in your | ||
223 | <filename>conf/local.conf</filename> file in the | ||
224 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | ||
225 | </para> | ||
226 | |||
227 | <para> | ||
228 | If you are going to use the | ||
229 | <filename>BB_DISKMON_WARNINTERVAL</filename> variable, you must | ||
230 | also use the | ||
231 | <link linkend='var-BB_DISKMON_DIRS'><filename>BB_DISKMON_DIRS</filename></link> variable | ||
232 | and define its action as "WARN". | ||
233 | During the build, subsequent warnings are issued each time | ||
234 | disk space or number of free inodes further reduces by | ||
235 | the respective interval. | ||
236 | </para> | ||
237 | |||
238 | <para> | ||
239 | Use the following form: | ||
240 | <literallayout class='monospaced'> | ||
241 | BB_DISKMON_WARNINTERVAL = "<disk_space_interval>,<disk_inode_interval>" | ||
242 | |||
243 | where: | ||
244 | |||
245 | <disk_space_interval> is: | ||
246 | An interval of memory expressed in either | ||
247 | G, M, or K for Gbytes, Mbytes, or Kbytes, | ||
248 | respectively. You cannot use GB, MB, or KB. | ||
249 | |||
250 | <disk_inode_interval> is: | ||
251 | An interval of free inodes expressed in either | ||
252 | G, M, or K for Gbytes, Mbytes, or Kbytes, | ||
253 | respectively. You cannot use GB, MB, or KB. | ||
254 | </literallayout> | ||
255 | </para> | ||
256 | |||
257 | <para> | ||
258 | Here is an example: | ||
259 | <literallayout class='monospaced'> | ||
260 | BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K" | ||
261 | BB_DISKMON_WARNINTERVAL = "50M,5K" | ||
262 | </literallayout> | ||
263 | These variables cause the OpenEmbedded build system to | ||
264 | issue subsequent warnings each time the available | ||
265 | disk space further reduces by 50 Mbytes or the number | ||
266 | of free inodes further reduces by 5 Kbytes in the | ||
267 | <filename>${SSTATE_DIR}</filename> directory. | ||
268 | Subsequent warnings based on the interval occur each time | ||
269 | a respective interval is reached beyond the intial warning | ||
270 | (i.e. 1 Gbytes and 100 Kbytes). | ||
271 | </para> | ||
272 | </glossdef> | ||
273 | </glossentry> | ||
274 | |||
123 | <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm> | 275 | <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm> |
124 | <glossdef> | 276 | <glossdef> |
125 | <para> | 277 | <para> |