[ptxdist] [PATCH v2 0/6] doc: pre-built packages: review chapter 'Using Pre-Built Archives'

[ptxdist] [PATCH v2 0/6] doc: pre-built packages: review chapter 'Using Pre-Built Archives'

[Ulrich Ölmann]

Changes since v1:
 - split up into separate, more simple to review patches
 - include Roland Hieber's additional findings (see email with message-ID
   eecbf2a3-fc9e-2ef6-a9cb-c9d3f49052de@pengutronix.de)

Best regards
Ulrich

Ulrich Ölmann (6):
  doc: pre-built packages: fix typos
  doc: pre-built packages: adjust capitalization in headings
  doc: pre-built packages: use consistent style in enumerations
  doc: pre-built packages: english genitive uses an apostrophe
  doc: pre-built packages: enhance phrasing
  doc: pre-built packages: some additions

 doc/daily_work.inc | 139 ++++++++++++++++++++++++++++-------------------------
 1 file changed, 73 insertions(+), 66 deletions(-)

-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH v2 1/6] doc: pre-built packages: fix typos

[Ulrich Ölmann]

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 doc/daily_work.inc | 84 +++++++++++++++++++++++++++---------------------------
 1 file changed, 42 insertions(+), 42 deletions(-)

diff --git a/doc/daily_work.inc b/doc/daily_work.inc
index 460693021606..264d623d5532 100644
--- a/doc/daily_work.inc
+++ b/doc/daily_work.inc
@@ -566,7 +566,7 @@ packages at the same time. Never worry again about your local host and
 how slow it is. With the help of *ICECC* every host will be a high speed
 development machine.
 
-Using pre-build archives
+Using pre-built archives
 ------------------------
 
 PTXdist is a tool which creates all the required parts of a target’s
@@ -600,12 +600,12 @@ re-build the whole project. But also, this PTXdist feature must handle
 with care and so it is not enabled and used as default.
 
 This section describes how to make use of this PTXdist feature and what
-pitfalls exists when doing so.
+pitfalls exist when doing so.
 
-Creating pre-build archives
+Creating pre-built archives
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To make PTXdist creating pre-build archives, enable this feature prior a
+To make PTXdist creating pre-built archives, enable this feature prior a
 build in the menu:
 
 ::
@@ -613,7 +613,7 @@ build in the menu:
     $ ptxdist menuconfig
 
         Project Name & Version --->
-            [*] create pre-build archives
+            [*] create pre-built archives
 
 Now run a regular build of the whole project:
 
@@ -622,14 +622,14 @@ Now run a regular build of the whole project:
     $ ptxdist go
 
 When the build is finished, the directory ``packages`` contains
-additional archives files with the name scheme ``*-dev.tar.gz``. These
-files are the pre-build archives which PTXdist can use later on to
+additional archive files with the name scheme ``*-dev.tar.gz``. These
+files are the pre-built archives which PTXdist can use later on to
 re-build the project.
 
-Using pre-build archives
+Using pre-built archives
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-To make PTXdist using pre-build archives, enable this feature prior a
+To make PTXdist using pre-built archives, enable this feature prior a
 build in the menu:
 
 ::
@@ -637,38 +637,38 @@ build in the menu:
     $ ptxdist menuconfig
 
         Project Name & Version --->
-            [*] use pre-build archives
+            [*] use pre-built archives
             (</some/path/to/the/archives>)
 
 With the next build (e.g. ``ptxdist go``) PTXdist will look for a
-specific package if its corresponding pre-build archive does exist. If
-it does exist and the used hash value in the pre-build archive’s
+specific package if its corresponding pre-built archive does exist. If
+it does exist and the used hash value in the pre-built archive’s
 filename matches, PTXdist will skip all source archive handling
 (extract, patch, compile and install) and just extract and use the
-pre-build archive’s content.
+pre-built archive’s content.
 
-A regular and save usecase of pre-build archives is:
+A regular and safe usecase of pre-built archives is:
 
--  using one pre-build archive pool for one specific PTXdist project.
+-  using one pre-built archive pool for one specific PTXdist project.
 
 -  using a constant PTXdist version all the time.
 
 -  using a constant OSELAS.Toolchain() version all the time.
 
--  no package with a pre-build archive in the project is under
+-  no package with a pre-built archive in the project is under
    development.
 
-The hash as a part of the pre-build archive’s filename does only reflect
+The hash as a part of the pre-built archive’s filename does only reflect
 the package’s configuration made in the menu (``ptxdist menuconfig``).
 If this package specific configuration changes, a new hash value will be
-the result and PTXdist can select the corresponding correct pre-build
+the result and PTXdist can select the corresponding correct pre-built
 archive.
 
 This hash value change is an important fact, as many things outside and
 inside the package can have a big impact of the binary result but
 without a hash value change!
 
-Please be careful when using the pre-build archives if you:
+Please be careful when using the pre-built archives if you:
 
 -  intend to switch to a different toolchain with the next build.
 
@@ -678,48 +678,48 @@ Please be careful when using the pre-build archives if you:
 -  change the hard coded configure settings in the package’s rule file,
    e.g. a package is under development
 
--  intend to use one pre-build archive pool from different PTXdist
+-  intend to use one pre-built archive pool from different PTXdist
    projects.
 
-To consider all these precautions the generated pre-build archives are
-not transfered automatically where the next build expects them. This
+To consider all these precautions the generated pre-built archives are
+not transferred automatically where the next build expects them. This
 must be done manually by the user of the PTXdist project. Doing so, we
-can decide on a package by package base if its pre-build archive should
+can decide on a package by package base if its pre-built archive should
 be used or not.
 
-Packages without pre-build archives support
+Packages without pre-built archives support
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-No host nor cross related packages can be used based on their pre-build
+No host nor cross related packages can be used based on their pre-built
 archives. These kind of packages are always (re-)built.
 
-Only target related packages can be used based on their pre-build
+Only target related packages can be used based on their pre-built
 archives, but there are a few exceptions:
 
 -  Linux kernel: It has an incomplete install stage, which results into
-   an incomplete pre-build archive. Due to this, it cannot be used as a
-   pre-build archive
+   an incomplete pre-built archive. Due to this, it cannot be used as a
+   pre-built archive
 
 -  Barebox bootloader: It has an incomplete install stage, which results
-   into an incomplete pre-build archive. Due to this, it cannot be used
-   as a pre-build archive
+   into an incomplete pre-built archive. Due to this, it cannot be used
+   as a pre-built archive
 
 -  some other somehow broken packages all marked with a
    ``<packagename>_DEVPKG := NO`` in their corresponding rule file
 
-Workflow with pre-build archives
+Workflow with pre-built archives
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-We starting with an empty PTXdist project and enabling the pre-build
+We starting with an empty PTXdist project and enabling the pre-built
 archive feature as mentioned in the previous section. After that
 a regular build of the project can be made.
 
-When the build is finished its time to copy all the pre-build archives
+When the build is finished it's time to copy all the pre-built archives
 of interest where the next build will expect them.
 The previous section mentions the step to enable their use. It also
 allows to define a directory. The default path of this directory is made
-from various other menu settings, to ensure the pre-build archives of
-the current PTXdist project do not conflict with pre-build archives of
+from various other menu settings to ensure the pre-built archives of
+the current PTXdist project do not conflict with pre-built archives of
 different PTXdist projects. To get an idea what the final path is, we
 can ask PTXdist.
 
@@ -734,15 +734,15 @@ If this directory does not exist, we can simply create it:
 
     $ mkdir -p /home/jbe/OSELAS.BSP/Pengutronix/OSELAS.BSP-Pengutronix-Generic
 
-Now its time to copy the pre-build archives to this new directory. We
-could simply copy all pre-build archives from the ``/packages``
+Now it's time to copy the pre-built archives to this new directory. We
+could simply copy all pre-built archives from the ``/packages``
 directory. But we should keep in mind, if any of the related packages
-are under development, we must omit its corresponding pre-build archives
+are under development, we must omit its corresponding pre-built archives
 in this step.
 
 ::
 
-    $ cp platform-<platformname>/packages/*-dev.tar.gz| /home/jbe/OSELAS.BSP/Pengutronix/OSELAS.BSP-Pengutronix-Generic
+    $ cp platform-<platformname>/packages/*-dev.tar.gz /home/jbe/OSELAS.BSP/Pengutronix/OSELAS.BSP-Pengutronix-Generic
 
 Use cases
 ~~~~~~~~~
@@ -751,7 +751,7 @@ Some major possible use cases are covered in this section:
 
 -  Speed up a re-build of one single project
 
--  Sharing pre-build archives between two platforms based on the same
+-  Sharing pre-built archives between two platforms based on the same
    architecture
 
 To simply speed up a re-build of the whole project (without development
@@ -760,11 +760,11 @@ archives after the first build to the location where PTXdist expects
 them at the next build time.
 
 If two platforms are sharing the same architecture it is possible to
-share pre-build archives as well. The best way it can work is, if both
+share pre-built archives as well. The best way it can work is, if both
 platforms are part of the same PTXdist project. They must also share the
 same toolchain settings, patch series and rule files. If these
 precautions are handled the whole project can be built for the first
-platform and these pre-build archives can be used to build the project
+platform and these pre-built archives can be used to build the project
 for the second platform. This can reduce the required time to build the
 second platform from hours to minutes.
 
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH v2 2/6] doc: pre-built packages: adjust capitalization in headings

[Ulrich Ölmann]

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 doc/daily_work.inc | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/daily_work.inc b/doc/daily_work.inc
index 264d623d5532..5da0722c9bd6 100644
--- a/doc/daily_work.inc
+++ b/doc/daily_work.inc
@@ -566,7 +566,7 @@ packages at the same time. Never worry again about your local host and
 how slow it is. With the help of *ICECC* every host will be a high speed
 development machine.
 
-Using pre-built archives
+Using Pre-Built Archives
 ------------------------
 
 PTXdist is a tool which creates all the required parts of a target’s
@@ -602,7 +602,7 @@ with care and so it is not enabled and used as default.
 This section describes how to make use of this PTXdist feature and what
 pitfalls exist when doing so.
 
-Creating pre-built archives
+Creating Pre-Built Archives
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To make PTXdist creating pre-built archives, enable this feature prior a
@@ -626,7 +626,7 @@ additional archive files with the name scheme ``*-dev.tar.gz``. These
 files are the pre-built archives which PTXdist can use later on to
 re-build the project.
 
-Using pre-built archives
+Using Pre-Built Archives
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
 To make PTXdist using pre-built archives, enable this feature prior a
@@ -687,7 +687,7 @@ must be done manually by the user of the PTXdist project. Doing so, we
 can decide on a package by package base if its pre-built archive should
 be used or not.
 
-Packages without pre-built archives support
+Packages without Pre-Built Archives Support
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 No host nor cross related packages can be used based on their pre-built
@@ -707,7 +707,7 @@ archives, but there are a few exceptions:
 -  some other somehow broken packages all marked with a
    ``<packagename>_DEVPKG := NO`` in their corresponding rule file
 
-Workflow with pre-built archives
+Workflow with Pre-Built Archives
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 We starting with an empty PTXdist project and enabling the pre-built
@@ -744,7 +744,7 @@ in this step.
 
     $ cp platform-<platformname>/packages/*-dev.tar.gz /home/jbe/OSELAS.BSP/Pengutronix/OSELAS.BSP-Pengutronix-Generic
 
-Use cases
+Use Cases
 ~~~~~~~~~
 
 Some major possible use cases are covered in this section:
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH v2 3/6] doc: pre-built packages: use consistent style in enumerations

[Ulrich Ölmann]

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 doc/daily_work.inc | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/doc/daily_work.inc b/doc/daily_work.inc
index 5da0722c9bd6..e82e1724701f 100644
--- a/doc/daily_work.inc
+++ b/doc/daily_work.inc
@@ -676,7 +676,7 @@ Please be careful when using the pre-built archives if you:
    package is under development.
 
 -  change the hard coded configure settings in the package’s rule file,
-   e.g. a package is under development
+   e.g. a package is under development.
 
 -  intend to use one pre-built archive pool from different PTXdist
    projects.
@@ -696,16 +696,16 @@ archives. These kind of packages are always (re-)built.
 Only target related packages can be used based on their pre-built
 archives, but there are a few exceptions:
 
--  Linux kernel: It has an incomplete install stage, which results into
+-  Linux kernel: it has an incomplete install stage, which results into
    an incomplete pre-built archive. Due to this, it cannot be used as a
-   pre-built archive
+   pre-built archive.
 
--  Barebox bootloader: It has an incomplete install stage, which results
+-  Barebox bootloader: it has an incomplete install stage, which results
    into an incomplete pre-built archive. Due to this, it cannot be used
-   as a pre-built archive
+   as a pre-built archive.
 
 -  some other somehow broken packages all marked with a
-   ``<packagename>_DEVPKG := NO`` in their corresponding rule file
+   ``<packagename>_DEVPKG := NO`` in their corresponding rule file.
 
 Workflow with Pre-Built Archives
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -749,10 +749,10 @@ Use Cases
 
 Some major possible use cases are covered in this section:
 
--  Speed up a re-build of one single project
+-  speed up a re-build of one single project.
 
--  Sharing pre-built archives between two platforms based on the same
-   architecture
+-  sharing pre-built archives between two platforms based on the same
+   architecture.
 
 To simply speed up a re-build of the whole project (without development
 on any of the used packages) we just can copy all ``*-dev.tar.gz``
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH v2 4/6] doc: pre-built packages: english genitive uses an apostrophe

[Ulrich Ölmann]

Exchange U+2019 (right single quotation mark) by a simple apostrophe.

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 doc/daily_work.inc | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/doc/daily_work.inc b/doc/daily_work.inc
index e82e1724701f..34be5aa4c535 100644
--- a/doc/daily_work.inc
+++ b/doc/daily_work.inc
@@ -569,7 +569,7 @@ development machine.
 Using Pre-Built Archives
 ------------------------
 
-PTXdist is a tool which creates all the required parts of a target’s
+PTXdist is a tool which creates all the required parts of a target's
 filesystem to breathe life into it. And it creates these parts from any
 kind of source files. If a PTXdist project consists of many packages the
 build may take a huge amount of time.
@@ -589,9 +589,9 @@ re-building everything from time to time is a very good test case if
 some adaptions are still missing or if everything is complete, it can be
 a real time sink to do so.
 
-To not lose developer’s temper when doing such tests, PTXdist can keep
-archives from the last run which includes all the files the package’s
-build system has installed while the PTXdist’s *install* stage runs for
+To not lose developer's temper when doing such tests, PTXdist can keep
+archives from the last run which includes all the files the package's
+build system has installed while the PTXdist's *install* stage runs for
 it.
 
 The next time PTXdist should build a package it can use the results from
@@ -642,10 +642,10 @@ build in the menu:
 
 With the next build (e.g. ``ptxdist go``) PTXdist will look for a
 specific package if its corresponding pre-built archive does exist. If
-it does exist and the used hash value in the pre-built archive’s
+it does exist and the used hash value in the pre-built archive's
 filename matches, PTXdist will skip all source archive handling
 (extract, patch, compile and install) and just extract and use the
-pre-built archive’s content.
+pre-built archive's content.
 
 A regular and safe usecase of pre-built archives is:
 
@@ -658,8 +658,8 @@ A regular and safe usecase of pre-built archives is:
 -  no package with a pre-built archive in the project is under
    development.
 
-The hash as a part of the pre-built archive’s filename does only reflect
-the package’s configuration made in the menu (``ptxdist menuconfig``).
+The hash as a part of the pre-built archive's filename does only reflect
+the package's configuration made in the menu (``ptxdist menuconfig``).
 If this package specific configuration changes, a new hash value will be
 the result and PTXdist can select the corresponding correct pre-built
 archive.
@@ -675,7 +675,7 @@ Please be careful when using the pre-built archives if you:
 -  change the patch set applied to the corresponding package, e.g. a
    package is under development.
 
--  change the hard coded configure settings in the package’s rule file,
+-  change the hard coded configure settings in the package's rule file,
    e.g. a package is under development.
 
 -  intend to use one pre-built archive pool from different PTXdist
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH v2 5/6] doc: pre-built packages: enhance phrasing

[Ulrich Ölmann]

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 doc/daily_work.inc | 53 ++++++++++++++++++++++++++---------------------------
 1 file changed, 26 insertions(+), 27 deletions(-)

diff --git a/doc/daily_work.inc b/doc/daily_work.inc
index 34be5aa4c535..2fb27dad1387 100644
--- a/doc/daily_work.inc
+++ b/doc/daily_work.inc
@@ -582,10 +582,10 @@ about 6 hours.
 Introduction
 ~~~~~~~~~~~~
 
-While the development of a PTXdist project it is needed to clean and
+While developing a PTXdist project it is necessary to clean and
 re-build everything from time to time to get a re-synced project result
 which honors all changes made in the project. But since cleaning and
-re-building everything from time to time is a very good test case if
+re-building everything from time to time is a very good test case for if
 some adaptions are still missing or if everything is complete, it can be
 a real time sink to do so.
 
@@ -594,9 +594,9 @@ archives from the last run which includes all the files the package's
 build system has installed while the PTXdist's *install* stage runs for
 it.
 
-The next time PTXdist should build a package it can use the results from
+The next time PTXdist shall build a package it can use the results from
 the last run instead. This feature can drastically reduce the time to
-re-build the whole project. But also, this PTXdist feature must handle
+re-build the whole project. But also, this PTXdist feature must be handled
 with care and so it is not enabled and used as default.
 
 This section describes how to make use of this PTXdist feature and what
@@ -605,7 +605,7 @@ pitfalls exist when doing so.
 Creating Pre-Built Archives
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To make PTXdist creating pre-built archives, enable this feature prior a
+To make PTXdist create pre-built archives, enable this feature prior to a
 build in the menu:
 
 ::
@@ -629,7 +629,7 @@ re-build the project.
 Using Pre-Built Archives
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-To make PTXdist using pre-built archives, enable this feature prior a
+To make PTXdist use pre-built archives, enable this feature prior to a
 build in the menu:
 
 ::
@@ -640,14 +640,14 @@ build in the menu:
             [*] use pre-built archives
             (</some/path/to/the/archives>)
 
-With the next build (e.g. ``ptxdist go``) PTXdist will look for a
-specific package if its corresponding pre-built archive does exist. If
-it does exist and the used hash value in the pre-built archive's
+During the next build (e.g. ``ptxdist go``) PTXdist will look for a
+specific package if its corresponding pre-built archive exists. If
+it exists and the used hash value in the pre-built archive's
 filename matches, PTXdist will skip all source archive handling
 (extract, patch, compile and install) and just extract and use the
 pre-built archive's content.
 
-A regular and safe usecase of pre-built archives is:
+Sufficient conditions for safe application of pre-built archives are:
 
 -  using one pre-built archive pool for one specific PTXdist project.
 
@@ -658,11 +658,10 @@ A regular and safe usecase of pre-built archives is:
 -  no package with a pre-built archive in the project is under
    development.
 
-The hash as a part of the pre-built archive's filename does only reflect
+The hash as a part of the pre-built archive's filename only reflects
 the package's configuration made in the menu (``ptxdist menuconfig``).
 If this package specific configuration changes, a new hash value will be
-the result and PTXdist can select the corresponding correct pre-built
-archive.
+the result and PTXdist can select the matching pre-built archive.
 
 This hash value change is an important fact, as many things outside and
 inside the package can have a big impact of the binary result but
@@ -672,55 +671,55 @@ Please be careful when using the pre-built archives if you:
 
 -  intend to switch to a different toolchain with the next build.
 
--  change the patch set applied to the corresponding package, e.g. a
+-  change the patch set applied to the corresponding package, e.g. the
    package is under development.
 
 -  change the hard coded configure settings in the package's rule file,
-   e.g. a package is under development.
+   e.g. the package is under development.
 
 -  intend to use one pre-built archive pool from different PTXdist
    projects.
 
 To consider all these precautions the generated pre-built archives are
-not transferred automatically where the next build expects them. This
+not transferred automatically to where the next build expects them. This
 must be done manually by the user of the PTXdist project. Doing so, we
-can decide on a package by package base if its pre-built archive should
+can decide on a package by package basis if its pre-built archive should
 be used or not.
 
 Packages without Pre-Built Archives Support
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-No host nor cross related packages can be used based on their pre-built
-archives. These kind of packages are always (re-)built.
+Neither host nor cross related packages support pre-built archives. These kind
+of packages are always (re-)built.
 
 Only target related packages can be used based on their pre-built
 archives, but there are a few exceptions:
 
--  Linux kernel: it has an incomplete install stage, which results into
+-  Linux kernel: it has an incomplete install stage, which results in
    an incomplete pre-built archive. Due to this, it cannot be used as a
    pre-built archive.
 
 -  Barebox bootloader: it has an incomplete install stage, which results
-   into an incomplete pre-built archive. Due to this, it cannot be used
+   in an incomplete pre-built archive. Due to this, it cannot be used
    as a pre-built archive.
 
--  some other somehow broken packages all marked with a
+-  a few somehow broken packages that are all explicitely marked with a
    ``<packagename>_DEVPKG := NO`` in their corresponding rule file.
 
 Workflow with Pre-Built Archives
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-We starting with an empty PTXdist project and enabling the pre-built
+We are starting with an empty PTXdist project and enabling the pre-built
 archive feature as mentioned in the previous section. After that
 a regular build of the project can be made.
 
 When the build is finished it's time to copy all the pre-built archives
-of interest where the next build will expect them.
+of interest to where the next build will expect them.
 The previous section mentions the step to enable their use. It also
 allows to define a directory. The default path of this directory is made
 from various other menu settings to ensure the pre-built archives of
 the current PTXdist project do not conflict with pre-built archives of
-different PTXdist projects. To get an idea what the final path is, we
+different PTXdist projects. To get an idea of what the final path is, we
 can ask PTXdist.
 
 ::
@@ -737,7 +736,7 @@ If this directory does not exist, we can simply create it:
 Now it's time to copy the pre-built archives to this new directory. We
 could simply copy all pre-built archives from the ``/packages``
 directory. But we should keep in mind, if any of the related packages
-are under development, we must omit its corresponding pre-built archives
+are under development, we must omit their corresponding pre-built archives
 in this step.
 
 ::
@@ -751,7 +750,7 @@ Some major possible use cases are covered in this section:
 
 -  speed up a re-build of one single project.
 
--  sharing pre-built archives between two platforms based on the same
+-  share pre-built archives between two platforms based on the same
    architecture.
 
 To simply speed up a re-build of the whole project (without development
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH v2 6/6] doc: pre-built packages: some additions

[Ulrich Ölmann]

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 doc/daily_work.inc | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/daily_work.inc b/doc/daily_work.inc
index 2fb27dad1387..431f0666e067 100644
--- a/doc/daily_work.inc
+++ b/doc/daily_work.inc
@@ -680,12 +680,18 @@ Please be careful when using the pre-built archives if you:
 -  intend to use one pre-built archive pool from different PTXdist
    projects.
 
+-  change a global PTXdist configuration parameter (e.g. PTXCONF_GLOBAL_IPV6).
+
 To consider all these precautions the generated pre-built archives are
 not transferred automatically to where the next build expects them. This
 must be done manually by the user of the PTXdist project. Doing so, we
 can decide on a package by package basis if its pre-built archive should
 be used or not.
 
+If you are unsure if your modifications rendered some or all of your pre-built
+archives invalid you can always delete and build them again to be on the safe
+side.
+
 Packages without Pre-Built Archives Support
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -753,6 +759,8 @@ Some major possible use cases are covered in this section:
 -  share pre-built archives between two platforms based on the same
    architecture.
 
+-  increase reproducibility of binaries.
+
 To simply speed up a re-build of the whole project (without development
 on any of the used packages) we just can copy all ``*-dev.tar.gz``
 archives after the first build to the location where PTXdist expects
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de