docs: fault-injection: document cache-filter feature for failslab
authorBreno Leitao <leitao@debian.org>
Fri, 26 Jul 2024 12:09:30 +0000 (05:09 -0700)
committerJonathan Corbet <corbet@lwn.net>
Wed, 7 Aug 2024 18:53:34 +0000 (12:53 -0600)
commit195a56986c50599e5d10a558c12f74266fd51bab
tree8fab14cbeaeb67a0b38f36d34adf8442e80d39ef
parent8663dd38a7ba5b2bfd2c7b4271e6e63bc0ef1e42
docs: fault-injection: document cache-filter feature for failslab

The failslab fault injection mechanism has an undocumented capability
that provides significant utility in testing and debugging. This feature,
introduced in commit 4c13dd3b48fcb ("failslab: add ability to filter slab
caches"), allows for targeted error injection into specific slab caches.

However, it was inadvertently left undocumented at the time of its
implementation.

Add documentation for the cache-filter feature in the failslab mode
description. Also, providing a practical example demonstrating how to
use cache-filter to inject failures specifically when allocating socket
buffers (skbs).

Signed-off-by: Breno Leitao <leitao@debian.org>
Reviewed-by: Akinobu Mita <akinobu.mita@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240726120930.3231333-1-leitao@debian.org
Documentation/fault-injection/fault-injection.rst