[ptxdist] [PATCH] doc: document local_src clean behaviour

[ptxdist] [PATCH] doc: document local_src clean behaviour

[Rouven Czerwinski]

For local_src directories, ptxdist only calls the clean command on a full clean,
not for a clean with the individual package. Document this in a note for the
workflow.

Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
---
 doc/daily_work.inc | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/daily_work.inc b/doc/daily_work.inc
index 47bc987e4..2636336d0 100644
--- a/doc/daily_work.inc
+++ b/doc/daily_work.inc
@@ -118,6 +118,11 @@ To rebuild the kernel:
     jbe@octopus:~/myprj$ ptxdist drop kernel compile
     jbe@octopus:~/myprj$ ptxdist targetinstall kernel
 
+.. note:: To clean the kernel, change into the local_src directory and call
+         ``make clean`` or the clean command for the build system used by the
+         package. A ``ptxdist clean kernel`` call will only delete the
+         symlinks, but not clean the kernel compiled files.
+
 Discovering Runtime Dependencies
 --------------------------------
 
-- 
2.20.1


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

Re: [ptxdist] [PATCH] doc: document local_src clean behaviour

[Michael Olbrich]

On Fri, Jan 18, 2019 at 08:36:42AM +0100, Rouven Czerwinski wrote:
> For local_src directories, ptxdist only calls the clean command on a full clean,
> not for a clean with the individual package. Document this in a note for the
> workflow.
> 
> Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
> ---
>  doc/daily_work.inc | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/doc/daily_work.inc b/doc/daily_work.inc
> index 47bc987e4..2636336d0 100644
> --- a/doc/daily_work.inc
> +++ b/doc/daily_work.inc
> @@ -118,6 +118,11 @@ To rebuild the kernel:
>      jbe@octopus:~/myprj$ ptxdist drop kernel compile
>      jbe@octopus:~/myprj$ ptxdist targetinstall kernel
>  
> +.. note:: To clean the kernel, change into the local_src directory and call
> +         ``make clean`` or the clean command for the build system used by the
> +         package. A ``ptxdist clean kernel`` call will only delete the
> +         symlinks, but not clean the kernel compiled files.

Hmm, I think this is a bit misleading. The symlink in local_src/ is not
deleted and I think the one in build-target/ is not mentioned in the
documentation.

Michael

> +
>  Discovering Runtime Dependencies
>  --------------------------------
>  
> -- 
> 2.20.1
> 
> 
> _______________________________________________
> ptxdist mailing list
> ptxdist@pengutronix.de

-- 
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-5555 |

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

Re: [ptxdist] [PATCH] doc: document local_src clean behaviour

[Roland Hieber]

On Fri, Jan 18, 2019 at 08:36:42AM +0100, Rouven Czerwinski wrote:
> For local_src directories, ptxdist only calls the clean command on a full clean,
> not for a clean with the individual package. Document this in a note for the
> workflow.
> 
> Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
> ---
>  doc/daily_work.inc | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/doc/daily_work.inc b/doc/daily_work.inc
> index 47bc987e4..2636336d0 100644
> --- a/doc/daily_work.inc
> +++ b/doc/daily_work.inc
> @@ -118,6 +118,11 @@ To rebuild the kernel:
>      jbe@octopus:~/myprj$ ptxdist drop kernel compile
>      jbe@octopus:~/myprj$ ptxdist targetinstall kernel
>  
> +.. note:: To clean the kernel, change into the local_src directory and call
> +         ``make clean`` or the clean command for the build system used by the
> +         package. A ``ptxdist clean kernel`` call will only delete the
> +         symlinks, but not clean the kernel compiled files.
> +

I would add a "symlinks in the build directory", to distinguish them
from the symlinks in the local_src/ directory.

 - Roland

-- 
Roland Hieber                     | r.hieber@pengutronix.de     |
Pengutronix e.K.                  | https://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim | Phone: +49-5121-206917-5086 |
Amtsgericht Hildesheim, HRA 2686  | Fax:   +49-5121-206917-5555 |

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de