[tor-commits] [tor/master] hs-v3: Improve documentation of hs_cache_client_descriptor_t

[asn at torproject.org]

commit 68a004d147bd4bd245563b7b7ed2f97e1f333dd4
Author: David Goulet <dgoulet at torproject.org>
Date:   Thu Oct 17 09:50:23 2019 -0400

    hs-v3: Improve documentation of hs_cache_client_descriptor_t
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 src/feature/hs/hs_cache.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/feature/hs/hs_cache.h b/src/feature/hs/hs_cache.h
index 4fd9ac544..a56e2cc6c 100644
--- a/src/feature/hs/hs_cache.h
+++ b/src/feature/hs/hs_cache.h
@@ -114,8 +114,10 @@ typedef struct hs_cache_client_descriptor_t {
    * using the next blinded key of the service. */
   time_t expiration_ts;
 
-  /** The cached descriptor, this object is the owner. It can't be NULL. A
-   * cache object without a valid descriptor is not possible. */
+  /** The cached decoded descriptor, this object is the owner. This can be
+   * NULL if the descriptor couldn't be decoded due to missing or bad client
+   * authorization. It can be decoded later from the encoded_desc object if
+   * the proper client authorization is given tor. */
   hs_descriptor_t *desc;
 
   /** Encoded descriptor in string form. Can't be NULL. */