summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-qa-checks.xml
Commit message (Collapse)AuthorAgeFilesLines
* sphinx: remove DocBook filesNicolas Dechesne2020-10-061-1225/+0
| | | | | | | | | | The Yocto Project documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add SPDX license headersakuster2020-06-281-0/+1
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: b7d60325c7ca02d38516781ea80376e465c5fd04) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document new unlisted-pkg-lics insane-skip qa checkQuentin Schulz2020-05-211-0/+25
| | | | | | | | | | | | | The new unlisted-pkg-lics INSANE_SKIP QA check was introduced and need proper documentation. This QA check makes sure all licenses listed for all packages built by a recipe are declared in the recipe LICENSE variable. (From yocto-docs rev: a50e0628f3d40f9103c9a6ecccde61ad6d7f21c6) Signed-off-by: Quentin Schulz <quentin.schulz@streamunlimited.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Completed first draft of 2.3 migration section.Scott Rifenbark2017-05-101-39/+0
| | | | | | | (From yocto-docs rev: 42ab9e34da640b46d39741c9c83648dc65518ec1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated QA error message.Scott Rifenbark2016-10-111-1/+1
| | | | | | | | | | Added wording to the "installed-vs-shipped" error message in the QA chapter. (From yocto-docs rev: cc9d22fb6dd8e45ef6b53608f0ebccf29721cc3f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added new description for the PACKAGECONFIG_CONFARGS variable.Scott Rifenbark2016-09-231-1/+2
| | | | | | | | | | | | | | | | | Fixes [YOCTO #10183] Added a new variable entry for the PACKAGECONFIG_CONFARGS variable. With the introduction of the new PACKAGECONFIG_CONFARGS variable, many places in the mainstream YP documentation that referenced how to pass configure arguments using EXTRA_OECONF needed to also make mention of this new variable. I added many cross-references to the new variable. (From yocto-docs rev: 00f02d45319bab90b72eab89fcb69cbe8bd05bb5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated warning regarding libexecdirScott Rifenbark2016-02-041-5/+7
| | | | | | | | | | | | | | | Fixes [YOCTO #6398] Fixed the text according to Ross such that the specified package contains files in /usr/libexec when the distro configuration uses a different path for <libexecdir>. By default libexecdir is $prefix/libexec but this can be changed, for example to ${libdir}. (From yocto-docs rev: 6ffe6728994c615abe2689a63f9f055425d08d7e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fix to QA error message.Scott Rifenbark2015-07-281-1/+1
| | | | | | | | | | | | Fixed wording in section 7.78 to use "nativesdk-myrecipe.bb". Fixed message to say "non-dev/-dbg/nativesdk- package contains symlink..." Reported-by: Rene Fichter <rene@fichter.se> (From yocto-docs rev: 80a5b51a0416dc610edf1526079102fee661375b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the ELF Binary QA warning messageScott Rifenbark2015-04-281-2/+3
| | | | | | | | | | | | Fixes [YOCTO #7630] I applied some feedback from Laszlo Papp suggesting that the user can also use '-fpic' as well as '-fPIC' for a command-line option. (From yocto-docs rev: ec79c9a39955b22cb2b8cec44ffcaab22aba479b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to ELF binary QA warning - review changesScott Rifenbark2015-04-241-5/+12
| | | | | | | | | | | Applied some review edits from Paul. Fixes [YOCTO #7630] (From yocto-docs rev: 064fa763686f5ddaccba4a7201757f2a6fc8636c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to ELF binary QA warningScott Rifenbark2015-04-241-0/+10
| | | | | | | | | | | | | | | Fixes [YOCTO #7630] Apparently the text relocation being done here can cause runtime performance issues. I documented a potential work-around for the issue and provided a cross-reference link to an external site for more general information about text relocation at runtime. Reported-by: Laszlo Papp <lpapp@kde.org> (From yocto-docs rev: f7ba2fd03ee40c5dbe6a07a24a63d9147857ed78) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Replaced &dash;&dash; with "--"Scott Rifenbark2015-03-061-1/+1
| | | | | | | | | | | | | | | Fixes [YOCTO #7386] Apparently, copying HTML displayed commands that have a double dash created through "&dash;&dash;" in the docbook source causes some issues in the shell. I have scrubbed the manual set to replace any "&dash;&dash;" strings with "--". Reported-by: Paul Eggleton <paul.eggleton@intel.com> (From yocto-docs rev: e88b813b71d7d6d8acd8a8638f2db71265145b64) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Scrubbed for variable (user) input.Scott Rifenbark2014-10-181-1/+1
| | | | | | | | | | | | | | | Throughout the manual I had been using angled bracket sets to denote user-supplied input. This is confusing and better shown by using the <replaceable></replaceable> tags. I scrubbed all the chapters and replaced as needed. Some other minor formatting changes were caught and fixed during the scrub as well. (From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits for review on new QA checks.Scott Rifenbark2014-10-181-4/+4
| | | | | | | | | Fixed some minor issues with build-deps and file-rdeps. (From yocto-docs rev: b4250c9ba7d6a3d30c3dfb94d9e2e2eea6b47764) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added [build-deps] QA error message.Scott Rifenbark2014-10-181-0/+30
| | | | | | | (From yocto-docs rev: 1883450fe2ca823dc258283a76012bf75b38615b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added [file->rdeps] QA error message.Scott Rifenbark2014-10-181-0/+26
| | | | | | | (From yocto-docs rev: d0546876a775c3d632a4a270aaaa8790a1e0535b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, template: Permalinks for QA errors and warningsScott Rifenbark2014-10-101-40/+43
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Updated the ref-qa-checks.xml chapter so that each QA warning or error message would generate a permalink that is suitable for searching from the poky codebase. To implement this, I had to embed an id marker in the <para> tag that precedes each <code></code> tag pair. The 'xxx' string of the id is the leaf portion of the permalink. This creates the following tag construct: <para id='xxx'> <code> some-warning-or-error-message </code> </para> The permalink is generated with the help of the new qa-code-permalinks.xsl file, which triggers on the <para><code></code></para> construct. This new file resides in documentation/template. Right now, this construct is unique to the ref-manual's chapter on the QA error and warnings chapter only. However, if for some reason that construct is used in any other part of the ref-manual, a generically numbered permalink would also be generated. The ref-manual-customization.xsl file was also altered to include the new documentation/template/qa-code-permalinks.xsl file. Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com> (From yocto-docs rev: aec27a9f8337575d31bfe0066563da99259046e0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Some minor fixes to the QA Checks chapter.Scott Rifenbark2014-07-031-2/+9
| | | | | | | | | | | | | * For "Architecture did not match" and "Bit size did not match", added the missing QA check name marker [arch] * Under the already-stripped entry, added a final sentence (to the paragraph before the note box) (From yocto-docs rev: 7c3bda03a4424d1e083403266c570b34fcab9bbf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed a typo in one of the QA descriptions.Scott Rifenbark2014-06-181-1/+1
| | | | | | | (From yocto-docs rev: 612ec8f679f9864fa1330d8c92044d8340f88f8e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the QA checks message section and insane.bbclass.Scott Rifenbark2014-05-301-21/+34
| | | | | | | | | | | | | Fixes [YOCTO #6159] I applied some review edits to various parts of the QA chapter as derived by Paul Eggleton. Also, updated two areas of the insane.bbclass list. (From yocto-docs rev: 6529a261961339b747bb3b89b3080ef794244809) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied review edits to QA messages and insane.bbclass.Scott Rifenbark2014-05-301-510/+860
| | | | | | | | | | | | | Fixes [YOCTO #6159] Edits from Paul Eggleton included some reformatting, some minor wording tweaks, and edits to a couple tests as described in the insane.bbclass. (From yocto-docs rev: b42ef1bd51cb20f6bbb6bf812999e3a35b332339) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added PRIVATE_LIBS variable and supporting links.Scott Rifenbark2014-05-301-1/+2
| | | | | | | (From yocto-docs rev: f4e8652581fe99a0d833242a8483ed637e55e3a5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added TARGET_CC_ARCH variable and supporting links.Scott Rifenbark2014-05-301-1/+1
| | | | | | | (From yocto-docs rev: d0887f66e3bc9d420d7ce626d5467bbc6d259b90) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added LDFLAGS variable and supporting links.Scott Rifenbark2014-05-301-1/+1
| | | | | | | (From yocto-docs rev: 58d583c9167feee65d7d22b343ea250cb8807261) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new chapter on QA error and warning messages.Scott Rifenbark2014-05-301-0/+787
This new chapter is a reference on the default configuration QA check messages you can get from errors and warnings. (From yocto-docs rev: 04d766b4e1235ae46df38c4b296cb2729b6a439f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-11 09:55:51 +0000