From a0da16bf65caaf76c4d698959843cf1b18cd674e Mon Sep 17 00:00:00 2001 From: Romain Tartiere Date: Mon, 26 Apr 2010 11:09:04 +0000 Subject: [PATCH] Update documentation. Add a note about freefare_get_tags() invalidating previously found targets. --- libfreefare/freefare.3 | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/libfreefare/freefare.3 b/libfreefare/freefare.3 index 85e42a1..ba8cb50 100644 --- a/libfreefare/freefare.3 +++ b/libfreefare/freefare.3 @@ -78,14 +78,14 @@ returns a NULL-terminated list of .Vt MifareTag present on .Vt device . -This list has to be freed after usage by either +This list has to be freed after usage by either: .Bl -hyphen .It -Calling the +calling the .Fn freefare_free_tags function. All tags in the list are automatically freed; .It -Calling the +calling the .Fn freefare_free_tag function to free each tag in the list individually, and freeing the list itself using the @@ -93,6 +93,13 @@ using the function. .El .Pp +Because of the nature of the target detection process, any previously detected +target will be in an inconsistent state after a call to +.Fn freefare_get_tags . +It is the programmer's responsibility to free these targets before calling the +.Fn freefare_get_tags +function. +.Pp Information about a given .Vt MifareTag can be gathered using the