looking for clarification re: "rm_work" features and variations

looking for clarification re: "rm_work" features and variations

[Robert P. J. Day]

  was looking to expand on the whole "rm_work" documentation, only to
discover i was profoundly ignorant of some of its features (don't say
it :-).

  so, first, there's the basic stuff (which is already in the YP
documentation):

  INHERIT += "rm_work"
  RM_WORK_EXCLUDE += "pkg1 pkg2 ..."

then in rm_work.bbclass, i see this:

  # Recipes can also configure which entries in their ${WORKDIR}
  # are preserved besides temp, which already gets excluded by default
  # because it contains logs:
  # do_install_append () {
  #     echo "bar" >${WORKDIR}/foo
  # }
  # RM_WORK_EXCLUDE_ITEMS += "foo"
  RM_WORK_EXCLUDE_ITEMS = "temp"

of which i was totally unaware, so let's start there. the above
suggests that recipes can configure, selectively, what in their
WORKDIR gets preserved, but it makes little sense to set that sort of
thing in an actual recipe file; it's clearly the sort of thing a
developer would put in a local.conf.

  so what form would that take? is that meant to be set build-wide
across all recipes, as in:

  RM_WORK_EXCLUDE_ITEMS = "image"

to preserve all "image" directories? or can one use, say, "pn-"
overrides:

  RM_WORK_EXCLUDE_ITEMS_pn-<recipename> = "image pseudo"

(none of the above seems to be mentioned in the YP docs.)

  finally, there is the related rm_work_and_downloads class file,
which can probably be shoehorned into that explanation somewhere (also
not apparently anywhere in the YP docs).

  so what's the proper usage of the above?

rday

Re: [OE-core] looking for clarification re: "rm_work" features and variations

[Richard Purdie]

On Fri, 2020-04-10 at 13:52 -0400, Robert P. J. Day wrote:
>   was looking to expand on the whole "rm_work" documentation, only to
> discover i was profoundly ignorant of some of its features (don't say
> it :-).
> 
>   so, first, there's the basic stuff (which is already in the YP
> documentation):
> 
>   INHERIT += "rm_work"
>   RM_WORK_EXCLUDE += "pkg1 pkg2 ..."
> 
> then in rm_work.bbclass, i see this:
> 
>   # Recipes can also configure which entries in their ${WORKDIR}
>   # are preserved besides temp, which already gets excluded by
> default
>   # because it contains logs:
>   # do_install_append () {
>   #     echo "bar" >${WORKDIR}/foo
>   # }
>   # RM_WORK_EXCLUDE_ITEMS += "foo"
>   RM_WORK_EXCLUDE_ITEMS = "temp"
> 
> of which i was totally unaware, so let's start there. the above
> suggests that recipes can configure, selectively, what in their
> WORKDIR gets preserved, but it makes little sense to set that sort of
> thing in an actual recipe file; it's clearly the sort of thing a
> developer would put in a local.conf.

I'd suggest this is more of a class internal and not really aimed at
the general user. There are things which someone might set here but its
not common usage.

Cheers,

Richard