dev-manual: details about using firewalls and limiting fetch threads

Message ID 20220309160242.616026-1-michael.opdenacker@bootlin.com
State New
Headers show
Series dev-manual: details about using firewalls and limiting fetch threads | expand

Commit Message

Michael Opdenacker March 9, 2022, 4:02 p.m. UTC
Fixes [YOCTO #13235]

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/dev-manual/common-tasks.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

Comments

Quentin Schulz March 10, 2022, 11:06 a.m. UTC | #1
Hi Michael,

On 3/9/22 17:02, Michael Opdenacker via lists.yoctoproject.org wrote:
> Fixes [YOCTO #13235]
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>   documentation/dev-manual/common-tasks.rst | 18 ++++++++++++++++++
>   1 file changed, 18 insertions(+)
> 
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index 1caf953901..609e38cbcd 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -1481,6 +1481,24 @@ compressed suffixes such as ``diff.gz`` and ``patch.bz2``, for example.
>   The build system automatically applies patches as described in the
>   ":ref:`dev-manual/common-tasks:patching code`" section.
>   
> +Fetching Code Through Firewalls
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Some users are behind firewalls and need to fetch code through a proxy.
> +See the ":doc:`/ref-manual/faq`" chapter for advice.
> +
> +Limiting the Number of Parallel Connections
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Some users are behind firewalls or use servers where the number of parallel connections
> +is limited. In such cases, you can limit the number of fetch tasks which run in parallel by
> +setting the below option in your ``local.conf`` file.
> +
> +The :yocto_git:`meta-poky/conf/local.conf.sample.extended </poky/tree/meta-poky/conf/local.conf.sample.extended>`
> +file shows how to set a maximum of four fetch tasks in parallel::
> +

Can suggest:

Some users are behind firewalls or use servers where the number of 
parallel connections is limited. In such cases, you can limit the
number of fetch tasks being run in parallel by adding the following
to your ``local.conf`` file::

> +   do_fetch[number_threads] = "4"
> +

Basically, I don't like "the below option" followed by another sentence.

But I'm more concerned about pointing to a file whose content I'm sure 
we won't actively monitor. I'm not sure it's an important piece of 
information to know if a sample configuration file has such an example?

What do you think?

Cheers,
Quentin

Patch

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 1caf953901..609e38cbcd 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -1481,6 +1481,24 @@  compressed suffixes such as ``diff.gz`` and ``patch.bz2``, for example.
 The build system automatically applies patches as described in the
 ":ref:`dev-manual/common-tasks:patching code`" section.
 
+Fetching Code Through Firewalls
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Some users are behind firewalls and need to fetch code through a proxy.
+See the ":doc:`/ref-manual/faq`" chapter for advice.
+
+Limiting the Number of Parallel Connections
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Some users are behind firewalls or use servers where the number of parallel connections
+is limited. In such cases, you can limit the number of fetch tasks which run in parallel by
+setting the below option in your ``local.conf`` file.
+
+The :yocto_git:`meta-poky/conf/local.conf.sample.extended </poky/tree/meta-poky/conf/local.conf.sample.extended>`
+file shows how to set a maximum of four fetch tasks in parallel::
+
+   do_fetch[number_threads] = "4"
+
 Unpacking Code
 --------------