From: "Joshua Watt" <JPEWhacker@gmail.com>
To: docs@lists.yoctoproject.org
Cc: quentin.schulz@streamunlimited.com,
richard.purdie@linuxfoundation.org, rpjday@crashcourse.ca,
Joshua Watt <JPEWhacker@gmail.com>
Subject: [docs][PATCH v2] ref-manual: Clarify recommended operator for PROVIDES
Date: Tue, 19 Jan 2021 10:42:00 -0600 [thread overview]
Message-ID: <20210119164200.16690-1-JPEWhacker@gmail.com> (raw)
In-Reply-To: <20210119155751.11243-1-JPEWhacker@gmail.com>
Updates the documentation for PROVIDES so that it recommends "+="
instead of "=".
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
---
documentation/ref-manual/variables.rst | 15 ++++-----------
1 file changed, 4 insertions(+), 11 deletions(-)
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 4ce264813..1bbc5cbca 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.
file ``eudev_3.2.9.bb``:
::
- PROVIDES = "udev"
+ PROVIDES += "udev"
The ``PROVIDES`` statement
results in the "eudev" recipe also being available as simply "udev".
.. note::
- Given that a recipe's own recipe name is already implicitly in its
- own PROVIDES list, it is unnecessary to add aliases with the "+=" operator;
- using a simple assignment will be sufficient. In other words,
- while you could write:
- ::
-
- PROVIDES += "udev"
-
-
- in the above, the "+=" is overkill and unnecessary.
+ A recipe's own recipe name (:term:`PN`) is always implicitly prepended
+ to `PROVIDES`, so while using "+=" in the above example may not be
+ strictly necessary it is recommended to avoid confusion.
In addition to providing recipes under alternate names, the
``PROVIDES`` mechanism is also used to implement virtual targets. A
--
2.30.0
prev parent reply other threads:[~2021-01-19 16:42 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-19 15:57 [docs][PATCH] ref-manual: Clarify recommended operator for PROVIDES Joshua Watt
2021-01-19 16:00 ` Robert P. J. Day
2021-01-19 16:03 ` Quentin Schulz
2021-01-19 16:12 ` Joshua Watt
2021-01-19 16:42 ` Joshua Watt [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210119164200.16690-1-JPEWhacker@gmail.com \
--to=jpewhacker@gmail.com \
--cc=docs@lists.yoctoproject.org \
--cc=quentin.schulz@streamunlimited.com \
--cc=richard.purdie@linuxfoundation.org \
--cc=rpjday@crashcourse.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox