Re: [ptxdist] [PATCH] doc: pre-built packages: fix typos, enhance some formulations & occasionally add information

[Ulrich Ölmann]

Hi Roland & list,

it took some time to come back to this finally...

On Wed, Jul 19, 2017 at 10:30:35AM +0200, Roland Hieber wrote:
> Some more changes you could include:
> 
> On 18.07.2017 15:27, Ulrich Ölmann wrote:
> > [...]
> > -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
> 
> Is there a reason why you changed Unicode quotation marks for ASCII
> apostrophes?

The english genitive uses just a simple apostrophe that is found easily on my
keyboard. Hence I try to consistently use it instead of special unicode
characters.

> > [...]
> >  the last run instead. This feature can drastically reduce the time to
> >  re-build the whole project. But also, this PTXdist feature must handle
> 
>   while we're at it:  must be handled --^

Correct.

> > [...]
> > -A regular and save usecase of pre-build archives is:
> > +Sufficient conditions for save application of pre-built archives are:
> 
>  ^--- should be "safe" (adj), not "save" (verb)

Yes.

> > [...]
> > +The hash as a part of the pre-built archive's filename does only reflect
> 
> My feeling for English would change this to "only reflects", less emphasis.

Changed.

> > [...]
> > +can decide on a package by package base if its pre-built archive should
> 
>   ^--- basis?

Replaced.

> > [...]
> > +Now its time to copy the pre-built archives to this new directory. We
> 
>^-- it's

Good catch.

> > +are under development, we must omit its corresponding pre-built archives
> 
>archive? --^

Changed to "we must omit THEIR corresponding pre-built archives".

> > [...]
> >  $ cp platform-/packages/*-dev.tar.gz| 
> > /home/jbe/OSELAS.BSP/Pengutronix/OSELAS.BSP-Pengutronix-Generic
> 
>  ^-- huh, why is 
> there a pipe?

Removed.

>  - Roland

I will send a v2 of this patch split up into a handful of single more specific
patches.

Best regards
Ulrich
-- 
Pengutronix e.K.   | |
Industrial Linux Solutions | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0|
Amtsgericht Hildesheim, HRA 2686   | Fax:   +49-5121-206917- |

___
ptxdist mailing list
ptxdist@pengutronix.de

Re: [ptxdist] [PATCH] doc: pre-built packages: fix typos, enhance some formulations & occasionally add information

[Roland Hieber]

Some more changes you could include:

On 18.07.2017 15:27, Ulrich Ölmann wrote:
> Signed-off-by: Ulrich Ölmann 
> ---
>  doc/daily_work.inc | 134 
> -
>  1 file changed, 71 insertions(+), 63 deletions(-)
> 
> diff --git a/doc/daily_work.inc b/doc/daily_work.inc
> index 460693021606..46c4852c2547 100644
> --- a/doc/daily_work.inc
> +++ b/doc/daily_work.inc
> @@ -566,10 +566,10 @@ 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
> +PTXdist is a tool which creates all the required parts of a target's

Is there a reason why you changed Unicode quotation marks for ASCII apostrophes?

>  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.
> @@ -582,30 +582,30 @@ 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.
>  
> -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
> +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

  while we're at it:  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
> -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 create pre-built archives, enable this feature prior to 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 use pre-built archives, enable this feature prior to a
>  build in the menu:
>  
>  ::
> @@ -637,90 +637,96 @@ build in the menu:
>  $ ptxdist menuconfig
>  
>  Project Name & Version --->
> -[*] use pre-build archives
> +[*] use pre-built 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
> +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-build archive’s content.
> +pre-built archive's content.
>  
> -A regular and save usecase of pre-build archives is:
> +Sufficient 

[ptxdist] [PATCH] doc: pre-built packages: fix typos, enhance some formulations & occasionally add information

[Ulrich Ölmann]

Signed-off-by: Ulrich Ölmann 
---
 doc/daily_work.inc | 134 -
 1 file changed, 71 insertions(+), 63 deletions(-)

diff --git a/doc/daily_work.inc b/doc/daily_work.inc
index 460693021606..46c4852c2547 100644
--- a/doc/daily_work.inc
+++ b/doc/daily_work.inc
@@ -566,10 +566,10 @@ 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
+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.
@@ -582,30 +582,30 @@ 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.
 
-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
+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
 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 create pre-built archives, enable this feature prior to 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 use pre-built archives, enable this feature prior to a
 build in the menu:
 
 ::
@@ -637,90 +637,96 @@ build in the menu:
 $ ptxdist menuconfig
 
 Project Name & Version --->
-[*] use pre-build archives
+[*] use pre-built 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
+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-build archive’s content.
+pre-built archive's content.
 
-A regular and save usecase of pre-build archives is:
+Sufficient conditions for save application of pre-built archives are:
 
--  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.