summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/ref-manual/ref-classes.xml20
1 files changed, 20 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 0626e6cc75..ce76140edd 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -579,6 +579,26 @@
579 <para> 579 <para>
580 The <filename>distrodata</filename> class 580 The <filename>distrodata</filename> class
581 provides for automatic checking for upstream recipe updates. 581 provides for automatic checking for upstream recipe updates.
582 The class creates a comma-separated value (CSV) spreadsheet that
583 contains information about the recipes.
584 The information provides the <filename>distrodata</filename> and
585 <filename>distro_check</filename> tasks, which do upstream checking
586 and also verify if a package is used in multiple major distributions.
587 </para>
588
589 <para>
590 The class is not included by default.
591 To use it, you must include the following files and set the
592 <link linkend='var-INHERIT'><filename>INHERIT</filename></link>
593 variable:
594 <literallayout class='monospaced'>
595 include conf/distro/include/distro_alias.inc
596 include conf/distro/include/recipe_color.inc
597 include conf/distro/include/maintainers.inc
598 include conf/distro/include/upstream_tracking.inc
599 include conf/distro/include/package_regex.inc
600 INHERIT+= "distrodata"
601 </literallayout>
582 </para> 602 </para>
583</section> 603</section>
584 604