documentation: when to BUG(), and when to not BUG()
authorDavid Brownell <dbrownell@users.sourceforge.net>
Tue, 6 Jan 2009 22:41:01 +0000 (14:41 -0800)
committerLinus Torvalds <torvalds@linux-foundation.org>
Tue, 6 Jan 2009 23:59:13 +0000 (15:59 -0800)
commitaf9379c7121d5543722c00bbd1adf7dcaa0b6448
tree798ddf46cd7b3edbec70d8b1af5f064d1db83532
parent5f820f648c92a5ecc771a96b3c29aa6e90013bba
documentation: when to BUG(), and when to not BUG()

Provide some basic advice about when to use BUG()/BUG_ON(): never, unless
there's really no better option.

This matches my understanding of the standard policy ...  which seems not
to be written down so far, outside of LKML messages that I haven't
bookmarked.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Cc: Hans Verkuil <hverkuil@xs4all.nl>
Cc: Ingo Molnar <mingo@elte.hu>
Cc: Arjan van de Ven <arjan@infradead.org>
Cc: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
include/asm-generic/bug.h