From d936c6276b6d8e45efd87a4fc25a55b9c3ab1fce Mon Sep 17 00:00:00 2001 From: whosgonna Date: Tue, 15 Sep 2020 10:29:08 -0500 Subject: [PATCH] registrar: Update documentation - Replace all occurences of "HF" with "header field" - Replace all occurences of "HFs" with "header fields" --- src/modules/registrar/doc/registrar_admin.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/modules/registrar/doc/registrar_admin.xml b/src/modules/registrar/doc/registrar_admin.xml index e3140965d43..bb2d8f86460 100644 --- a/src/modules/registrar/doc/registrar_admin.xml +++ b/src/modules/registrar/doc/registrar_admin.xml @@ -28,7 +28,7 @@ If path support is enabled in the registrar module, a call to save(...) stores the values of the Path Header(s) along with the contact into usrloc. There are three modes regarding the reply to a REGISTER including - one or more Path HFs: + one or more Path header fields: @@ -42,7 +42,7 @@ lazy - stores the Path header and passes it back to the UAC if Path-support is indicated - by the path param in the Supported HF. + by the path param in the Supported header field. @@ -56,8 +56,8 @@ A call to lookup(...) always uses the path header if - found, and inserts it as Route HF either in front of - the first Route HF, or after the last Via HF if no + found, and inserts it as Route header field either in front of + the first Route header field, or after the last Via header field if no Route is present. It also sets the destination uri to the first Path uri, thus overwriting the received-uri, because NAT has to be handled at the outbound-proxy of @@ -131,7 +131,7 @@ <varname>default_expires</varname> (integer) If the processed message contains neither Expires - HFs nor expires contact parameters, this value + header fields nor expires contact parameters, this value will be used for newly created usrloc records. The parameter contains number of second to expire (for example use 3600 for one hour). If it is set to a lower value than the min_expires parameter @@ -1151,7 +1151,7 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0 The function processes a REGISTER message. It can add, remove or - modify location records (in usrloc) depending on Contact and Expires HFs in the + modify location records (in usrloc) depending on Contact and Expires header fields in the REGISTER message. On success and when called from the REQUEST_ROUTE, 200 OK will be returned listing all contacts that are currently in the location database. On an error, an error message will be sent with a short