uat: Small comment update about update callbacks

Note that one permissible way to have the update_cb actually
change a record, not just validate it, is if the same changes
are made by the copy_cb (e.g. by having the copy_cb call the
update_cb on the newly created record.) Some UATs do this.

[skip ci]
This commit is contained in:
John Thacker 2023-10-31 20:01:49 -04:00
parent 1484169815
commit 4d71744d84
1 changed files with 3 additions and 1 deletions

View File

@ -117,7 +117,9 @@ typedef void (*uat_reset_cb_t)(void);
* freed by g_free.
*
* XXX: This should only validate the record. Any changes to the record
* made here will *not* be persistent if the UAT is saved again.
* made here will *not* be persistent if the UAT is saved again, unless
* the same changes are also done to a new record created by the copy cb,
* e.g. by having the the copy callback call this.
* It should probably be made into a const void* to make that clear.
*/
typedef bool (*uat_update_cb_t)(void *record, char **error);