diff options
Diffstat (limited to 'documentation/ref-manual/devtool-reference.rst')
-rw-r--r-- | documentation/ref-manual/devtool-reference.rst | 36 |
1 files changed, 27 insertions, 9 deletions
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index 5fd51569a3..3e06864f76 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst | |||
@@ -328,23 +328,37 @@ Checking on the Upgrade Status of a Recipe | |||
328 | Upstream recipes change over time. Consequently, you might find that you | 328 | Upstream recipes change over time. Consequently, you might find that you |
329 | need to determine if you can upgrade a recipe to a newer version. | 329 | need to determine if you can upgrade a recipe to a newer version. |
330 | 330 | ||
331 | To check on the upgrade status of a recipe, use the | 331 | To check on the upgrade status of a recipe, you can use the |
332 | ``devtool check-upgrade-status`` command. The command displays a table | 332 | ``devtool latest-version recipe`` command, which quickly shows the current |
333 | of your current recipe versions, the latest upstream versions, the email | 333 | version and the latest version available upstream. To get a more global |
334 | address of the recipe's maintainer, and any additional information such | 334 | picture, use the ``devtool check-upgrade-status`` command, which takes a |
335 | as commit hash strings and reasons you might not be able to upgrade a | 335 | list of recipes as input, or no arguments, in which case it checks all |
336 | particular recipe. | 336 | available recipes. This command will only print the recipes for which |
337 | a new upstream version is available. Each such recipe will have its current | ||
338 | version and latest upstream version, as well as the email of the maintainer | ||
339 | and any additional information such as the commit hash or reason for not | ||
340 | being able to upgrade it, displayed in a table. | ||
341 | |||
342 | This upgrade checking mechanism relies on the optional :term:`UPSTREAM_CHECK_URI`, | ||
343 | :term:`UPSTREAM_CHECK_REGEX`, :term:`UPSTREAM_CHECK_GITTAGREGEX`, | ||
344 | :term:`UPSTREAM_CHECK_COMMITS` and :term:`UPSTREAM_VERSION_UNKNOWN` | ||
345 | variables in package recipes. | ||
337 | 346 | ||
338 | .. note:: | 347 | .. note:: |
339 | 348 | ||
349 | - Most of the time, the above variables are unnecessary. They are only | ||
350 | required when upstream does something unusual, and default | ||
351 | mechanisms cannot find the new upstream versions. | ||
352 | |||
340 | - For the ``oe-core`` layer, recipe maintainers come from the | 353 | - For the ``oe-core`` layer, recipe maintainers come from the |
341 | :yocto_git:`maintainers.inc </poky/tree/meta/conf/distro/include/maintainers.inc>` | 354 | :yocto_git:`maintainers.inc </poky/tree/meta/conf/distro/include/maintainers.inc>` |
342 | file. | 355 | file. |
343 | 356 | ||
344 | - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` | 357 | - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` |
345 | rather than a | 358 | rather than a tarball, the commit hash points to the commit that matches |
346 | tarball, the commit hash points to the commit that matches the | 359 | the recipe's latest version tag, or in the absence of suitable tags, |
347 | recipe's latest version tag. | 360 | to the latest commit (when :term:`UPSTREAM_CHECK_COMMITS` set to ``1`` |
361 | in the recipe). | ||
348 | 362 | ||
349 | As with all ``devtool`` commands, you can get help on the individual | 363 | As with all ``devtool`` commands, you can get help on the individual |
350 | command:: | 364 | command:: |
@@ -393,6 +407,10 @@ satisfied. | |||
393 | NOTE: busybox 1.29.2 1.30.0 Andrej Valek <andrej.valek@siemens.com> | 407 | NOTE: busybox 1.29.2 1.30.0 Andrej Valek <andrej.valek@siemens.com> |
394 | NOTE: dbus-test 1.12.10 1.12.12 Chen Qi <Qi.Chen@windriver.com> | 408 | NOTE: dbus-test 1.12.10 1.12.12 Chen Qi <Qi.Chen@windriver.com> |
395 | 409 | ||
410 | Last but not least, you may set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` | ||
411 | in a recipe when there's currently no way to determine its latest upstream | ||
412 | version. | ||
413 | |||
396 | .. _devtool-upgrading-a-recipe: | 414 | .. _devtool-upgrading-a-recipe: |
397 | 415 | ||
398 | Upgrading a Recipe | 416 | Upgrading a Recipe |