dev-manual: Clarify that virtual providers do not apply to runtime dependencies

Submitted by Joshua Watt on Aug. 31, 2020, 5:20 p.m. | Patch ID: 175844

Details

Message ID 20200831172057.34682-1-JPEWhacker@gmail.com
State New
Headers show

Commit Message

Joshua Watt Aug. 31, 2020, 5:20 p.m.
From: Joshua Watt <Joshua.Watt@garmin.com>

Clarifies that virtual providers are only used for build time
dependencies specified with PROVIDES and DEPENDS, and do not apply to
runtime dependencies specified with RPROVIDES and RDEPENDS.

Signed-off-by: Joshua Watt <Joshua.Watt@garmin.com>
---
 documentation/dev-manual/dev-manual-common-tasks.xml | 8 ++++++++
 1 file changed, 8 insertions(+)

Patch hide | download patch | download mbox

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 1f24c7343..479ca4f20 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -3214,6 +3214,14 @@ 
                         </para></listitem>
                 </itemizedlist>
             </para>
+            <note>
+                Virtual providers only apply to build time dependencies with
+                <ulink url='&YOCTO_DOCS_REF_URL;#var-PROVIDES'><filename>PROVIDES</filename></ulink>
+                and <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink>.
+                They do not apply to runtime dependencies specified with
+                <ulink url='&YOCTO_DOCS_REF_URL;#var-RPROVIDES'><filename>RPROVIDES</filename></ulink> and
+                <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink>.
+            </note>
         </section>
 
         <section id='properly-versioning-pre-release-recipes'>