Skip to content

docs: add call condition note for TSUrlHostGet#13313

Open
mmustafasenoglu wants to merge 2 commits into
apache:masterfrom
mmustafasenoglu:docs-tsurlhostget-condition
Open

docs: add call condition note for TSUrlHostGet#13313
mmustafasenoglu wants to merge 2 commits into
apache:masterfrom
mmustafasenoglu:docs-tsurlhostget-condition

Conversation

@mmustafasenoglu

Copy link
Copy Markdown

Summary

Add a note to the TSUrlHostGet documentation indicating that it should only be called after TS_HTTP_POST_REMAP_HOOK.

Changes

  • Added a note explaining that TSUrlHostGet should only be called after TS_HTTP_POST_REMAP_HOOK
  • For earlier hooks like TS_HTTP_READ_REQUEST_HDR_HOOK, TSHttpHdrHostGet should be used instead

Why

Without this note, developers may try to use TSUrlHostGet in hook phases where it won't work correctly, leading to unexpected behavior.

Fixes #5742

Add a note to the TSUrlHostGet documentation indicating that it should
only be called after TS_HTTP_POST_REMAP_HOOK. For earlier hooks like
TS_HTTP_READ_REQUEST_HDR_HOOK, TSHttpHdrHostGet should be used instead.

Fixes apache#5742
@mmustafasenoglu

Copy link
Copy Markdown
Author

Hello! This is my first contribution to Apache Traffic Server. Could you please trigger CI for this documentation PR? Thank you!

@JosiahWI

Copy link
Copy Markdown
Contributor

[approve ci]

@JosiahWI

Copy link
Copy Markdown
Contributor

@bneradt The Docs job failed due to warnings (warnings are treated as errors), but the warnings I found were related to env files. I'm not sure what the issue was. Could you take a look?

@bneradt

bneradt commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

From the docs build:

reading sources... [100%] release-notes/whats-new.en
/home/jenkins/workspace/Github_Builds/docs/src/doc/developer-guide/api/functions/TSUrlHostGet.en.rst:77: ERROR: Unknown interpreted text role "data". [docutils]
/home/jenkins/workspace/Github_Builds/docs/src/doc/developer-guide/api/functions/TSUrlHostGet.en.rst:77: ERROR: Unknown interpreted text role "data". [docutils]
looking for now-outdated files... none found
...
copying images... [100%] release-notes/images/roadmap.png
dumping search index in English (code: en)... done
dumping object inventory... done
build finished with problems, 2 warnings (with warnings treated as errors).
ninja: build stopped: subcommand failed.

@mmustafasenoglu

Copy link
Copy Markdown
Author

Hi, just checking in on this docs PR. It adds a call condition note for TSUrlHostGet. Would appreciate a review when you have time. Thanks!

@bneradt

bneradt commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Hi, just checking in on this docs PR. It adds a call condition note for TSUrlHostGet. Would appreciate a review when you have time. Thanks!

Thank you for contributing, however you likely won't get a review until the docs build passes. Please see my previous comment showing the failure output.

Replace :data: with double backticks for hook names, consistent
with the rest of the documentation.

Fixes apache#5742
@mmustafasenoglu

Copy link
Copy Markdown
Author

Hi @bneradt, I've fixed the :data role error by replacing it with double backticks for the hook names. Could you please trigger CI again? Thanks!

@JosiahWI

Copy link
Copy Markdown
Contributor

@mmustafasenoglu Once you are authorized to start Jenkins jobs (@bneradt added you to the whitelist) they will start automatically when you open a PR or push to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a call condition for TSUrlHostGet to the document

3 participants