[PATCH 0/2] Doc tweaks for 1.50

[PATCH 0/2] Doc tweaks for 1.50

[Paul Eggleton]

A couple of documentation fixes relating to the BitBake 1.50 release.


The following changes since commit e70b925ba98fd4fedf3940d141a4210c953087ca:

  bitbake: Update version to 1.50.0 stable release series (2021-04-09 14:19:54 +0100)

are available in the git repository at:

  git://git.openembedded.org/bitbake-contrib paule/doc-git-pw
  http://cgit.openembedded.org/bitbake-contrib/log/?h=paule/doc-git-pw

Paul Eggleton (2):
  bitbake-user-manual: document no support for using passwords in git
    URLs
  bitbake-user-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION
    entry

 .../bitbake-user-manual-fetching.rst                   |  9 +++++++++
 .../bitbake-user-manual-ref-variables.rst              | 18 ++++++++++++++++--
 2 files changed, 25 insertions(+), 2 deletions(-)

-- 
1.8.3.1

[PATCH 1/2] bitbake-user-manual: document no support for using passwords in git URLs

[Paul Eggleton]

From: Paul Eggleton <paul.eggleton@microsoft.com>

This is based on the comment added in revision
aded964eed4ce5a725ed1ab477efabc86b1aa481.

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
---
 doc/bitbake-user-manual/bitbake-user-manual-fetching.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index e9a5f33..bd6cc0e 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -441,6 +441,15 @@ Here are some example URLs: ::
    SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1"
    SRC_URI = "git://git.oe.handhelds.org/git/vip.git;protocol=http"
 
+.. note::
+
+   Specifying passwords directly in ``git://`` urls is not supported.
+   There are several reasons: ``SRC_URI`` is often written out to logs and
+   other places, and that could easily leak passwords; it is also all too
+   easy to share metadata without removing passwords. SSH keys, ``~/.netrc``
+   and ``~/.ssh/config`` files can be used as alternatives.
+
+
 .. _gitsm-fetcher:
 
 Git Submodule Fetcher (``gitsm://``)
-- 
1.8.3.1

[PATCH 2/2] bitbake-user-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entry

[Paul Eggleton]

From: Paul Eggleton <paul.eggleton@microsoft.com>

Add REQUIRED_VERSION, add a reference to it in PREFERRED_VERSION and
adjust the opening statement to read slightly better.

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
---
 .../bitbake-user-manual-ref-variables.rst              | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 1528b04..489fa15 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -1096,8 +1096,8 @@ overview of their function and contents.
          PREFERRED_PROVIDER_aaa = "bbb"
 
    :term:`PREFERRED_VERSION`
-      If there are multiple versions of recipes available, this variable
-      determines which recipe should be given preference. You must always
+      If there are multiple versions of a recipe available, this variable
+      determines which version should be given preference. You must always
       suffix the variable with the :term:`PN` you want to
       select, and you should set :term:`PV` accordingly for
       precedence.
@@ -1117,6 +1117,10 @@ overview of their function and contents.
          end of the string. You cannot use the wildcard character in any other
          location of the string.
 
+      If a recipe with the specified version is not available, a warning
+      message will be shown. See :term:`REQUIRED_VERSION` if you want this
+      to be an error instead.
+
    :term:`PREMIRRORS`
       Specifies additional paths from which BitBake gets source code. When
       the build system searches for source code, it first tries the local
@@ -1227,6 +1231,16 @@ overview of their function and contents.
       The directory in which a local copy of a ``google-repo`` directory is
       stored when it is synced.
 
+   :term:`REQUIRED_VERSION`
+      If there are multiple versions of a recipe available, this variable
+      determines which version should be given preference. ``REQUIRED_VERSION``
+      works in exactly the same manner as :term:`PREFERRED_VERSION`, except
+      that if the specified version is not available then an error message
+      is shown and the build fails immediately.
+
+      If both ``REQUIRED_VERSION`` and ``PREFERRED_VERSION`` are set for
+      the same recipe, the ``REQUIRED_VERSION`` value applies.
+
    :term:`RPROVIDES`
       A list of package name aliases that a package also provides. These
       aliases are useful for satisfying runtime dependencies of other
-- 
1.8.3.1

Re: [bitbake-devel] [PATCH 0/2] Doc tweaks for 1.50

[Michael Opdenacker]

On 4/14/21 4:00 AM, Paul Eggleton wrote:
> A couple of documentation fixes relating to the BitBake 1.50 release.
>
>
> The following changes since commit e70b925ba98fd4fedf3940d141a4210c953087ca:
>
>   bitbake: Update version to 1.50.0 stable release series (2021-04-09 14:19:54 +0100)
>
> are available in the git repository at:
>
>   git://git.openembedded.org/bitbake-contrib paule/doc-git-pw
>   http://cgit.openembedded.org/bitbake-contrib/log/?h=paule/doc-git-pw
>
> Paul Eggleton (2):
>   bitbake-user-manual: document no support for using passwords in git
>     URLs
>   bitbake-user-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION
>     entry
>
>  .../bitbake-user-manual-fetching.rst                   |  9 +++++++++
>  .../bitbake-user-manual-ref-variables.rst              | 18 ++++++++++++++++--


For both...

Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>

Thanks,

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com