summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-09-25 09:45:47 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-09-26 11:18:59 +0100
commit0e7af54763666cde16219465ad2ebaf52dc7f7e6 (patch)
treefe6b838e884a40220d9694e357ffab16eec24fae /documentation
parentc801d0425d442d05245274e71e7ccc9ff9f81915 (diff)
downloadpoky-0e7af54763666cde16219465ad2ebaf52dc7f7e6.tar.gz
dev-manual: Updated compatible log program section.
Script name changed to "yocto-check-layer". (From yocto-docs rev: 545a90dd2816c4e97dc70efc76c7cca49684c2d8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml23
1 files changed, 11 insertions, 12 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index f82d37e1dc..3f33a81b12 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -443,10 +443,10 @@
443 with the Yocto Project). 443 with the Yocto Project).
444 Ensuring compatibility makes the layer easy to be consumed 444 Ensuring compatibility makes the layer easy to be consumed
445 by others in the Yocto Project community and could allow you 445 by others in the Yocto Project community and could allow you
446 permission to use the Yocto Project Compatibility Logo. 446 permission to use the Yocto Project Compatible Logo.
447 <note> 447 <note>
448 Only Yocto Project member organizations are permitted to 448 Only Yocto Project member organizations are permitted to
449 use the Yocto Project Compatibility Logo. 449 use the Yocto Project Compatible Logo.
450 The logo is not available for general use. 450 The logo is not available for general use.
451 For information on how to become a Yocto Project member 451 For information on how to become a Yocto Project member
452 organization, see the 452 organization, see the
@@ -463,7 +463,7 @@
463 <orderedlist> 463 <orderedlist>
464 <listitem><para> 464 <listitem><para>
465 Successfully passing a script 465 Successfully passing a script
466 (<filename>yocto-compat-layer.py</filename>) that 466 (<filename>yocto-check-layer</filename>) that
467 when run against your layer, tests it against 467 when run against your layer, tests it against
468 constraints based on experiences of how layers have 468 constraints based on experiences of how layers have
469 worked in the real world and where pitfalls have been 469 worked in the real world and where pitfalls have been
@@ -501,15 +501,14 @@
501 <para> 501 <para>
502 The remainder of this section presents information on the 502 The remainder of this section presents information on the
503 registration form and on the 503 registration form and on the
504 <filename>yocto-compat-layer.py</filename> script. 504 <filename>yocto-check-layer</filename> script.
505 </para> 505 </para>
506 506
507 <section id='yocto-project-compatibility-program-application'> 507 <section id='yocto-project-compatible-program-application'>
508 <title>Yocto Project Compatibility Program Application</title> 508 <title>Yocto Project Compatible Program Application</title>
509 509
510 <para> 510 <para>
511 Use the form to apply for your layer's compatibility 511 Use the form to apply for your layer's approval.
512 approval.
513 Upon successful application, you can use the Yocto 512 Upon successful application, you can use the Yocto
514 Project Compatibility Logo with your layer and the 513 Project Compatibility Logo with your layer and the
515 application that uses your layer. 514 application that uses your layer.
@@ -549,11 +548,11 @@
549 </para> 548 </para>
550 </section> 549 </section>
551 550
552 <section id='yocto-compat-layer-py-script'> 551 <section id='yocto-check-layer-script'>
553 <title><filename>yocto-compat-layer.py</filename> Script</title> 552 <title><filename>yocto-check-layer</filename> Script</title>
554 553
555 <para> 554 <para>
556 The <filename>yocto-compat-layer.py</filename> script 555 The <filename>yocto-check-layer</filename> script
557 provides you a way to assess how compatible your layer is 556 provides you a way to assess how compatible your layer is
558 with the Yocto Project. 557 with the Yocto Project.
559 You should run this script prior to using the form to 558 You should run this script prior to using the form to
@@ -577,7 +576,7 @@
577 your build directory: 576 your build directory:
578 <literallayout class='monospaced'> 577 <literallayout class='monospaced'>
579 $ source oe-init-build-env 578 $ source oe-init-build-env
580 $ yocto-compat-layer.py <replaceable>your_layer_directory</replaceable> 579 $ yocto-check-layer <replaceable>your_layer_directory</replaceable>
581 </literallayout> 580 </literallayout>
582 Be sure to provide the actual directory for your layer 581 Be sure to provide the actual directory for your layer
583 as part of the command. 582 as part of the command.