[PR] Clarify hostdb host_file.path reload timing and tip usage [trafficserver]

["bryancall (via GitHub)" <gi...@apache.org>]

bryancall opened a new pull request, #12994:
URL: https://github.com/apache/trafficserver/pull/12994

   ## Summary
   - clarify that `proxy.config.hostdb.host_file.path` is checked on the periodic host file interval, not immediately
   - include the controlling setting name and default value (`proxy.config.hostdb.host_file.interval`, default `86400` seconds)
   - add a properly formatted `.. tip::` block suggesting temporary interval reduction for faster validation
   
   ## Test plan
   - [x] Build docs locally and render the updated section
   - [x] Verify the `host_file.path` section renders the tip as a real admonition block
   - [x] Confirm no code behavior changes (docs-only update)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@trafficserver.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] Clarify hostdb host_file.path reload timing and tip usage [trafficserver]

["Copilot (via GitHub)" <gi...@apache.org>]

Copilot commented on code in PR #12994:
URL: https://github.com/apache/trafficserver/pull/12994#discussion_r2955660973


##########
doc/admin-guide/files/records.yaml.en.rst:
##########
@@ -3291,14 +3291,19 @@ HostDB
    Set the file path for an external host file.
 
    If this is set (non-empty) then the file is presumed to be a hosts file in
-   the standard .
-   It is read and the entries there added to the HostDB. The file is
-   periodically checked for a more recent modification date in which case it is
-   reloaded. The interval is set with :ts:cv:`proxy.config.hostdb.host_file.interval`.
-
-   While not technically reloadable, the value is read every time the file is
-   to be checked so that if changed the new value will be used on the next
-   check and the file will be treated as modified.
+   the standard format. It is read and the entries there are added to HostDB.
+
+   This setting is not immediately reloadable. |TS| checks
+   :ts:cv:`proxy.config.hostdb.host_file.path` during the periodic host file
+   check controlled by :ts:cv:`proxy.config.hostdb.host_file.interval`
+   (default: ``86400`` seconds). If the path value has changed, |TS| uses the
+   new path on that next check and treats the file as modified.

Review Comment:
   The phrase "not immediately reloadable" could be read as "not reloadable at all". Since the path is actually re-read from the config (and can be changed without restart) but only *applied* on the next periodic host-file check, consider rewording to explicitly state that it is dynamically reloadable but polled/applied on the next interval check (and, if appropriate, add the usual ":reloadable:" marker for this record).



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@trafficserver.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] Clarify hostdb host_file.path reload timing and tip usage [trafficserver]

["bryancall (via GitHub)" <gi...@apache.org>]

bryancall merged PR #12994:
URL: https://github.com/apache/trafficserver/pull/12994


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@trafficserver.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org