summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorJoshua Watt <jpewhacker@gmail.com>2021-01-19 10:42:00 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-01-20 00:53:53 +0000
commitf236145ce42d3486ee25dd099d6ee2f5a6597cf1 (patch)
tree8db699b2cc3c17346b583d7c992e73264a27d859 /documentation/ref-manual
parent164db40a728876f75e0dc8188c943bc17afd542d (diff)
downloadpoky-f236145ce42d3486ee25dd099d6ee2f5a6597cf1.tar.gz
ref-manual: Clarify recommended operator for PROVIDES
Updates the documentation for PROVIDES so that it recommends "+=" instead of "=". (From yocto-docs rev: 39b2ca1e27592488d396d5f0d76965f0006515a1) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/variables.rst15
1 files changed, 4 insertions, 11 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 5ec19970e4..2cb37b6a2b 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5915,23 +5915,16 @@ system and gives an overview of their function and contents.
5915 file ``eudev_3.2.9.bb``: 5915 file ``eudev_3.2.9.bb``:
5916 :: 5916 ::
5917 5917
5918 PROVIDES = "udev" 5918 PROVIDES += "udev"
5919 5919
5920 The ``PROVIDES`` statement 5920 The ``PROVIDES`` statement
5921 results in the "eudev" recipe also being available as simply "udev". 5921 results in the "eudev" recipe also being available as simply "udev".
5922 5922
5923 .. note:: 5923 .. note::
5924 5924
5925 Given that a recipe's own recipe name is already implicitly in its 5925 A recipe's own recipe name (:term:`PN`) is always implicitly prepended
5926 own PROVIDES list, it is unnecessary to add aliases with the "+=" operator; 5926 to `PROVIDES`, so while using "+=" in the above example may not be
5927 using a simple assignment will be sufficient. In other words, 5927 strictly necessary it is recommended to avoid confusion.
5928 while you could write:
5929 ::
5930
5931 PROVIDES += "udev"
5932
5933
5934 in the above, the "+=" is overkill and unnecessary.
5935 5928
5936 In addition to providing recipes under alternate names, the 5929 In addition to providing recipes under alternate names, the
5937 ``PROVIDES`` mechanism is also used to implement virtual targets. A 5930 ``PROVIDES`` mechanism is also used to implement virtual targets. A