Bug 9988

Ulf, 

For STAGING_DIR_HOST see http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-STAGING_DIR_HOST.  BTW, there is no documentation for the the MULTIMACH_HOST_SYS variable so I can't linkify it.  Maybe we need to have that variable added to the glossary?

For STAGING_DIR_NATIVE see http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-STAGING_DIR_NATIVE

For STAGING_DIR_TARGET see http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-STAGING_DIR_TARGET.  I need an opening sentence for consistency that is in the same form as the other variables.  So, I created on based on that stuff you wanted me to use in the end.  If what I put there is not technically accurate, let me know.

Thanks, 
Scott

For STAGING_DIR_TARGET, I think the following opening sentence should work:

  Specifies the path to the sysroot used for the system for which the
  component generates code. For components that do not generate code
  (i.e. the vast majority), STAGING_DIR_TARGET is set to match
  STAGING_DIR_HOST.

Maybe this sentence could be removed as well, since it becomes redundant: "For recipes where STAGING_DIR_TARGET makes no sense, it is set to match STAGING_DIR_HOST."


Looks like only MULTIMACH_TARGET_SYS is defined at the moment, and the definition seems a bit subtle and difficult to understand. Here's my attempt to clarify both MULTIMACH_TARGET_SYS and MULTIMACH_HOST_SYS. Hopefully I've understood them correctly.

  MULTIMACH_TARGET_SYS (rewriting): In situations that involve a "HOST"
  system and a "TARGET" system (see STAGING_DIR_TARGET), this variable
  uniquely identifies the package architecture (PACKAGE_ARCH) together
  with the "TARGET" system. This allows output for different target
  machines to be put into different subdirectories of the same output
  directory.

  The default value of this variable is

    ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS}

  Some classes (e.g. cross-canadian.bbclass) modify this value.

  See the STAMP variable for an example. MULTIMACH_HOST_SYS is the
  corresponding variable for the host system.


  MULTIMACH_HOST_SYS: Serves the same purpose as MULTIMACH_TARGET_SYS,
  but for the "HOST" system.

  The default value of this variable is

    ${PACKAGE_ARCH}${HOST_VENDOR}-${HOST_OS}

Would definitely be nice if someone more knowledgeable could look those
over.

Here's a second version of the MULTIMACH_HOST/TARGET_SYS glossary entries. I think this might be closer to the truth (and a bit shorter too):

  MULTIMACH_TARGET_SYS (rewriting): Uniquely identifies the type of the target
  machine that packages are being built for. This variable allows output for
  different types of target machines to be put into different subdirectories of
  the same output directory.

  The default value of this variable is

    ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS}

  Some classes (e.g. cross-canadian.bbclass) modify this value.

  See the STAMP variable for an example. MULTIMACH_HOST_SYS is the
  corresponding variable for the host machine in situations that involve a
  "HOST" and a "TARGET" system (see STAGING_DIR_TARGET).



  MULTIMACH_HOST_SYS: Serves the same purpose as MULTIMACH_TARGET_SYS, but for
  the "HOST" system, in situations that involve a "HOST" and a "TARGET" system
  (see STAGING_DIR_TARGET).

  The default value of this variable is

    ${PACKAGE_ARCH}${HOST_VENDOR}-${HOST_OS}

One last nit with a few s/machine/system/ for consistency (and because it might be less confusing):

  MULTIMACH_TARGET_SYS (rewriting): Uniquely identifies the type of the target
  system that packages are being built for. This variable allows output for
  different types of target machines to be put into different subdirectories of
  the same output directory.

  The default value of this variable is

    ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS}

  Some classes (e.g. cross-canadian.bbclass) modify this value.

  See the STAMP variable for an example. MULTIMACH_HOST_SYS is the
  corresponding variable for the host system in situations that involve a
  "HOST" and a "TARGET" system (see STAGING_DIR_TARGET).



  MULTIMACH_HOST_SYS: Serves the same purpose as MULTIMACH_TARGET_SYS, but for
  the "HOST" system, in situations that involve a "HOST" and a "TARGET" system
  (see STAGING_DIR_TARGET).

  The default value of this variable is

    ${PACKAGE_ARCH}${HOST_VENDOR}-${HOST_OS}

Bleh... missed one "machine". This really should be the final one. :P

  MULTIMACH_TARGET_SYS (rewriting): Uniquely identifies the type of the target
  system that packages are being built for. This variable allows output for
  different types of target systems to be put into different subdirectories of
  the same output directory.

  The default value of this variable is

    ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS}

  Some classes (e.g. cross-canadian.bbclass) modify this value.

  See the STAMP variable for an example. MULTIMACH_HOST_SYS is the
  corresponding variable for the host system in situations that involve a
  "HOST" and a "TARGET" system (see STAGING_DIR_TARGET).



  MULTIMACH_HOST_SYS: Serves the same purpose as MULTIMACH_TARGET_SYS, but for
  the "HOST" system, in situations that involve a "HOST" and a "TARGET" system
  (see STAGING_DIR_TARGET).

  The default value of this variable is

    ${PACKAGE_ARCH}${HOST_VENDOR}-${HOST_OS}

Paul Eggleton looked over the updated/added glossary entries in #yocto on Freenode and said they looked fine, so probably safe to add.

Ulf, 

For STAGING_DIR_TARGET, see http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-STAGING_DIR_TARGET

For MULTIMACH_TARGET_SYS, see http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-MULTIMACH_HOST_SYS

For MULTIMACH_HOST_SYS, see http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-MULTIMACH_HOST_SYS

Thanks, 
Scott

Few nits:

 - MULTIMACH_HOST_SYS could be linkified in the STAGING_DIR_HOST glossary entry now.

 - "which is the majority)" has a spurious ")".

 - The variables in the default values for MULTIMACH_HOST_SYS and MULTIMACH_TARGET_SYS could be linkified.

Cheers,
Ulf

Ulf, 

I linked the first one mentioned - http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-STAGING_DIR_HOST

Regarding linking variables in the literal examples... I might have done that a bit, but I try to avoid it.  The linking gets overdone.

Thanks, 
Scott

I'm fine with just linking the first one.

Still an extra ')' in the entry for STAGING_DIR_TARGET:

  For components that do not generate code, which is the majority), ...

Oops... blew right by that one.  I have removed it.

Thanks.

http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-STAGING_DIR_TARGET

Looks fine to me now. Thanks!

I also noticed an unrelated thing. There's a repeated 'and' here:

  Thus, the binaries run on the "HOST" system and and generate
  binaries for the "TARGET" system.

Cheers,
Ulf

Sorry ... fixed.  Nice catch.

Scott

Looks like everyone is happy, closing.

Setting the doc flag to "done".

Scott