diff options
Diffstat (limited to 'documentation/sdk-manual')
-rw-r--r-- | documentation/sdk-manual/appendix-obtain.rst | 6 | ||||
-rw-r--r-- | documentation/sdk-manual/extensible.rst | 1232 | ||||
-rw-r--r-- | documentation/sdk-manual/figures/sdk-devtool-add-flow.png | bin | 181699 -> 0 bytes | |||
-rw-r--r-- | documentation/sdk-manual/figures/sdk-devtool-modify-flow.png | bin | 171676 -> 0 bytes | |||
-rw-r--r-- | documentation/sdk-manual/figures/sdk-devtool-upgrade-flow.png | bin | 138917 -> 0 bytes | |||
-rw-r--r-- | documentation/sdk-manual/intro.rst | 4 | ||||
-rw-r--r-- | documentation/sdk-manual/using.rst | 2 | ||||
-rw-r--r-- | documentation/sdk-manual/working-projects.rst | 6 |
8 files changed, 14 insertions, 1236 deletions
diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst index d06d6ec6b5..a42cbc31bb 100644 --- a/documentation/sdk-manual/appendix-obtain.rst +++ b/documentation/sdk-manual/appendix-obtain.rst | |||
@@ -29,7 +29,7 @@ and then run the script to hand-install the toolchain. | |||
29 | Follow these steps to locate and hand-install the toolchain: | 29 | Follow these steps to locate and hand-install the toolchain: |
30 | 30 | ||
31 | #. *Go to the Installers Directory:* Go to | 31 | #. *Go to the Installers Directory:* Go to |
32 | :yocto_dl:`/releases/yocto/yocto-&DISTRO;/toolchain/` | 32 | :yocto_dl:`/releases/yocto/&DISTRO_REL_LATEST_TAG;/toolchain/` |
33 | 33 | ||
34 | #. *Open the Folder for Your Build Host:* Open the folder that matches | 34 | #. *Open the Folder for Your Build Host:* Open the folder that matches |
35 | your :term:`Build Host` (i.e. | 35 | your :term:`Build Host` (i.e. |
@@ -201,7 +201,7 @@ Follow these steps to extract the root filesystem: | |||
201 | Image File:* You need to find and download the root filesystem image | 201 | Image File:* You need to find and download the root filesystem image |
202 | file that is appropriate for your target system. These files are kept | 202 | file that is appropriate for your target system. These files are kept |
203 | in machine-specific folders in the | 203 | in machine-specific folders in the |
204 | :yocto_dl:`Index of Releases </releases/yocto/yocto-&DISTRO;/machines/>` | 204 | :yocto_dl:`Index of Releases </releases/yocto/&DISTRO_REL_LATEST_TAG;/machines/>` |
205 | in the "machines" directory. | 205 | in the "machines" directory. |
206 | 206 | ||
207 | The machine-specific folders of the "machines" directory contain | 207 | The machine-specific folders of the "machines" directory contain |
@@ -245,7 +245,7 @@ Follow these steps to extract the root filesystem: | |||
245 | 245 | ||
246 | Here is an example command that extracts the root filesystem | 246 | Here is an example command that extracts the root filesystem |
247 | from a previously built root filesystem image that was downloaded | 247 | from a previously built root filesystem image that was downloaded |
248 | from the :yocto_dl:`Index of Releases </releases/yocto/yocto-&DISTRO;/machines/>`. | 248 | from the :yocto_dl:`Index of Releases </releases/yocto/&DISTRO_REL_LATEST_TAG;/machines/>`. |
249 | This command extracts the root filesystem into the ``core2-64-sato`` | 249 | This command extracts the root filesystem into the ``core2-64-sato`` |
250 | directory:: | 250 | directory:: |
251 | 251 | ||
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index 3f6a754d88..e5e9e4a03b 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst | |||
@@ -87,7 +87,7 @@ Host` by running the ``*.sh`` installation script. | |||
87 | You can download a tarball installer, which includes the pre-built | 87 | You can download a tarball installer, which includes the pre-built |
88 | toolchain, the ``runqemu`` script, the internal build system, | 88 | toolchain, the ``runqemu`` script, the internal build system, |
89 | ``devtool``, and support files from the appropriate | 89 | ``devtool``, and support files from the appropriate |
90 | :yocto_dl:`toolchain </releases/yocto/yocto-&DISTRO;/toolchain/>` directory within the Index of | 90 | :yocto_dl:`toolchain </releases/yocto/&DISTRO_REL_LATEST_TAG;/toolchain/>` directory within the Index of |
91 | Releases. Toolchains are available for several 32-bit and 64-bit | 91 | Releases. Toolchains are available for several 32-bit and 64-bit |
92 | architectures with the ``x86_64`` directories, respectively. The | 92 | architectures with the ``x86_64`` directories, respectively. The |
93 | toolchains the Yocto Project provides are based off the | 93 | toolchains the Yocto Project provides are based off the |
@@ -178,7 +178,7 @@ Running the Extensible SDK Environment Setup Script | |||
178 | Once you have the SDK installed, you must run the SDK environment setup | 178 | Once you have the SDK installed, you must run the SDK environment setup |
179 | script before you can actually use the SDK. | 179 | script before you can actually use the SDK. |
180 | 180 | ||
181 | When using a SDK directly in a Yocto build, you will find the script in | 181 | When using an SDK directly in a Yocto build, you will find the script in |
182 | ``tmp/deploy/images/qemux86-64/`` in your :term:`Build Directory`. | 182 | ``tmp/deploy/images/qemux86-64/`` in your :term:`Build Directory`. |
183 | 183 | ||
184 | When using a standalone SDK installer, this setup script resides in | 184 | When using a standalone SDK installer, this setup script resides in |
@@ -257,1231 +257,9 @@ the recipe a source tree that is under your control is used in order to | |||
257 | allow you to make changes to the source as desired. By default, new | 257 | allow you to make changes to the source as desired. By default, new |
258 | recipes and the source go into a "workspace" directory under the SDK. | 258 | recipes and the source go into a "workspace" directory under the SDK. |
259 | 259 | ||
260 | The remainder of this section presents the ``devtool add``, | 260 | To learn how to use ``devtool`` to add, modify, upgrade recipes and more, see |
261 | ``devtool modify``, and ``devtool upgrade`` workflows. | 261 | the :ref:`dev-manual/devtool:Using the \`\`devtool\`\` command-line tool` |
262 | 262 | section of the Yocto Project Development Tasks Manual. | |
263 | Use ``devtool add`` to Add an Application | ||
264 | ----------------------------------------- | ||
265 | |||
266 | The ``devtool add`` command generates a new recipe based on existing | ||
267 | source code. This command takes advantage of the | ||
268 | :ref:`devtool-the-workspace-layer-structure` | ||
269 | layer that many ``devtool`` commands use. The command is flexible enough | ||
270 | to allow you to extract source code into both the workspace or a | ||
271 | separate local Git repository and to use existing code that does not | ||
272 | need to be extracted. | ||
273 | |||
274 | Depending on your particular scenario, the arguments and options you use | ||
275 | with ``devtool add`` form different combinations. The following diagram | ||
276 | shows common development flows you would use with the ``devtool add`` | ||
277 | command: | ||
278 | |||
279 | .. image:: figures/sdk-devtool-add-flow.png | ||
280 | :width: 100% | ||
281 | |||
282 | #. *Generating the New Recipe*: The top part of the flow shows three | ||
283 | scenarios by which you could use ``devtool add`` to generate a recipe | ||
284 | based on existing source code. | ||
285 | |||
286 | In a shared development environment, it is typical for other | ||
287 | developers to be responsible for various areas of source code. As a | ||
288 | developer, you are probably interested in using that source code as | ||
289 | part of your development within the Yocto Project. All you need is | ||
290 | access to the code, a recipe, and a controlled area in which to do | ||
291 | your work. | ||
292 | |||
293 | Within the diagram, three possible scenarios feed into the | ||
294 | ``devtool add`` workflow: | ||
295 | |||
296 | - *Left*: The left scenario in the figure represents a common | ||
297 | situation where the source code does not exist locally and needs | ||
298 | to be extracted. In this situation, the source code is extracted | ||
299 | to the default workspace --- you do not want the files in some | ||
300 | specific location outside of the workspace. Thus, everything you | ||
301 | need will be located in the workspace:: | ||
302 | |||
303 | $ devtool add recipe fetchuri | ||
304 | |||
305 | With this command, ``devtool`` extracts the upstream | ||
306 | source files into a local Git repository within the ``sources`` | ||
307 | folder. The command then creates a recipe named recipe and a | ||
308 | corresponding append file in the workspace. If you do not provide | ||
309 | recipe, the command makes an attempt to determine the recipe name. | ||
310 | |||
311 | - *Middle*: The middle scenario in the figure also represents a | ||
312 | situation where the source code does not exist locally. In this | ||
313 | case, the code is again upstream and needs to be extracted to some | ||
314 | local area --- this time outside of the default workspace. | ||
315 | |||
316 | .. note:: | ||
317 | |||
318 | If required, ``devtool`` always creates a Git repository locally | ||
319 | during the extraction. | ||
320 | |||
321 | Furthermore, the first positional argument ``srctree`` in this case | ||
322 | identifies where the ``devtool add`` command will locate the | ||
323 | extracted code outside of the workspace. You need to specify an | ||
324 | empty directory:: | ||
325 | |||
326 | $ devtool add recipe srctree fetchuri | ||
327 | |||
328 | In summary, the source code is pulled from fetchuri and extracted into the | ||
329 | location defined by ``srctree`` as a local Git repository. | ||
330 | |||
331 | Within workspace, ``devtool`` creates a recipe named recipe along | ||
332 | with an associated append file. | ||
333 | |||
334 | - *Right*: The right scenario in the figure represents a situation | ||
335 | where the ``srctree`` has been previously prepared outside of the | ||
336 | ``devtool`` workspace. | ||
337 | |||
338 | The following command provides a new recipe name and identifies | ||
339 | the existing source tree location:: | ||
340 | |||
341 | $ devtool add recipe srctree | ||
342 | |||
343 | The command examines the source code and creates a recipe named | ||
344 | recipe for the code and places the recipe into the workspace. | ||
345 | |||
346 | Because the extracted source code already exists, ``devtool`` does | ||
347 | not try to relocate the source code into the workspace --- only the | ||
348 | new recipe is placed in the workspace. | ||
349 | |||
350 | Aside from a recipe folder, the command also creates an associated | ||
351 | append folder and places an initial ``*.bbappend`` file within. | ||
352 | |||
353 | #. *Edit the Recipe*: You can use ``devtool edit-recipe`` to open up the | ||
354 | editor as defined by the ``$EDITOR`` environment variable and modify | ||
355 | the file:: | ||
356 | |||
357 | $ devtool edit-recipe recipe | ||
358 | |||
359 | From within the editor, you can make modifications to the recipe that | ||
360 | take effect when you build it later. | ||
361 | |||
362 | #. *Build the Recipe or Rebuild the Image*: The next step you take | ||
363 | depends on what you are going to do with the new code. | ||
364 | |||
365 | If you need to eventually move the build output to the target | ||
366 | hardware, use the following ``devtool`` command:: | ||
367 | |||
368 | $ devtool build recipe | ||
369 | |||
370 | On the other hand, if you want an image to contain the recipe's | ||
371 | packages from the workspace for immediate deployment onto a device | ||
372 | (e.g. for testing purposes), you can use the ``devtool build-image`` | ||
373 | command:: | ||
374 | |||
375 | $ devtool build-image image | ||
376 | |||
377 | #. *Deploy the Build Output*: When you use the ``devtool build`` command | ||
378 | to build out your recipe, you probably want to see if the resulting | ||
379 | build output works as expected on the target hardware. | ||
380 | |||
381 | .. note:: | ||
382 | |||
383 | This step assumes you have a previously built image that is | ||
384 | already either running in QEMU or is running on actual hardware. | ||
385 | Also, it is assumed that for deployment of the image to the | ||
386 | target, SSH is installed in the image and, if the image is running | ||
387 | on real hardware, you have network access to and from your | ||
388 | development machine. | ||
389 | |||
390 | You can deploy your build output to that target hardware by using the | ||
391 | ``devtool deploy-target`` command:: | ||
392 | |||
393 | $ devtool deploy-target recipe target | ||
394 | |||
395 | The target is a live target machine running as an SSH server. | ||
396 | |||
397 | You can, of course, also deploy the image you build to actual | ||
398 | hardware by using the ``devtool build-image`` command. However, | ||
399 | ``devtool`` does not provide a specific command that allows you to | ||
400 | deploy the image to actual hardware. | ||
401 | |||
402 | #. *Finish Your Work With the Recipe*: The ``devtool finish`` command | ||
403 | creates any patches corresponding to commits in the local Git | ||
404 | repository, moves the new recipe to a more permanent layer, and then | ||
405 | resets the recipe so that the recipe is built normally rather than | ||
406 | from the workspace:: | ||
407 | |||
408 | $ devtool finish recipe layer | ||
409 | |||
410 | .. note:: | ||
411 | |||
412 | Any changes you want to turn into patches must be committed to the | ||
413 | Git repository in the source tree. | ||
414 | |||
415 | As mentioned, the ``devtool finish`` command moves the final recipe | ||
416 | to its permanent layer. | ||
417 | |||
418 | As a final process of the ``devtool finish`` command, the state of | ||
419 | the standard layers and the upstream source is restored so that you | ||
420 | can build the recipe from those areas rather than the workspace. | ||
421 | |||
422 | .. note:: | ||
423 | |||
424 | You can use the ``devtool reset`` command to put things back should you | ||
425 | decide you do not want to proceed with your work. If you do use this | ||
426 | command, realize that the source tree is preserved. | ||
427 | |||
428 | Use ``devtool modify`` to Modify the Source of an Existing Component | ||
429 | -------------------------------------------------------------------- | ||
430 | |||
431 | The ``devtool modify`` command prepares the way to work on existing code | ||
432 | that already has a local recipe in place that is used to build the | ||
433 | software. The command is flexible enough to allow you to extract code | ||
434 | from an upstream source, specify the existing recipe, and keep track of | ||
435 | and gather any patch files from other developers that are associated | ||
436 | with the code. | ||
437 | |||
438 | Depending on your particular scenario, the arguments and options you use | ||
439 | with ``devtool modify`` form different combinations. The following | ||
440 | diagram shows common development flows for the ``devtool modify`` | ||
441 | command: | ||
442 | |||
443 | .. image:: figures/sdk-devtool-modify-flow.png | ||
444 | :width: 100% | ||
445 | |||
446 | #. *Preparing to Modify the Code*: The top part of the flow shows three | ||
447 | scenarios by which you could use ``devtool modify`` to prepare to | ||
448 | work on source files. Each scenario assumes the following: | ||
449 | |||
450 | - The recipe exists locally in a layer external to the ``devtool`` | ||
451 | workspace. | ||
452 | |||
453 | - The source files exist either upstream in an un-extracted state or | ||
454 | locally in a previously extracted state. | ||
455 | |||
456 | The typical situation is where another developer has created a layer | ||
457 | for use with the Yocto Project and their recipe already resides in | ||
458 | that layer. Furthermore, their source code is readily available | ||
459 | either upstream or locally. | ||
460 | |||
461 | - *Left*: The left scenario in the figure represents a common | ||
462 | situation where the source code does not exist locally and it | ||
463 | needs to be extracted from an upstream source. In this situation, | ||
464 | the source is extracted into the default ``devtool`` workspace | ||
465 | location. The recipe, in this scenario, is in its own layer | ||
466 | outside the workspace (i.e. ``meta-``\ layername). | ||
467 | |||
468 | The following command identifies the recipe and, by default, | ||
469 | extracts the source files:: | ||
470 | |||
471 | $ devtool modify recipe | ||
472 | |||
473 | Once ``devtool`` locates the recipe, ``devtool`` uses the recipe's | ||
474 | :term:`SRC_URI` statements to locate the source code and any local | ||
475 | patch files from other developers. | ||
476 | |||
477 | With this scenario, there is no ``srctree`` argument. Consequently, the | ||
478 | default behavior of the ``devtool modify`` command is to extract | ||
479 | the source files pointed to by the :term:`SRC_URI` statements into a | ||
480 | local Git structure. Furthermore, the location for the extracted | ||
481 | source is the default area within the ``devtool`` workspace. The | ||
482 | result is that the command sets up both the source code and an | ||
483 | append file within the workspace while the recipe remains in its | ||
484 | original location. | ||
485 | |||
486 | Additionally, if you have any non-patch local files (i.e. files | ||
487 | referred to with ``file://`` entries in :term:`SRC_URI` statement | ||
488 | excluding ``*.patch/`` or ``*.diff``), these files are copied to | ||
489 | an ``oe-local-files`` folder under the newly created source tree. | ||
490 | Copying the files here gives you a convenient area from which you | ||
491 | can modify the files. Any changes or additions you make to those | ||
492 | files are incorporated into the build the next time you build the | ||
493 | software just as are other changes you might have made to the | ||
494 | source. | ||
495 | |||
496 | - *Middle*: The middle scenario in the figure represents a situation | ||
497 | where the source code also does not exist locally. In this case, | ||
498 | the code is again upstream and needs to be extracted to some local | ||
499 | area as a Git repository. The recipe, in this scenario, is again | ||
500 | local and in its own layer outside the workspace. | ||
501 | |||
502 | The following command tells ``devtool`` the recipe with which to | ||
503 | work and, in this case, identifies a local area for the extracted | ||
504 | source files that exists outside of the default ``devtool`` | ||
505 | workspace:: | ||
506 | |||
507 | $ devtool modify recipe srctree | ||
508 | |||
509 | .. note:: | ||
510 | |||
511 | You cannot provide a URL for ``srctree`` using the ``devtool`` command. | ||
512 | |||
513 | As with all extractions, the command uses the recipe's :term:`SRC_URI` | ||
514 | statements to locate the source files and any associated patch | ||
515 | files. Non-patch files are copied to an ``oe-local-files`` folder | ||
516 | under the newly created source tree. | ||
517 | |||
518 | Once the files are located, the command by default extracts them | ||
519 | into ``srctree``. | ||
520 | |||
521 | Within workspace, ``devtool`` creates an append file for the | ||
522 | recipe. The recipe remains in its original location but the source | ||
523 | files are extracted to the location you provide with ``srctree``. | ||
524 | |||
525 | - *Right*: The right scenario in the figure represents a situation | ||
526 | where the source tree (``srctree``) already exists locally as a | ||
527 | previously extracted Git structure outside of the ``devtool`` | ||
528 | workspace. In this example, the recipe also exists elsewhere | ||
529 | locally in its own layer. | ||
530 | |||
531 | The following command tells ``devtool`` the recipe with which to | ||
532 | work, uses the "-n" option to indicate source does not need to be | ||
533 | extracted, and uses ``srctree`` to point to the previously extracted | ||
534 | source files:: | ||
535 | |||
536 | $ devtool modify -n recipe srctree | ||
537 | |||
538 | If an ``oe-local-files`` subdirectory happens to exist and it | ||
539 | contains non-patch files, the files are used. However, if the | ||
540 | subdirectory does not exist and you run the ``devtool finish`` | ||
541 | command, any non-patch files that might exist next to the recipe | ||
542 | are removed because it appears to ``devtool`` that you have | ||
543 | deleted those files. | ||
544 | |||
545 | Once the ``devtool modify`` command finishes, it creates only an | ||
546 | append file for the recipe in the ``devtool`` workspace. The | ||
547 | recipe and the source code remain in their original locations. | ||
548 | |||
549 | #. *Edit the Source*: Once you have used the ``devtool modify`` command, | ||
550 | you are free to make changes to the source files. You can use any | ||
551 | editor you like to make and save your source code modifications. | ||
552 | |||
553 | #. *Build the Recipe or Rebuild the Image*: The next step you take | ||
554 | depends on what you are going to do with the new code. | ||
555 | |||
556 | If you need to eventually move the build output to the target | ||
557 | hardware, use the following ``devtool`` command:: | ||
558 | |||
559 | $ devtool build recipe | ||
560 | |||
561 | On the other hand, if you want an image to contain the recipe's | ||
562 | packages from the workspace for immediate deployment onto a device | ||
563 | (e.g. for testing purposes), you can use the ``devtool build-image`` | ||
564 | command:: | ||
565 | |||
566 | $ devtool build-image image | ||
567 | |||
568 | #. *Deploy the Build Output*: When you use the ``devtool build`` command | ||
569 | to build out your recipe, you probably want to see if the resulting | ||
570 | build output works as expected on target hardware. | ||
571 | |||
572 | .. note:: | ||
573 | |||
574 | This step assumes you have a previously built image that is | ||
575 | already either running in QEMU or running on actual hardware. | ||
576 | Also, it is assumed that for deployment of the image to the | ||
577 | target, SSH is installed in the image and if the image is running | ||
578 | on real hardware that you have network access to and from your | ||
579 | development machine. | ||
580 | |||
581 | You can deploy your build output to that target hardware by using the | ||
582 | ``devtool deploy-target`` command:: | ||
583 | |||
584 | $ devtool deploy-target recipe target | ||
585 | |||
586 | The target is a live target machine running as an SSH server. | ||
587 | |||
588 | You can, of course, use other methods to deploy the image you built | ||
589 | using the ``devtool build-image`` command to actual hardware. | ||
590 | ``devtool`` does not provide a specific command to deploy the image | ||
591 | to actual hardware. | ||
592 | |||
593 | #. *Finish Your Work With the Recipe*: The ``devtool finish`` command | ||
594 | creates any patches corresponding to commits in the local Git | ||
595 | repository, updates the recipe to point to them (or creates a | ||
596 | ``.bbappend`` file to do so, depending on the specified destination | ||
597 | layer), and then resets the recipe so that the recipe is built | ||
598 | normally rather than from the workspace:: | ||
599 | |||
600 | $ devtool finish recipe layer | ||
601 | |||
602 | .. note:: | ||
603 | |||
604 | Any changes you want to turn into patches must be staged and | ||
605 | committed within the local Git repository before you use the | ||
606 | ``devtool finish`` command. | ||
607 | |||
608 | Because there is no need to move the recipe, ``devtool finish`` | ||
609 | either updates the original recipe in the original layer or the | ||
610 | command creates a ``.bbappend`` file in a different layer as provided | ||
611 | by layer. Any work you did in the ``oe-local-files`` directory is | ||
612 | preserved in the original files next to the recipe during the | ||
613 | ``devtool finish`` command. | ||
614 | |||
615 | As a final process of the ``devtool finish`` command, the state of | ||
616 | the standard layers and the upstream source is restored so that you | ||
617 | can build the recipe from those areas rather than from the workspace. | ||
618 | |||
619 | .. note:: | ||
620 | |||
621 | You can use the ``devtool reset`` command to put things back should you | ||
622 | decide you do not want to proceed with your work. If you do use this | ||
623 | command, realize that the source tree is preserved. | ||
624 | |||
625 | ``devtool ide-sdk`` configures IDEs for the extensible SDK | ||
626 | ---------------------------------------------------------- | ||
627 | |||
628 | ``devtool ide-sdk`` automatically configures IDEs to use the extensible SDK. | ||
629 | To make sure that all parts of the extensible SDK required by the generated | ||
630 | IDE configuration are available, ``devtool ide-sdk`` uses BitBake in the | ||
631 | background to bootstrap the extensible SDK. | ||
632 | |||
633 | The extensible SDK supports two different development modes. | ||
634 | ``devtool ide-sdk`` supports both of them: | ||
635 | |||
636 | #. *Modified mode*: | ||
637 | |||
638 | By default ``devtool ide-sdk`` generates IDE configurations for recipes in | ||
639 | workspaces created by ``devtool modify`` or ``devtool add`` as described in | ||
640 | :ref:`using_devtool`. This mode creates IDE configurations with support for | ||
641 | advanced features, such as deploying the binaries to the remote target | ||
642 | device and performing remote debugging sessions. The generated IDE | ||
643 | configurations use the per recipe sysroots as Bitbake does internally. | ||
644 | |||
645 | In order to use the tool, a few settings are needed. As a starting example, | ||
646 | the following lines of code can be added to the ``local.conf`` file:: | ||
647 | |||
648 | # Build the companion debug file system | ||
649 | IMAGE_GEN_DEBUGFS = "1" | ||
650 | # Optimize build time: with devtool ide-sdk the dbg tar is not needed | ||
651 | IMAGE_FSTYPES_DEBUGFS = "" | ||
652 | # Without copying the binaries into roofs-dbg, GDB does not find all source files. | ||
653 | IMAGE_CLASSES += "image-combined-dbg" | ||
654 | |||
655 | # SSH is mandatory, no password simplifies the usage | ||
656 | EXTRA_IMAGE_FEATURES += "\ | ||
657 | ssh-server-openssh \ | ||
658 | debug-tweaks \ | ||
659 | " | ||
660 | |||
661 | # Remote debugging needs gdbserver on the target device | ||
662 | IMAGE_INSTALL:append = " gdbserver" | ||
663 | |||
664 | # Add the recipes which should be modified to the image | ||
665 | # Otherwise some dependencies might be missing. | ||
666 | IMAGE_INSTALL:append = " my-recipe" | ||
667 | |||
668 | Assuming the BitBake environment is set up correctly and a workspace has | ||
669 | been created for the recipe using ``devtool modify my-recipe``, the | ||
670 | following command can create the SDK and the configuration for VSCode in | ||
671 | the recipe workspace:: | ||
672 | |||
673 | $ devtool ide-sdk my-recipe core-image-minimal --target root@192.168.7.2 | ||
674 | |||
675 | The command requires an image recipe (``core-image-minimal`` for this example) | ||
676 | that is used to create the SDK. This firmware image should also be installed | ||
677 | on the target device. It is possible to pass multiple package recipes. | ||
678 | ``devtool ide-sdk`` tries to create an IDE configuration for all package | ||
679 | recipes. | ||
680 | |||
681 | What this command does exactly depends on the recipe, more precisely on the | ||
682 | build tool used by the recipe. The basic idea is to configure the IDE so | ||
683 | that it calls the build tool exactly as ``bitbake`` does. | ||
684 | |||
685 | For example, a CMake preset is created for a recipe that inherits | ||
686 | :ref:`ref-classes-cmake`. In the case of VSCode, CMake presets are supported | ||
687 | by the CMake Tools plugin. This is an example of how the build | ||
688 | configuration used by ``bitbake`` is exported to an IDE configuration that | ||
689 | gives exactly the same build results. | ||
690 | |||
691 | Support for remote debugging with seamless integration into the IDE is | ||
692 | important for a cross-SDK. ``devtool ide-sdk`` automatically generates the | ||
693 | necessary helper scripts for deploying the compiled artifacts to the target | ||
694 | device as well as the necessary configuration for the debugger and the IDE. | ||
695 | |||
696 | .. note:: | ||
697 | |||
698 | To ensure that the debug symbols on the build machine match the binaries | ||
699 | running on the target device, it is essential that the image built by | ||
700 | ``devtool ide-sdk`` is running on the target device. | ||
701 | |||
702 | ``devtool ide-sdk`` aims to support multiple programming languages and | ||
703 | multiple IDEs natively. "Natively" means that the IDE is configured to call | ||
704 | the build tool (e.g. CMake or Meson) directly. This has several advantages. | ||
705 | First of all, it is much faster than ``devtool build``, but it also allows | ||
706 | to use the very good integration of tools like CMake or GDB in VSCode and | ||
707 | other IDEs. However, supporting many programming languages and multiple | ||
708 | IDEs is quite an elaborate and constantly evolving thing. Support for IDEs | ||
709 | is therefore implemented as plugins. Plugins can also be provided by | ||
710 | optional layers. | ||
711 | |||
712 | The default IDE is VSCode. Some hints about using VSCode: | ||
713 | |||
714 | - To work on the source code of a recipe an instance of VSCode is started in | ||
715 | the recipe's workspace. Example:: | ||
716 | |||
717 | code build/workspace/sources/my-recipe | ||
718 | |||
719 | - To work with CMake press ``Ctrl + Shift + p``, type ``cmake``. This will | ||
720 | show some possible commands like selecting a CMake preset, compiling or | ||
721 | running CTest. | ||
722 | |||
723 | For recipes inheriting :ref:`ref-classes-cmake-qemu` rather than | ||
724 | :ref:`ref-classes-cmake`, executing cross-compiled unit tests on the host | ||
725 | can be supported transparently with QEMU user-mode. | ||
726 | |||
727 | - To work with Meson press ``Ctrl + Shift + p``, type ``meson``. This will | ||
728 | show some possible commands like compiling or executing the unit tests. | ||
729 | |||
730 | A note on running cross-compiled unit tests on the host: Meson enables | ||
731 | support for QEMU user-mode by default. It is expected that the execution | ||
732 | of the unit tests from the IDE will work easily without any additional | ||
733 | steps, provided that the code is suitable for execution on the host | ||
734 | machine. | ||
735 | |||
736 | - For the deployment to the target device, just press ``Ctrl + Shift + p``, | ||
737 | type ``task``. Select ``install && deploy-target``. | ||
738 | |||
739 | - For remote debugging, switch to the debugging view by pressing the "play" | ||
740 | button with the ``bug icon`` on the left side. This will provide a green | ||
741 | play button with a drop-down list where a debug configuration can be | ||
742 | selected. After selecting one of the generated configurations, press the | ||
743 | "play" button. | ||
744 | |||
745 | Starting a remote debugging session automatically initiates the deployment | ||
746 | to the target device. If this is not desired, the | ||
747 | ``"dependsOn": ["install && deploy-target...]`` parameter of the tasks | ||
748 | with ``"label": "gdbserver start...`` can be removed from the | ||
749 | ``tasks.json`` file. | ||
750 | |||
751 | VSCode supports GDB with many different setups and configurations for many | ||
752 | different use cases. However, most of these setups have some limitations | ||
753 | when it comes to cross-development, support only a few target | ||
754 | architectures or require a high performance target device. Therefore | ||
755 | ``devtool ide-sdk`` supports the classic, generic setup with GDB on the | ||
756 | development host and gdbserver on the target device. | ||
757 | |||
758 | Roughly summarized, this means: | ||
759 | |||
760 | - The binaries are copied via SSH to the remote target device by a script | ||
761 | referred by ``tasks.json``. | ||
762 | |||
763 | - gdbserver is started on the remote target device via SSH by a script | ||
764 | referred by ``tasks.json``. | ||
765 | |||
766 | Changing the parameters that are passed to the debugging executable | ||
767 | requires modifying the generated script. The script is located at | ||
768 | ``oe-scripts/gdbserver_*``. Defining the parameters in the ``args`` | ||
769 | field in the ``launch.json`` file does not work. | ||
770 | |||
771 | - VSCode connects to gdbserver as documented in | ||
772 | `Remote debugging or debugging with a local debugger server | ||
773 | <https://code.visualstudio.com/docs/cpp/launch-json-reference#_remote-debugging-or-debugging-with-a-local-debugger-server>`__. | ||
774 | |||
775 | Additionally ``--ide=none`` is supported. With the ``none`` IDE parameter, | ||
776 | some generic configuration files like ``gdbinit`` files and some helper | ||
777 | scripts starting gdbserver remotely on the target device as well as the GDB | ||
778 | client on the host are generated. | ||
779 | |||
780 | Here is a usage example for the ``cmake-example`` recipe from the | ||
781 | ``meta-selftest`` layer which inherits :ref:`ref-classes-cmake-qemu`: | ||
782 | |||
783 | .. code-block:: sh | ||
784 | |||
785 | # Create the SDK | ||
786 | devtool modify cmake-example | ||
787 | devtool ide-sdk cmake-example core-image-minimal -c --debug-build-config --ide=none | ||
788 | |||
789 | # Install the firmware on a target device or start QEMU | ||
790 | runqemu | ||
791 | |||
792 | # From exploring the workspace of cmake-example | ||
793 | cd build/workspace/sources/cmake-example | ||
794 | |||
795 | # Find cmake-native and save the path into a variable | ||
796 | # Note: using just cmake instead of $CMAKE_NATIVE would work in many cases | ||
797 | CMAKE_NATIVE="$(jq -r '.configurePresets[0] | "\(.cmakeExecutable)"' CMakeUserPresets.json)" | ||
798 | |||
799 | # List available CMake presets | ||
800 | "$CMAKE_NATIVE" --list-presets | ||
801 | Available configure presets: | ||
802 | |||
803 | "cmake-example-cortexa57" - cmake-example: cortexa57 | ||
804 | |||
805 | # Re-compile the already compiled sources | ||
806 | "$CMAKE_NATIVE" --build --preset cmake-example-cortexa57 | ||
807 | ninja: no work to do. | ||
808 | # Do a clean re-build | ||
809 | "$CMAKE_NATIVE" --build --preset cmake-example-cortexa57 --target clean | ||
810 | [1/1] Cleaning all built files... | ||
811 | Cleaning... 8 files. | ||
812 | "$CMAKE_NATIVE" --build --preset cmake-example-cortexa57 --target all | ||
813 | [7/7] Linking CXX executable cmake-example | ||
814 | |||
815 | # Run the cross-compiled unit tests with QEMU user-mode | ||
816 | "$CMAKE_NATIVE" --build --preset cmake-example-cortexa57 --target test | ||
817 | [0/1] Running tests... | ||
818 | Test project .../build/tmp/work/cortexa57-poky-linux/cmake-example/1.0/cmake-example-1.0 | ||
819 | Start 1: test-cmake-example | ||
820 | 1/1 Test #1: test-cmake-example ............... Passed 0.03 sec | ||
821 | |||
822 | 100% tests passed, 0 tests failed out of 1 | ||
823 | |||
824 | Total Test time (real) = 0.03 sec | ||
825 | |||
826 | # Using CTest directly is possible as well | ||
827 | CTEST_NATIVE="$(dirname "$CMAKE_NATIVE")/ctest" | ||
828 | |||
829 | # List available CMake presets | ||
830 | "$CTEST_NATIVE" --list-presets | ||
831 | Available test presets: | ||
832 | |||
833 | "cmake-example-cortexa57" - cmake-example: cortexa57 | ||
834 | |||
835 | # Run the cross-compiled unit tests with QEMU user-mode | ||
836 | "$CTEST_NATIVE" --preset "cmake-example-cortexa57" | ||
837 | Test project ...build/tmp/work/cortexa57-poky-linux/cmake-example/1.0/cmake-example-1.0 | ||
838 | Start 1: test-cmake-example | ||
839 | 1/1 Test #1: test-cmake-example ............... Passed 0.03 sec | ||
840 | |||
841 | 100% tests passed, 0 tests failed out of 1 | ||
842 | |||
843 | Total Test time (real) = 0.03 sec | ||
844 | |||
845 | # Deploying the new build to the target device (default is QEUM at 192.168.7.2) | ||
846 | oe-scripts/install_and_deploy_cmake-example-cortexa57 | ||
847 | |||
848 | # Start a remote debugging session with gdbserver on the target and GDB on the host | ||
849 | oe-scripts/gdbserver_1234_usr-bin-cmake-example_m | ||
850 | oe-scripts/gdb_1234_usr-bin-cmake-example | ||
851 | break main | ||
852 | run | ||
853 | step | ||
854 | stepi | ||
855 | continue | ||
856 | quit | ||
857 | |||
858 | # Stop gdbserver on the target device | ||
859 | oe-scripts/gdbserver_1234_usr-bin-cmake-example_m stop | ||
860 | |||
861 | #. *Shared sysroots mode* | ||
862 | |||
863 | For some recipes and use cases a per-recipe sysroot based SDK is not | ||
864 | suitable. Optionally ``devtool ide-sdk`` configures the IDE to use the | ||
865 | toolchain provided by the extensible SDK as described in | ||
866 | :ref:`running_the_ext_sdk_env`. ``devtool ide-sdk --mode=shared`` is | ||
867 | basically a wrapper for the setup of the extensible SDK as described in | ||
868 | :ref:`setting_up_ext_sdk_in_build`. The IDE gets a configuration to use the | ||
869 | shared sysroots. | ||
870 | |||
871 | Creating a SDK with shared sysroots that contains all the dependencies needed | ||
872 | to work with ``my-recipe`` is possible with the following example command:: | ||
873 | |||
874 | $ devtool ide-sdk --mode=shared my-recipe | ||
875 | |||
876 | For VSCode the cross-toolchain is exposed as a CMake kit. CMake kits are | ||
877 | defined in ``~/.local/share/CMakeTools/cmake-tools-kits.json``. | ||
878 | The following example shows how the cross-toolchain can be selected in | ||
879 | VSCode. First of all we need a folder containing a CMake project. | ||
880 | For this example, let's create a CMake project and start VSCode:: | ||
881 | |||
882 | mkdir kit-test | ||
883 | echo "project(foo VERSION 1.0)" > kit-test/CMakeLists.txt | ||
884 | code kit-test | ||
885 | |||
886 | If there is a CMake project in the workspace, cross-compilation is supported: | ||
887 | |||
888 | - Press ``Ctrl + Shift + P``, type ``CMake: Scan for Kits`` | ||
889 | - Press ``Ctrl + Shift + P``, type ``CMake: Select a Kit`` | ||
890 | |||
891 | Finally most of the features provided by CMake and the IDE should be available. | ||
892 | |||
893 | Other IDEs than VSCode are supported as well. However, | ||
894 | ``devtool ide-sdk --mode=shared --ide=none my-recipe`` is currently | ||
895 | just a simple wrapper for the setup of the extensible SDK, as described in | ||
896 | :ref:`setting_up_ext_sdk_in_build`. | ||
897 | |||
898 | Use ``devtool upgrade`` to Create a Version of the Recipe that Supports a Newer Version of the Software | ||
899 | ------------------------------------------------------------------------------------------------------- | ||
900 | |||
901 | The ``devtool upgrade`` command upgrades an existing recipe to that of a | ||
902 | more up-to-date version found upstream. Throughout the life of software, | ||
903 | recipes continually undergo version upgrades by their upstream | ||
904 | publishers. You can use the ``devtool upgrade`` workflow to make sure | ||
905 | your recipes you are using for builds are up-to-date with their upstream | ||
906 | counterparts. | ||
907 | |||
908 | .. note:: | ||
909 | |||
910 | Several methods exist by which you can upgrade recipes --- | ||
911 | ``devtool upgrade`` happens to be one. You can read about all the methods by | ||
912 | which you can upgrade recipes in the | ||
913 | :ref:`dev-manual/upgrading-recipes:upgrading recipes` section of the Yocto | ||
914 | Project Development Tasks Manual. | ||
915 | |||
916 | The ``devtool upgrade`` command is flexible enough to allow you to specify | ||
917 | source code revision and versioning schemes, extract code into or out of the | ||
918 | ``devtool`` :ref:`devtool-the-workspace-layer-structure`, and work with any | ||
919 | source file forms that the | ||
920 | :ref:`bitbake-user-manual/bitbake-user-manual-fetching:fetchers` support. | ||
921 | |||
922 | The following diagram shows the common development flow used with the | ||
923 | ``devtool upgrade`` command: | ||
924 | |||
925 | .. image:: figures/sdk-devtool-upgrade-flow.png | ||
926 | :width: 100% | ||
927 | |||
928 | #. *Initiate the Upgrade*: The top part of the flow shows the typical | ||
929 | scenario by which you use the ``devtool upgrade`` command. The | ||
930 | following conditions exist: | ||
931 | |||
932 | - The recipe exists in a local layer external to the ``devtool`` | ||
933 | workspace. | ||
934 | |||
935 | - The source files for the new release exist in the same location | ||
936 | pointed to by :term:`SRC_URI` | ||
937 | in the recipe (e.g. a tarball with the new version number in the | ||
938 | name, or as a different revision in the upstream Git repository). | ||
939 | |||
940 | A common situation is where third-party software has undergone a | ||
941 | revision so that it has been upgraded. The recipe you have access to | ||
942 | is likely in your own layer. Thus, you need to upgrade the recipe to | ||
943 | use the newer version of the software:: | ||
944 | |||
945 | $ devtool upgrade -V version recipe | ||
946 | |||
947 | By default, the ``devtool upgrade`` command extracts source | ||
948 | code into the ``sources`` directory in the | ||
949 | :ref:`devtool-the-workspace-layer-structure`. | ||
950 | If you want the code extracted to any other location, you need to | ||
951 | provide the ``srctree`` positional argument with the command as follows:: | ||
952 | |||
953 | $ devtool upgrade -V version recipe srctree | ||
954 | |||
955 | .. note:: | ||
956 | |||
957 | In this example, the "-V" option specifies the new version. If you | ||
958 | don't use "-V", the command upgrades the recipe to the latest | ||
959 | version. | ||
960 | |||
961 | If the source files pointed to by the :term:`SRC_URI` statement in the | ||
962 | recipe are in a Git repository, you must provide the "-S" option and | ||
963 | specify a revision for the software. | ||
964 | |||
965 | Once ``devtool`` locates the recipe, it uses the :term:`SRC_URI` variable | ||
966 | to locate the source code and any local patch files from other | ||
967 | developers. The result is that the command sets up the source code, | ||
968 | the new version of the recipe, and an append file all within the | ||
969 | workspace. | ||
970 | |||
971 | Additionally, if you have any non-patch local files (i.e. files | ||
972 | referred to with ``file://`` entries in :term:`SRC_URI` statement | ||
973 | excluding ``*.patch/`` or ``*.diff``), these files are copied to an | ||
974 | ``oe-local-files`` folder under the newly created source tree. | ||
975 | Copying the files here gives you a convenient area from which you can | ||
976 | modify the files. Any changes or additions you make to those files | ||
977 | are incorporated into the build the next time you build the software | ||
978 | just as are other changes you might have made to the source. | ||
979 | |||
980 | #. *Resolve any Conflicts created by the Upgrade*: Conflicts could happen | ||
981 | after upgrading the software to a new version. Conflicts occur | ||
982 | if your recipe specifies some patch files in :term:`SRC_URI` that | ||
983 | conflict with changes made in the new version of the software. For | ||
984 | such cases, you need to resolve the conflicts by editing the source | ||
985 | and following the normal ``git rebase`` conflict resolution process. | ||
986 | |||
987 | Before moving onto the next step, be sure to resolve any such | ||
988 | conflicts created through use of a newer or different version of the | ||
989 | software. | ||
990 | |||
991 | #. *Build the Recipe or Rebuild the Image*: The next step you take | ||
992 | depends on what you are going to do with the new code. | ||
993 | |||
994 | If you need to eventually move the build output to the target | ||
995 | hardware, use the following ``devtool`` command:: | ||
996 | |||
997 | $ devtool build recipe | ||
998 | |||
999 | On the other hand, if you want an image to contain the recipe's | ||
1000 | packages from the workspace for immediate deployment onto a device | ||
1001 | (e.g. for testing purposes), you can use the ``devtool build-image`` | ||
1002 | command:: | ||
1003 | |||
1004 | $ devtool build-image image | ||
1005 | |||
1006 | #. *Deploy the Build Output*: When you use the ``devtool build`` command | ||
1007 | or ``bitbake`` to build your recipe, you probably want to see if the | ||
1008 | resulting build output works as expected on target hardware. | ||
1009 | |||
1010 | .. note:: | ||
1011 | |||
1012 | This step assumes you have a previously built image that is | ||
1013 | already either running in QEMU or running on actual hardware. | ||
1014 | Also, it is assumed that for deployment of the image to the | ||
1015 | target, SSH is installed in the image and if the image is running | ||
1016 | on real hardware that you have network access to and from your | ||
1017 | development machine. | ||
1018 | |||
1019 | You can deploy your build output to that target hardware by using the | ||
1020 | ``devtool deploy-target`` command:: | ||
1021 | |||
1022 | $ devtool deploy-target recipe target | ||
1023 | |||
1024 | The target is a live target machine running as an SSH server. | ||
1025 | |||
1026 | You can, of course, also deploy the image you build using the | ||
1027 | ``devtool build-image`` command to actual hardware. However, | ||
1028 | ``devtool`` does not provide a specific command that allows you to do | ||
1029 | this. | ||
1030 | |||
1031 | #. *Finish Your Work With the Recipe*: The ``devtool finish`` command | ||
1032 | creates any patches corresponding to commits in the local Git | ||
1033 | repository, moves the new recipe to a more permanent layer, and then | ||
1034 | resets the recipe so that the recipe is built normally rather than | ||
1035 | from the workspace. | ||
1036 | |||
1037 | Any work you did in the ``oe-local-files`` directory is preserved in | ||
1038 | the original files next to the recipe during the ``devtool finish`` | ||
1039 | command. | ||
1040 | |||
1041 | If you specify a destination layer that is the same as the original | ||
1042 | source, then the old version of the recipe and associated files are | ||
1043 | removed prior to adding the new version:: | ||
1044 | |||
1045 | $ devtool finish recipe layer | ||
1046 | |||
1047 | .. note:: | ||
1048 | |||
1049 | Any changes you want to turn into patches must be committed to the | ||
1050 | Git repository in the source tree. | ||
1051 | |||
1052 | As a final process of the ``devtool finish`` command, the state of | ||
1053 | the standard layers and the upstream source is restored so that you | ||
1054 | can build the recipe from those areas rather than the workspace. | ||
1055 | |||
1056 | .. note:: | ||
1057 | |||
1058 | You can use the ``devtool reset`` command to put things back should you | ||
1059 | decide you do not want to proceed with your work. If you do use this | ||
1060 | command, realize that the source tree is preserved. | ||
1061 | |||
1062 | A Closer Look at ``devtool add`` | ||
1063 | ================================ | ||
1064 | |||
1065 | The ``devtool add`` command automatically creates a recipe based on the | ||
1066 | source tree you provide with the command. Currently, the command has | ||
1067 | support for the following: | ||
1068 | |||
1069 | - Autotools (``autoconf`` and ``automake``) | ||
1070 | |||
1071 | - CMake | ||
1072 | |||
1073 | - Scons | ||
1074 | |||
1075 | - ``qmake`` | ||
1076 | |||
1077 | - Plain ``Makefile`` | ||
1078 | |||
1079 | - Out-of-tree kernel module | ||
1080 | |||
1081 | - Binary package (i.e. "-b" option) | ||
1082 | |||
1083 | - Node.js module | ||
1084 | |||
1085 | - Python modules that use ``setuptools`` or ``distutils`` | ||
1086 | |||
1087 | Apart from binary packages, the determination of how a source tree | ||
1088 | should be treated is automatic based on the files present within that | ||
1089 | source tree. For example, if a ``CMakeLists.txt`` file is found, then | ||
1090 | the source tree is assumed to be using CMake and is treated accordingly. | ||
1091 | |||
1092 | .. note:: | ||
1093 | |||
1094 | In most cases, you need to edit the automatically generated recipe in | ||
1095 | order to make it build properly. Typically, you would go through | ||
1096 | several edit and build cycles until the recipe successfully builds. | ||
1097 | Once the recipe builds, you could use possible further iterations to | ||
1098 | test the recipe on the target device. | ||
1099 | |||
1100 | The remainder of this section covers specifics regarding how parts of | ||
1101 | the recipe are generated. | ||
1102 | |||
1103 | Name and Version | ||
1104 | ---------------- | ||
1105 | |||
1106 | If you do not specify a name and version on the command line, | ||
1107 | ``devtool add`` uses various metadata within the source tree in an | ||
1108 | attempt to determine the name and version of the software being built. | ||
1109 | Based on what the tool determines, ``devtool`` sets the name of the | ||
1110 | created recipe file accordingly. | ||
1111 | |||
1112 | If ``devtool`` cannot determine the name and version, the command prints | ||
1113 | an error. For such cases, you must re-run the command and provide the | ||
1114 | name and version, just the name, or just the version as part of the | ||
1115 | command line. | ||
1116 | |||
1117 | Sometimes the name or version determined from the source tree might be | ||
1118 | incorrect. For such a case, you must reset the recipe:: | ||
1119 | |||
1120 | $ devtool reset -n recipename | ||
1121 | |||
1122 | After running the ``devtool reset`` command, you need to | ||
1123 | run ``devtool add`` again and provide the name or the version. | ||
1124 | |||
1125 | Dependency Detection and Mapping | ||
1126 | -------------------------------- | ||
1127 | |||
1128 | The ``devtool add`` command attempts to detect build-time dependencies and map | ||
1129 | them to other recipes in the system. During this mapping, the command fills in | ||
1130 | the names of those recipes as part of the :term:`DEPENDS` variable within the | ||
1131 | recipe. If a dependency cannot be mapped, ``devtool`` places a comment | ||
1132 | in the recipe indicating such. The inability to map a dependency can | ||
1133 | result from naming not being recognized or because the dependency simply | ||
1134 | is not available. For cases where the dependency is not available, you | ||
1135 | must use the ``devtool add`` command to add an additional recipe that | ||
1136 | satisfies the dependency. Once you add that recipe, you need to update | ||
1137 | the :term:`DEPENDS` variable in the original recipe to include the new | ||
1138 | recipe. | ||
1139 | |||
1140 | If you need to add runtime dependencies, you can do so by adding the | ||
1141 | following to your recipe:: | ||
1142 | |||
1143 | RDEPENDS:${PN} += "dependency1 dependency2 ..." | ||
1144 | |||
1145 | .. note:: | ||
1146 | |||
1147 | The ``devtool add`` command often cannot distinguish between mandatory and | ||
1148 | optional dependencies. Consequently, some of the detected dependencies might | ||
1149 | in fact be optional. When in doubt, consult the documentation or the | ||
1150 | configure script for the software the recipe is building for further | ||
1151 | details. In some cases, you might find you can substitute the | ||
1152 | dependency with an option that disables the associated functionality | ||
1153 | passed to the configure script. | ||
1154 | |||
1155 | License Detection | ||
1156 | ----------------- | ||
1157 | |||
1158 | The ``devtool add`` command attempts to determine if the software you are | ||
1159 | adding is able to be distributed under a common, open-source license. If | ||
1160 | so, the command sets the :term:`LICENSE` value accordingly. | ||
1161 | You should double-check the value added by the command against the | ||
1162 | documentation or source files for the software you are building and, if | ||
1163 | necessary, update that :term:`LICENSE` value. | ||
1164 | |||
1165 | The ``devtool add`` command also sets the :term:`LIC_FILES_CHKSUM` | ||
1166 | value to point to all files that appear to be license-related. Realize | ||
1167 | that license statements often appear in comments at the top of source | ||
1168 | files or within the documentation. In such cases, the command does not | ||
1169 | recognize those license statements. Consequently, you might need to | ||
1170 | amend the :term:`LIC_FILES_CHKSUM` variable to point to one or more of those | ||
1171 | comments if present. Setting :term:`LIC_FILES_CHKSUM` is particularly | ||
1172 | important for third-party software. The mechanism attempts to ensure | ||
1173 | correct licensing should you upgrade the recipe to a newer upstream | ||
1174 | version in future. Any change in licensing is detected and you receive | ||
1175 | an error prompting you to check the license text again. | ||
1176 | |||
1177 | If the ``devtool add`` command cannot determine licensing information, | ||
1178 | ``devtool`` sets the :term:`LICENSE` value to "CLOSED" and leaves the | ||
1179 | :term:`LIC_FILES_CHKSUM` value unset. This behavior allows you to continue | ||
1180 | with development even though the settings are unlikely to be correct in | ||
1181 | all cases. You should check the documentation or source files for the | ||
1182 | software you are building to determine the actual license. | ||
1183 | |||
1184 | Adding Makefile-Only Software | ||
1185 | ----------------------------- | ||
1186 | |||
1187 | The use of Make by itself is very common in both proprietary and | ||
1188 | open-source software. Unfortunately, Makefiles are often not written | ||
1189 | with cross-compilation in mind. Thus, ``devtool add`` often cannot do | ||
1190 | very much to ensure that these Makefiles build correctly. It is very | ||
1191 | common, for example, to explicitly call ``gcc`` instead of using the | ||
1192 | :term:`CC` variable. Usually, in a | ||
1193 | cross-compilation environment, ``gcc`` is the compiler for the build | ||
1194 | host and the cross-compiler is named something similar to | ||
1195 | ``arm-poky-linux-gnueabi-gcc`` and might require arguments (e.g. to | ||
1196 | point to the associated sysroot for the target machine). | ||
1197 | |||
1198 | When writing a recipe for Makefile-only software, keep the following in | ||
1199 | mind: | ||
1200 | |||
1201 | - You probably need to patch the Makefile to use variables instead of | ||
1202 | hardcoding tools within the toolchain such as ``gcc`` and ``g++``. | ||
1203 | |||
1204 | - The environment in which Make runs is set up with various standard | ||
1205 | variables for compilation (e.g. :term:`CC`, :term:`CXX`, and so forth) in a | ||
1206 | similar manner to the environment set up by the SDK's environment | ||
1207 | setup script. One easy way to see these variables is to run the | ||
1208 | ``devtool build`` command on the recipe and then look in | ||
1209 | ``oe-logs/run.do_compile``. Towards the top of this file, there is | ||
1210 | a list of environment variables that are set. You can take | ||
1211 | advantage of these variables within the Makefile. | ||
1212 | |||
1213 | - If the Makefile sets a default for a variable using "=", that default | ||
1214 | overrides the value set in the environment, which is usually not | ||
1215 | desirable. For this case, you can either patch the Makefile so it | ||
1216 | sets the default using the "?=" operator, or you can alternatively | ||
1217 | force the value on the ``make`` command line. To force the value on | ||
1218 | the command line, add the variable setting to | ||
1219 | :term:`EXTRA_OEMAKE` or | ||
1220 | :term:`PACKAGECONFIG_CONFARGS` | ||
1221 | within the recipe. Here is an example using :term:`EXTRA_OEMAKE`:: | ||
1222 | |||
1223 | EXTRA_OEMAKE += "'CC=${CC}' 'CXX=${CXX}'" | ||
1224 | |||
1225 | In the above example, | ||
1226 | single quotes are used around the variable settings as the values are | ||
1227 | likely to contain spaces because required default options are passed | ||
1228 | to the compiler. | ||
1229 | |||
1230 | - Hardcoding paths inside Makefiles is often problematic in a | ||
1231 | cross-compilation environment. This is particularly true because | ||
1232 | those hardcoded paths often point to locations on the build host and | ||
1233 | thus will either be read-only or will introduce contamination into | ||
1234 | the cross-compilation because they are specific to the build host | ||
1235 | rather than the target. Patching the Makefile to use prefix variables | ||
1236 | or other path variables is usually the way to handle this situation. | ||
1237 | |||
1238 | - Sometimes a Makefile runs target-specific commands such as | ||
1239 | ``ldconfig``. For such cases, you might be able to apply patches that | ||
1240 | remove these commands from the Makefile. | ||
1241 | |||
1242 | Adding Native Tools | ||
1243 | ------------------- | ||
1244 | |||
1245 | Often, you need to build additional tools that run on the :term:`Build Host` | ||
1246 | as opposed to the target. You should indicate this requirement by using one of | ||
1247 | the following methods when you run ``devtool add``: | ||
1248 | |||
1249 | - Specify the name of the recipe such that it ends with "-native". | ||
1250 | Specifying the name like this produces a recipe that only builds for | ||
1251 | the build host. | ||
1252 | |||
1253 | - Specify the "--also-native" option with the ``devtool add`` | ||
1254 | command. Specifying this option creates a recipe file that still | ||
1255 | builds for the target but also creates a variant with a "-native" | ||
1256 | suffix that builds for the build host. | ||
1257 | |||
1258 | .. note:: | ||
1259 | |||
1260 | If you need to add a tool that is shipped as part of a source tree | ||
1261 | that builds code for the target, you can typically accomplish this by | ||
1262 | building the native and target parts separately rather than within | ||
1263 | the same compilation process. Realize though that with the | ||
1264 | "--also-native" option, you can add the tool using just one | ||
1265 | recipe file. | ||
1266 | |||
1267 | Adding Node.js Modules | ||
1268 | ---------------------- | ||
1269 | |||
1270 | You can use the ``devtool add`` command two different ways to add | ||
1271 | Node.js modules: through ``npm`` or from a repository or local source. | ||
1272 | |||
1273 | Use the following form to add Node.js modules through ``npm``:: | ||
1274 | |||
1275 | $ devtool add "npm://registry.npmjs.org;name=forever;version=0.15.1" | ||
1276 | |||
1277 | The name and | ||
1278 | version parameters are mandatory. Lockdown and shrinkwrap files are | ||
1279 | generated and pointed to by the recipe in order to freeze the version | ||
1280 | that is fetched for the dependencies according to the first time. This | ||
1281 | also saves checksums that are verified on future fetches. Together, | ||
1282 | these behaviors ensure the reproducibility and integrity of the build. | ||
1283 | |||
1284 | .. note:: | ||
1285 | |||
1286 | - You must use quotes around the URL. ``devtool add`` does not | ||
1287 | require the quotes, but the shell considers ";" as a splitter | ||
1288 | between multiple commands. Thus, without the quotes, | ||
1289 | ``devtool add`` does not receive the other parts, which results in | ||
1290 | several "command not found" errors. | ||
1291 | |||
1292 | - In order to support adding Node.js modules, a ``nodejs`` recipe | ||
1293 | must be part of your SDK. | ||
1294 | |||
1295 | As mentioned earlier, you can also add Node.js modules directly from a | ||
1296 | repository or local source tree. To add modules this way, use | ||
1297 | ``devtool add`` in the following form:: | ||
1298 | |||
1299 | $ devtool add https://github.com/diversario/node-ssdp | ||
1300 | |||
1301 | In this example, ``devtool`` fetches the specified Git repository, detects the | ||
1302 | code as Node.js code, fetches dependencies using ``npm``, and sets | ||
1303 | :term:`SRC_URI` accordingly. | ||
1304 | |||
1305 | Working With Recipes | ||
1306 | ==================== | ||
1307 | |||
1308 | When building a recipe using the ``devtool build`` command, the typical | ||
1309 | build progresses as follows: | ||
1310 | |||
1311 | #. Fetch the source | ||
1312 | |||
1313 | #. Unpack the source | ||
1314 | |||
1315 | #. Configure the source | ||
1316 | |||
1317 | #. Compile the source | ||
1318 | |||
1319 | #. Install the build output | ||
1320 | |||
1321 | #. Package the installed output | ||
1322 | |||
1323 | For recipes in the workspace, fetching and unpacking is disabled as the | ||
1324 | source tree has already been prepared and is persistent. Each of these | ||
1325 | build steps is defined as a function (task), usually with a "do\_" prefix | ||
1326 | (e.g. :ref:`ref-tasks-fetch`, | ||
1327 | :ref:`ref-tasks-unpack`, and so | ||
1328 | forth). These functions are typically shell scripts but can instead be | ||
1329 | written in Python. | ||
1330 | |||
1331 | If you look at the contents of a recipe, you will see that the recipe | ||
1332 | does not include complete instructions for building the software. | ||
1333 | Instead, common functionality is encapsulated in classes inherited with | ||
1334 | the ``inherit`` directive. This technique leaves the recipe to describe | ||
1335 | just the things that are specific to the software being built. There is | ||
1336 | a :ref:`ref-classes-base` class that is implicitly inherited by all recipes | ||
1337 | and provides the functionality that most recipes typically need. | ||
1338 | |||
1339 | The remainder of this section presents information useful when working | ||
1340 | with recipes. | ||
1341 | |||
1342 | Finding Logs and Work Files | ||
1343 | --------------------------- | ||
1344 | |||
1345 | After the first run of the ``devtool build`` command, recipes that were | ||
1346 | previously created using the ``devtool add`` command or whose sources | ||
1347 | were modified using the ``devtool modify`` command contain symbolic | ||
1348 | links created within the source tree: | ||
1349 | |||
1350 | - ``oe-logs``: This link points to the directory in which log files and | ||
1351 | run scripts for each build step are created. | ||
1352 | |||
1353 | - ``oe-workdir``: This link points to the temporary work area for the | ||
1354 | recipe. The following locations under ``oe-workdir`` are particularly | ||
1355 | useful: | ||
1356 | |||
1357 | - ``image/``: Contains all of the files installed during the | ||
1358 | :ref:`ref-tasks-install` stage. | ||
1359 | Within a recipe, this directory is referred to by the expression | ||
1360 | ``${``\ :term:`D`\ ``}``. | ||
1361 | |||
1362 | - ``sysroot-destdir/``: Contains a subset of files installed within | ||
1363 | :ref:`ref-tasks-install` that have been put into the shared sysroot. For | ||
1364 | more information, see the | ||
1365 | ":ref:`dev-manual/new-recipe:sharing files between recipes`" section. | ||
1366 | |||
1367 | - ``packages-split/``: Contains subdirectories for each package | ||
1368 | produced by the recipe. For more information, see the | ||
1369 | ":ref:`sdk-manual/extensible:packaging`" section. | ||
1370 | |||
1371 | You can use these links to get more information on what is happening at | ||
1372 | each build step. | ||
1373 | |||
1374 | Setting Configure Arguments | ||
1375 | --------------------------- | ||
1376 | |||
1377 | If the software your recipe is building uses GNU autoconf, then a fixed | ||
1378 | set of arguments is passed to it to enable cross-compilation plus any | ||
1379 | extras specified by :term:`EXTRA_OECONF` or :term:`PACKAGECONFIG_CONFARGS` | ||
1380 | set within the recipe. If you wish to pass additional options, add them | ||
1381 | to :term:`EXTRA_OECONF` or :term:`PACKAGECONFIG_CONFARGS`. Other supported build | ||
1382 | tools have similar variables (e.g. :term:`EXTRA_OECMAKE` for CMake, | ||
1383 | :term:`EXTRA_OESCONS` for Scons, and so forth). If you need to pass anything on | ||
1384 | the ``make`` command line, you can use :term:`EXTRA_OEMAKE` or the | ||
1385 | :term:`PACKAGECONFIG_CONFARGS` variables to do so. | ||
1386 | |||
1387 | You can use the ``devtool configure-help`` command to help you set the | ||
1388 | arguments listed in the previous paragraph. The command determines the | ||
1389 | exact options being passed, and shows them to you along with any custom | ||
1390 | arguments specified through :term:`EXTRA_OECONF` or | ||
1391 | :term:`PACKAGECONFIG_CONFARGS`. If applicable, the command also shows you | ||
1392 | the output of the configure script's "--help" option as a | ||
1393 | reference. | ||
1394 | |||
1395 | Sharing Files Between Recipes | ||
1396 | ----------------------------- | ||
1397 | |||
1398 | Recipes often need to use files provided by other recipes on the | ||
1399 | :term:`Build Host`. For example, | ||
1400 | an application linking to a common library needs access to the library | ||
1401 | itself and its associated headers. The way this access is accomplished | ||
1402 | within the extensible SDK is through the sysroot. There is one sysroot per | ||
1403 | "machine" for which the SDK is being built. In practical terms, this | ||
1404 | means there is a sysroot for the target machine, and a sysroot for | ||
1405 | the build host. | ||
1406 | |||
1407 | Recipes should never write files directly into the sysroot. Instead, | ||
1408 | files should be installed into standard locations during the | ||
1409 | :ref:`ref-tasks-install` task within the ``${``\ :term:`D`\ ``}`` directory. A | ||
1410 | subset of these files automatically goes into the sysroot. The reason | ||
1411 | for this limitation is that almost all files that go into the sysroot | ||
1412 | are cataloged in manifests in order to ensure they can be removed later | ||
1413 | when a recipe is modified or removed. Thus, the sysroot is able to | ||
1414 | remain free from stale files. | ||
1415 | |||
1416 | Packaging | ||
1417 | --------- | ||
1418 | |||
1419 | Packaging is not always particularly relevant within the extensible SDK. | ||
1420 | However, if you examine how build output gets into the final image on | ||
1421 | the target device, it is important to understand packaging because the | ||
1422 | contents of the image are expressed in terms of packages and not | ||
1423 | recipes. | ||
1424 | |||
1425 | During the :ref:`ref-tasks-package` task, files installed during the | ||
1426 | :ref:`ref-tasks-install` task are split into one main package, which is almost | ||
1427 | always named the same as the recipe, and into several other packages. This | ||
1428 | separation exists because not all of those installed files are useful in every | ||
1429 | image. For example, you probably do not need any of the documentation installed | ||
1430 | in a production image. Consequently, for each recipe the documentation | ||
1431 | files are separated into a ``-doc`` package. Recipes that package | ||
1432 | software containing optional modules or plugins might undergo additional | ||
1433 | package splitting as well. | ||
1434 | |||
1435 | After building a recipe, you can see where files have gone by looking in | ||
1436 | the ``oe-workdir/packages-split`` directory, which contains a | ||
1437 | subdirectory for each package. Apart from some advanced cases, the | ||
1438 | :term:`PACKAGES` and :term:`FILES` variables controls | ||
1439 | splitting. The :term:`PACKAGES` variable lists all of the packages to be | ||
1440 | produced, while the :term:`FILES` variable specifies which files to include | ||
1441 | in each package by using an override to specify the package. For | ||
1442 | example, ``FILES:${PN}`` specifies the files to go into the main package | ||
1443 | (i.e. the main package has the same name as the recipe and | ||
1444 | ``${``\ :term:`PN`\ ``}`` evaluates to the | ||
1445 | recipe name). The order of the :term:`PACKAGES` value is significant. For | ||
1446 | each installed file, the first package whose :term:`FILES` value matches the | ||
1447 | file is the package into which the file goes. Both the :term:`PACKAGES` and | ||
1448 | :term:`FILES` variables have default values. Consequently, you might find | ||
1449 | you do not even need to set these variables in your recipe unless the | ||
1450 | software the recipe is building installs files into non-standard | ||
1451 | locations. | ||
1452 | |||
1453 | Restoring the Target Device to its Original State | ||
1454 | ================================================= | ||
1455 | |||
1456 | If you use the ``devtool deploy-target`` command to write a recipe's | ||
1457 | build output to the target, and you are working on an existing component | ||
1458 | of the system, then you might find yourself in a situation where you | ||
1459 | need to restore the original files that existed prior to running the | ||
1460 | ``devtool deploy-target`` command. Because the ``devtool deploy-target`` | ||
1461 | command backs up any files it overwrites, you can use the | ||
1462 | ``devtool undeploy-target`` command to restore those files and remove | ||
1463 | any other files the recipe deployed. Consider the following example:: | ||
1464 | |||
1465 | $ devtool undeploy-target lighttpd root@192.168.7.2 | ||
1466 | |||
1467 | If you have deployed | ||
1468 | multiple applications, you can remove them all using the "-a" option | ||
1469 | thus restoring the target device to its original state:: | ||
1470 | |||
1471 | $ devtool undeploy-target -a root@192.168.7.2 | ||
1472 | |||
1473 | Information about files deployed to | ||
1474 | the target as well as any backed up files are stored on the target | ||
1475 | itself. This storage, of course, requires some additional space on the | ||
1476 | target machine. | ||
1477 | |||
1478 | .. note:: | ||
1479 | |||
1480 | The ``devtool deploy-target`` and ``devtool undeploy-target`` commands do | ||
1481 | not currently interact with any package management system on the target | ||
1482 | device (e.g. RPM or OPKG). Consequently, you should not intermingle | ||
1483 | ``devtool deploy-target`` and package manager operations on the target | ||
1484 | device. Doing so could result in a conflicting set of files. | ||
1485 | 263 | ||
1486 | Installing Additional Items Into the Extensible SDK | 264 | Installing Additional Items Into the Extensible SDK |
1487 | =================================================== | 265 | =================================================== |
diff --git a/documentation/sdk-manual/figures/sdk-devtool-add-flow.png b/documentation/sdk-manual/figures/sdk-devtool-add-flow.png deleted file mode 100644 index e7d6173d2d..0000000000 --- a/documentation/sdk-manual/figures/sdk-devtool-add-flow.png +++ /dev/null | |||
Binary files differ | |||
diff --git a/documentation/sdk-manual/figures/sdk-devtool-modify-flow.png b/documentation/sdk-manual/figures/sdk-devtool-modify-flow.png deleted file mode 100644 index 18ba8b7e65..0000000000 --- a/documentation/sdk-manual/figures/sdk-devtool-modify-flow.png +++ /dev/null | |||
Binary files differ | |||
diff --git a/documentation/sdk-manual/figures/sdk-devtool-upgrade-flow.png b/documentation/sdk-manual/figures/sdk-devtool-upgrade-flow.png deleted file mode 100644 index 7d4f395e24..0000000000 --- a/documentation/sdk-manual/figures/sdk-devtool-upgrade-flow.png +++ /dev/null | |||
Binary files differ | |||
diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst index e8fd191dbc..fbfc8c2ac7 100644 --- a/documentation/sdk-manual/intro.rst +++ b/documentation/sdk-manual/intro.rst | |||
@@ -173,7 +173,7 @@ You just need to follow these general steps: | |||
173 | root filesystem images. | 173 | root filesystem images. |
174 | 174 | ||
175 | If you are going to develop your application on hardware, go to the | 175 | If you are going to develop your application on hardware, go to the |
176 | :yocto_dl:`machines </releases/yocto/yocto-&DISTRO;/machines/>` download area and choose a | 176 | :yocto_dl:`machines </releases/yocto/&DISTRO_REL_LATEST_TAG;/machines/>` download area and choose a |
177 | target machine area from which to download the kernel image and root | 177 | target machine area from which to download the kernel image and root |
178 | filesystem. This download area could have several files in it that | 178 | filesystem. This download area could have several files in it that |
179 | support development using actual hardware. For example, the area | 179 | support development using actual hardware. For example, the area |
@@ -183,7 +183,7 @@ You just need to follow these general steps: | |||
183 | 183 | ||
184 | If you are going to develop your application and then run and test it | 184 | If you are going to develop your application and then run and test it |
185 | using the QEMU emulator, go to the | 185 | using the QEMU emulator, go to the |
186 | :yocto_dl:`machines/qemu </releases/yocto/yocto-&DISTRO;/machines/qemu>` download area. From this | 186 | :yocto_dl:`machines/qemu </releases/yocto/&DISTRO_REL_LATEST_TAG;/machines/qemu>` download area. From this |
187 | area, go down into the directory for your target architecture (e.g. | 187 | area, go down into the directory for your target architecture (e.g. |
188 | ``qemux86_64`` for an Intel-based 64-bit architecture). Download the | 188 | ``qemux86_64`` for an Intel-based 64-bit architecture). Download the |
189 | kernel, root filesystem, and any other files you need for your | 189 | kernel, root filesystem, and any other files you need for your |
diff --git a/documentation/sdk-manual/using.rst b/documentation/sdk-manual/using.rst index f1ff0c76ca..bfb306abf5 100644 --- a/documentation/sdk-manual/using.rst +++ b/documentation/sdk-manual/using.rst | |||
@@ -43,7 +43,7 @@ Host` by running the ``*.sh`` installation script. | |||
43 | 43 | ||
44 | You can download a tarball installer, which includes the pre-built | 44 | You can download a tarball installer, which includes the pre-built |
45 | toolchain, the ``runqemu`` script, and support files from the | 45 | toolchain, the ``runqemu`` script, and support files from the |
46 | appropriate :yocto_dl:`toolchain </releases/yocto/yocto-&DISTRO;/toolchain/>` directory within | 46 | appropriate :yocto_dl:`toolchain </releases/yocto/&DISTRO_REL_LATEST_TAG;/toolchain/>` directory within |
47 | the Index of Releases. Toolchains are available for several 32-bit and | 47 | the Index of Releases. Toolchains are available for several 32-bit and |
48 | 64-bit architectures with the ``x86_64`` directories, respectively. The | 48 | 64-bit architectures with the ``x86_64`` directories, respectively. The |
49 | toolchains the Yocto Project provides are based off the | 49 | toolchains the Yocto Project provides are based off the |
diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst index b9af33393b..4236bcec24 100644 --- a/documentation/sdk-manual/working-projects.rst +++ b/documentation/sdk-manual/working-projects.rst | |||
@@ -295,12 +295,12 @@ example: | |||
295 | all: main.o module.o | 295 | all: main.o module.o |
296 | ${CC} main.o module.o -o target_bin | 296 | ${CC} main.o module.o -o target_bin |
297 | main.o: main.c module.h | 297 | main.o: main.c module.h |
298 | ${CC} -I . -c main.c | 298 | ${CC} -I . -c main.c |
299 | module.o: module.c module.h | 299 | module.o: module.c module.h |
300 | ${CC} -I . -c module.c | 300 | ${CC} -I . -c module.c |
301 | clean: | 301 | clean: |
302 | rm -rf *.o | 302 | rm -rf *.o |
303 | rm target_bin | 303 | rm target_bin |
304 | 304 | ||
305 | #. *Make the Project:* Use the ``make`` command to create the binary | 305 | #. *Make the Project:* Use the ``make`` command to create the binary |
306 | output file. Because variables are commented out in the Makefile, the | 306 | output file. Because variables are commented out in the Makefile, the |