possible clarification of EXPORT_FUNCTIONS for user manual

possible clarification of EXPORT_FUNCTIONS for user manual

[Robert P. J. Day]

  so, just to make sure i'm understanding this correctly, in section
3.4.5 of BB user manual, discussion of EXPORT_FUNCTIONS talks about
the general concept of exporting *functions*, but the entire section
uses exclusively "do_" examples, which might mislead the reader into
thinking it's good only for *tasks*.

  i decided to look through the oe-core layer for examples of
exporting an actual function, and i found all of one example -- in
meta/classes/debian.bbclass:

  python debian_package_name_hook () {
      ... snip ...
  }
  ...
  EXPORT_FUNCTIONS package_name_hook

which seems like a valid example of exporting a function, except i
can't find a single example of this function being used anywhere else.
am i missing something?

  anyway, i guess my point is that that section could be tweaked to
emphasize that exporting works for both functions and tasks, although
the only function example i found seems unused. thoughts?

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

Re: possible clarification of EXPORT_FUNCTIONS for user manual

[Richard Purdie]

On Wed, 2014-07-09 at 11:14 -0400, Robert P. J. Day wrote:
>   so, just to make sure i'm understanding this correctly, in section
> 3.4.5 of BB user manual, discussion of EXPORT_FUNCTIONS talks about
> the general concept of exporting *functions*, but the entire section
> uses exclusively "do_" examples, which might mislead the reader into
> thinking it's good only for *tasks*.
> 
>   i decided to look through the oe-core layer for examples of
> exporting an actual function, and i found all of one example -- in
> meta/classes/debian.bbclass:
> 
>   python debian_package_name_hook () {
>       ... snip ...
>   }
>   ...
>   EXPORT_FUNCTIONS package_name_hook
> 
> which seems like a valid example of exporting a function, except i
> can't find a single example of this function being used anywhere else.
> am i missing something?
> 
>   anyway, i guess my point is that that section could be tweaked to
> emphasize that exporting works for both functions and tasks, although
> the only function example i found seems unused. thoughts?

package_name_hook is called by package.bbclass

Cheers,

Richard

Re: possible clarification of EXPORT_FUNCTIONS for user manual

[Robert P. J. Day]

On Wed, 9 Jul 2014, Richard Purdie wrote:

> On Wed, 2014-07-09 at 11:14 -0400, Robert P. J. Day wrote:
> >   so, just to make sure i'm understanding this correctly, in section
> > 3.4.5 of BB user manual, discussion of EXPORT_FUNCTIONS talks about
> > the general concept of exporting *functions*, but the entire section
> > uses exclusively "do_" examples, which might mislead the reader into
> > thinking it's good only for *tasks*.
> >
> >   i decided to look through the oe-core layer for examples of
> > exporting an actual function, and i found all of one example -- in
> > meta/classes/debian.bbclass:
> >
> >   python debian_package_name_hook () {
> >       ... snip ...
> >   }
> >   ...
> >   EXPORT_FUNCTIONS package_name_hook
> >
> > which seems like a valid example of exporting a function, except i
> > can't find a single example of this function being used anywhere else.
> > am i missing something?
> >
> >   anyway, i guess my point is that that section could be tweaked to
> > emphasize that exporting works for both functions and tasks, although
> > the only function example i found seems unused. thoughts?
>
> package_name_hook is called by package.bbclass

  whoops, quite so, not sure how i missed that.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================