summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/classes.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/classes.rst')
-rw-r--r--documentation/ref-manual/classes.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index cc0d212130..6c60d414ca 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -659,6 +659,20 @@ the GNU ``gettext`` internationalization and localization system. All
659recipes building software that use ``gettext`` should inherit this 659recipes building software that use ``gettext`` should inherit this
660class. 660class.
661 661
662.. _ref-classes-github-releases:
663
664``github-releases``
665===================
666
667For recipes that fetch release tarballs from github, the ``github-releases``
668class sets up a standard way for checking available upstream versions
669(to support ``devtool upgrade`` and the Automated Upgrade Helper (AUH)).
670
671To use it, add ``github-releases`` to the inherit line in the recipe,
672and if the default value of :term:`GITHUB_BASE_URI` is not suitable,
673then set your own value in the recipe. You should then use ``${GITHUB_BASE_URI}``
674in the value you set for :term:`SRC_URI` within the recipe.
675
662.. _ref-classes-gnomebase: 676.. _ref-classes-gnomebase:
663 677
664``gnomebase.bbclass`` 678``gnomebase.bbclass``