From 4ff534495ff430e0de3ca96a7a5a7a552853dc42 Mon Sep 17 00:00:00 2001 From: David Goulet Date: Mon, 7 Nov 2016 14:03:32 -0500 Subject: hs: Document arguments of rend_data_*_create() Fixes #20567 Signed-off-by: David Goulet --- src/or/hs_common.c | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'src/or/hs_common.c') diff --git a/src/or/hs_common.c b/src/or/hs_common.c index b7ee888842..7dd97e7c7c 100644 --- a/src/or/hs_common.c +++ b/src/or/hs_common.c @@ -135,7 +135,9 @@ compute_desc_id(rend_data_t *rend_data) /* Allocate and initialize a rend_data_t object for a service using the * provided arguments. All arguments are optional (can be NULL), except from - * onion_address which MUST be set. + * onion_address which MUST be set. The pk_digest is the hash of + * the service private key. The cookie is the rendezvous cookie and + * auth_type is which authentiation this service is configured with. * * Return a valid rend_data_t pointer. This only returns a version 2 object of * rend_data_t. */ @@ -163,10 +165,11 @@ rend_data_service_create(const char *onion_address, const char *pk_digest, return rend_data; } -/* Allocate and initialize a rend_data_t object for a client request using - * the given arguments. Either an onion address or a descriptor ID is - * needed. Both can be given but only the onion address will be used to make - * the descriptor fetch. +/* Allocate and initialize a rend_data_t object for a client request using the + * given arguments. Either an onion address or a descriptor ID is needed. Both + * can be given but in this case only the onion address will be used to make + * the descriptor fetch. The cookie is the rendezvous cookie and + * auth_type is which authentiation the service is configured with. * * Return a valid rend_data_t pointer or NULL on error meaning the * descriptor IDs couldn't be computed from the given data. */ -- cgit v1.2.3-54-g00ecf