[tor-commits] [tor/master] Provide examples of tor_api_get_provider_version() output

[nickm@xxxxxxxxxxxxxx]

commit df444e482bc083b4c4239b8fb4d532ebffaae5a8
Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date:   Wed Aug 8 18:10:28 2018 -0400

    Provide examples of tor_api_get_provider_version() output
    
    At the same time, sternly warn any person thinking about relying on
    any particular format too strictly.  If you do this, and your
    program breaks, it is your bug, not mine.
---
 src/feature/api/tor_api.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/feature/api/tor_api.h b/src/feature/api/tor_api.h
index a08606ee3..ad2d3166c 100644
--- a/src/feature/api/tor_api.h
+++ b/src/feature/api/tor_api.h
@@ -65,6 +65,12 @@ void tor_main_configuration_free(tor_main_configuration_t *cfg);
  * libtorrunner, not the version of Tor that it's invoking for you.
  *
  * Added in Tor 0.3.5.1-alpha.
+ *
+ * Example return values include "tor 0.3.5.1-alpha" when linked directly
+ * against tor, and "libtorrunner 0.3.5.1-alpha" when linked against
+ * libtorrunner while it is invoking an arbitrary version of Tor.  HOWEVER,
+ * the user MUST NOT depend on any particular format or contents of this
+ * string: there may be other things that implement Tor in the future.
  **/
 const char *tor_api_get_provider_version(void);
 

_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits