Bug 10475 - Document correct usage of FuncFailed
Summary: Document correct usage of FuncFailed
Status: RESOLVED WORKSFORME
Alias: None
Product: BitBake
Classification: Build System, Metadata & Runtime
Component: bitbake (show other bugs)
Version: 2.3
Hardware: x86 Multiple
: Medium enhancement
Target Milestone: 2.3
Assignee: Joshua Lock
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2016-10-21 10:06 UTC by Joshua Lock
Modified: 2017-03-14 17:00 UTC (History)
2 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Yes (doc changes required)

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Joshua Lock 2016-10-21 10:06:28 UTC 
A recent series of changes to OE-Core starting with [1] removed many sites where a FuncFailed exception is raised. We should add docstring to the FuncFailed class to explain its correct usage.

We may also want to add something to the BitBake user manual.

1. http://git.openembedded.org/openembedded-core/commit/?id=9635af9785509a39c1ac2509740d46276119a0ca