ref-manual: add entry for rm_work_and_downloads.bbclass

Submitted by Robert P. J. Day on April 10, 2020, 6:13 p.m. | Patch ID: 171854

Details

Message ID alpine.LFD.2.21.2004101410580.9046@localhost.localdomain
State New
Headers show

Commit Message

Robert P. J. Day April 10, 2020, 6:13 p.m.
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

Patch hide | download patch | download mbox

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index f9bbddd72..2506da5f5 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -2961,6 +2961,21 @@  This check was removed for YP 2.3 release
     </para>
 </section>

+<section id='ref-classes-rm-work-and-downloads'>
+    <title><filename>rm_work_and_downloads.bbclass</filename></title>
+
+    <para>
+        In addition to removing the local build directories of a recipe,
+        this class also removes the downloaded source; it would be invoked
+        thusly:
+        <literallayout class='monospaced'>
+    INHERIT += "rm_work_and_downloads"
+        </literallayout>
+        While this sounds wasteful, where this works well is in well-connected
+        build environments with limited disk space (such as Travis CI).
+    </para>
+</section>
+
 <section id='ref-classes-rootfs*'>
     <title><filename>rootfs*.bbclass</filename></title>