From bb0f19902d9b49f5e52aa47c10cd2dfb0d56c355 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20B=C3=BChler?= <david.buhler@cea.fr> Date: Mon, 14 Feb 2022 10:53:36 +0100 Subject: [PATCH] [Eva] Results: improves the documentation of function [callstacks]. --- src/plugins/value/Eva.mli | 6 +++++- src/plugins/value/utils/results.mli | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/plugins/value/Eva.mli b/src/plugins/value/Eva.mli index bad7b93a157..07f108a1bb7 100644 --- a/src/plugins/value/Eva.mli +++ b/src/plugins/value/Eva.mli @@ -139,7 +139,11 @@ module Results: sig (** Working with callstacks *) - (** Returns the list of reachable callstacks from the given request. *) + (** Returns the list of reachable callstacks from the given request. + An empty list is returned if the request control point has not been + reached by the analysis, or if no information has been saved at this point + (for instance with the -eva-no-results option). + Use [is_empty request] to distinguish these two cases. *) val callstacks : request -> callstack list (** Returns a list of subrequests for each reachable callstack from diff --git a/src/plugins/value/utils/results.mli b/src/plugins/value/utils/results.mli index 2bba4a21ee6..37f7bf89716 100644 --- a/src/plugins/value/utils/results.mli +++ b/src/plugins/value/utils/results.mli @@ -127,7 +127,11 @@ val filter_callstack : (callstack -> bool) -> request -> request (** Working with callstacks *) -(** Returns the list of reachable callstacks from the given request. *) +(** Returns the list of reachable callstacks from the given request. + An empty list is returned if the request control point has not been + reached by the analysis, or if no information has been saved at this point + (for instance with the -eva-no-results option). + Use [is_empty request] to distinguish these two cases. *) val callstacks : request -> callstack list (** Returns a list of subrequests for each reachable callstack from -- GitLab