[Buildroot] [PATCHv3] docs/manual: add list of instrumentation steps

[Buildroot] [PATCHv3] docs/manual: add list of instrumentation steps

[Yann E. MORIN]

The names of steps are not obvious, so add this list to the manual.

Small formatting fix at the same time.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Arnout Vandecappelle <arnout@mind.be>

---
Changes v2 -> v3:
  - typoes  (Arnout)

Changes v1 -> v2:
  - remove reference to target-finalize, it's currently not a step
---
 docs/manual/debugging-buildroot.txt | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/docs/manual/debugging-buildroot.txt b/docs/manual/debugging-buildroot.txt
index b97f633..f575fc4 100644
--- a/docs/manual/debugging-buildroot.txt
+++ b/docs/manual/debugging-buildroot.txt
@@ -12,8 +12,8 @@ space-separated list, you want called before and after each step. The
 scripts are called in sequence, with three parameters:
 
   - +start+ or +end+ to denote the start (resp. the end) of a step;
-  - the name of the step about to be started, or which just ended.
-  - the name of the package
+  - the name of the step about to be started, or which just ended;
+  - the name of the package.
 
 For example :
 
@@ -21,7 +21,18 @@ For example :
 make BR2_INSTRUMENTATION_SCRIPTS="/path/to/my/script1 /path/to/my/script2"
 ----
 
-That script has access to the following variables:
+The list of steps is:
+
+  - +extract+
+  - +patch+
+  - +configure+
+  - +build+
+  - +install-host+, when a host-package is installed in +$(HOST_DIR)+
+  - +install-target+, when a target-package is installed in +$(TARGET_DIR)+
+  - +install-staging+, when a target-package is installed in +$(STAGING_DIR)+
+  - +install-image+, when a target-package installs files in +$(BINARIES_DIR)+
+
+The script has access to the following variables:
 
   - +BR2_CONFIG+: the path to the Buildroot .config file
   - +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+: see
-- 
1.9.1

[Buildroot] [PATCHv3] docs/manual: add list of instrumentation steps

[Arnout Vandecappelle]

On 03/05/15 17:42, Yann E. MORIN wrote:
> The names of steps are not obvious, so add this list to the manual.
> 
> Small formatting fix at the same time.
> 
> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
> Cc: Arnout Vandecappelle <arnout@mind.be>

Reviewed-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>

 Regards,
 Arnout

> 
> ---
> Changes v2 -> v3:
>   - typoes  (Arnout)
> 
> Changes v1 -> v2:
>   - remove reference to target-finalize, it's currently not a step
> ---
>  docs/manual/debugging-buildroot.txt | 17 ++++++++++++++---
>  1 file changed, 14 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/manual/debugging-buildroot.txt b/docs/manual/debugging-buildroot.txt
> index b97f633..f575fc4 100644
> --- a/docs/manual/debugging-buildroot.txt
> +++ b/docs/manual/debugging-buildroot.txt
> @@ -12,8 +12,8 @@ space-separated list, you want called before and after each step. The
>  scripts are called in sequence, with three parameters:
>  
>    - +start+ or +end+ to denote the start (resp. the end) of a step;
> -  - the name of the step about to be started, or which just ended.
> -  - the name of the package
> +  - the name of the step about to be started, or which just ended;
> +  - the name of the package.
>  
>  For example :
>  
> @@ -21,7 +21,18 @@ For example :
>  make BR2_INSTRUMENTATION_SCRIPTS="/path/to/my/script1 /path/to/my/script2"
>  ----
>  
> -That script has access to the following variables:
> +The list of steps is:
> +
> +  - +extract+
> +  - +patch+
> +  - +configure+
> +  - +build+
> +  - +install-host+, when a host-package is installed in +$(HOST_DIR)+
> +  - +install-target+, when a target-package is installed in +$(TARGET_DIR)+
> +  - +install-staging+, when a target-package is installed in +$(STAGING_DIR)+
> +  - +install-image+, when a target-package installs files in +$(BINARIES_DIR)+
> +
> +The script has access to the following variables:
>  
>    - +BR2_CONFIG+: the path to the Buildroot .config file
>    - +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+: see
> 


-- 
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7CB5 E4CC 6C2E EFD4 6E3D A754 F963 ECAB 2450 2F1F

[Buildroot] [PATCHv3] docs/manual: add list of instrumentation steps

[Thomas Petazzoni]

Dear Yann E. MORIN,

On Sun,  3 May 2015 17:42:44 +0200, Yann E. MORIN wrote:
> The names of steps are not obvious, so add this list to the manual.
> 
> Small formatting fix at the same time.
> 
> Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
> Cc: Arnout Vandecappelle <arnout@mind.be>
> 
> ---
> Changes v2 -> v3:
>   - typoes  (Arnout)

Applied, thanks.

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com