Re: [docs] [PATCH v2 1/2] ref-manual: tasks: do_cleanall: recommend using '-f fetch' instead

[Luca Ceresoli <luca.ceresoli@bootlin.com>]

Hi Quentin,

On Tue, 27 Feb 2024 13:23:52 +0100
Quentin Schulz <quentin.schulz@theobroma-systems.com> wrote:

> Hi Luca,
> 
> On 2/27/24 13:00, Luca Ceresoli wrote:
> [...]
> >> One of the issues with using -f is that it taints the build as far as I
> >> remember and you'll get a warning for all subsequent builds until you
> >> clean stuff?  
> > 
> > Yes. But I don't see any other way out other than removing the entire
> > tmp dir... the warning is maybe annoying but harmless anyway.
> >   
> 
> I worked for a company whose build system was blurting out lines and 
> lines of warnings and it took me some time to teach people to not ignore 
> those warnings because sometimes those warnings were actually important, 
> so that's where I'm coming from :)

While I feel your pain, I think no documentation can prevent people
from actively shooting on their feet. So we can add this note for who
is willing to read it, I guess...

[...]

> >>> +   This can be even more tricky if using a shared download
directory.
> >>>    
> 
> [...]
> 
> >> I think we could also be a bit more explicit about the risks here.
> >>
> >> If a download directory (DL_DIR) is shared between different bitbake
> >> running at the same time (e.g. multiple bitbakes on the same machine, or
> >> spread over the network), removing stamps and source tarballs/git repo
> >> from one bitbake would likely break the other bitbakes trying to get the
> >> source from the common place that now doesn't exist anymore.  
> > 
> > That's the example that was in v1 of this patch. However I now added an
> > example of the error happening without a shared DL_DIR, which is much
> > more relevant because you don't even need a shared dir. I then removed
> > the initial example as I don't think we need a verbose list of examples
> > here. i think we need to say: don't do this because it can fail
> > even in the basic case.
> > 
> > If anything should be done about the last sentence would rather be to
> > remove it entirely.
> >   
> 
> I could suggest the following rewording:
> 
> """
> Note that this also applies to bitbake from concurrent processes when a 
> shared download directory (:term:`DL_DIR`) is setup.
> """

Sounds better. Took your version as-is for v3, thanks!

> In any case, the original is fine with me with the few typo fixed :)

Cool. v3 incoming.

Luca

-- 
Luca Ceresoli, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com