Update AsanBacktrace documentation (#2377)

maxammann · web-flow · commit 3bebbe0dacd6 · 2024-08-05T22:10:46.000+02:00
* Add AsanBacktrace documentation

* Update stacktrace.rs
diff --git a/libafl/src/observers/stacktrace.rs b/libafl/src/observers/stacktrace.rs
@@ -267,7 +267,7 @@ pub fn get_asan_runtime_flags() -> String {
     flags.join(":")
 }
 
-/// An observer looking at the backtrace of target command using ASAN output
+/// An observer looking at the backtrace of target command using ASAN output. This observer is only compatible with a `ForkserverExecutor`.
 #[derive(Serialize, Deserialize, Debug, Clone)]
 pub struct AsanBacktraceObserver {
     observer_name: Cow<'static, str>,

Original file line number	Diff line number	Diff line change
`@@ -267,7 +267,7 @@ pub fn get_asan_runtime_flags() -> String {`
`267`	`267`	`flags.join(":")`
`268`	`268`	`}`
`269`	`269`
`270`		`-/// An observer looking at the backtrace of target command using ASAN output`
	`270`	+/// An observer looking at the backtrace of target command using ASAN output. This observer is only compatible with a `ForkserverExecutor`.
`271`	`271`	`#[derive(Serialize, Deserialize, Debug, Clone)]`
`272`	`272`	`pub struct AsanBacktraceObserver {`
`273`	`273`	`observer_name: Cow<'static, str>,`