Bug 10475

Summary:	Document correct usage of FuncFailed
Product:	[Build System, Metadata & Runtime] BitBake	Reporter:	Joshua Lock <joshuagloe>
Component:	bitbake	Assignee:	Joshua Lock <joshuagloe>
Status:	RESOLVED WORKSFORME	QA Contact:
Severity:	enhancement
Priority:	Medium	CC:	poky.bs.watcher, poky.watcher
Version:	2.3
Target Milestone:	2.3
Hardware:	x86
OS:	Multiple
Whiteboard:
OS type for building Yocto:	---	Type of Regression:	---
Verified:		Documentation change:	Yes (doc changes required)

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

Comment 1 Joshua Lock 2017-03-14 17:00:43 UTC

The bitbake manual already discusses use of FuncFailed:

https://www.yoctoproject.org/docs/latest/bitbake-user-manual/bitbake-user-manual.html#bitbake-style-python-functions-versus-python-functions