From 1a2254d3d7e5574015f7c92c3c9658cf7bdc28a7 Mon Sep 17 00:00:00 2001 From: "Alan T. DeKok" Date: Sat, 21 Oct 2023 08:08:46 -0400 Subject: [PATCH] fix documentation --- src/lib/unlang/edit.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/lib/unlang/edit.c b/src/lib/unlang/edit.c index 76576bff0d22..39b7e3cc545b 100644 --- a/src/lib/unlang/edit.c +++ b/src/lib/unlang/edit.c @@ -1597,7 +1597,10 @@ static unlang_action_t unlang_edit_state_init(rlm_rcode_t *p_result, request_t * /** Push a map onto the stack for edit evaluation * - * If the "success" variable returns "false", the caller should free the edit list. At which point all edits will be undone. + * If the "success" variable returns "false", the caller should call fr_edit_list_abort(). + * + * If the "success" variable returns "true", the caller can free the edit list (or rely on talloc to do that) + * and the transaction will be finalized. * * @param[in] request The current request. * @param[out] success Whether or not the edit succeeded