regulator: Documentation fix for regulator error notification helper
authorMatti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
Mon, 23 Aug 2021 07:56:51 +0000 (10:56 +0300)
committerMark Brown <broonie@kernel.org>
Mon, 23 Aug 2021 10:06:28 +0000 (11:06 +0100)
commitad3ead1efe057029bf112e13d7ef5901915d6abd
tree1b29a0235daa4a02b5e8bd9a282bce8c399bb090
parentc049742fbc71129c481a6d5e52392b9aa482cc9e
regulator: Documentation fix for regulator error notification helper

The helper to send IRQ notification for regulator errors had still
old description mentioning calling BUG() as a last resort when
error status reading has kept failing for more times than a given
threshold.

The impementation calling BUG() did never end-up in-tree but was
replaced by hopefully more sophisticated handler trying to power-off
the system.

Fix the documentation to reflect actual behaviour.

Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
Link: https://lore.kernel.org/r/20210823075651.GA3717293@localhost.localdomain
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/regulator/irq_helpers.c
include/linux/regulator/driver.h