This is an automated email from the ASF dual-hosted git repository.
bneradt pushed a commit to branch 10.0.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/10.0.x by this push:
new 37b1b5eff0 Fix some doc generation warnings (#11370) (#11420)
37b1b5eff0 is described below
commit 37b1b5eff0f68d787554e5d28a1a0e9a1af3555e
Author: Brian Neradt <[email protected]>
AuthorDate: Thu Jun 6 10:03:01 2024 -0500
Fix some doc generation warnings (#11370) (#11420)
This fixes the various warnings that come from the initial phase of
reading the doc files. There are still some warnings during the writing
the output phase.
(cherry picked from commit d31a40fecb19f80ae8b7ddbb2ff0efecc57bf7f9)
Conflicts:
doc/developer-guide/api/functions/TSContScheduleEveryOnEntirePool.en.rst
doc/developer-guide/api/functions/TSContScheduleOnEntirePool.en.rst
---
doc/admin-guide/plugins/header_rewrite.en.rst | 2 +-
doc/admin-guide/plugins/txn_box/reference.en.rst | 2 +-
doc/developer-guide/api/functions/TSActionCancel.en.rst | 2 +-
doc/developer-guide/api/functions/TSContScheduleEveryOnPool.en.rst | 2 +-
doc/developer-guide/api/functions/TSContScheduleOnThread.en.rst | 2 +-
doc/developer-guide/api/functions/TSHttpTxnResponseActionSet.en.rst | 2 +-
doc/developer-guide/cripts/cripts-matcher.en.rst | 2 +-
doc/developer-guide/plugins/actions/index.en.rst | 4 ++--
8 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/doc/admin-guide/plugins/header_rewrite.en.rst
b/doc/admin-guide/plugins/header_rewrite.en.rst
index c7e34981a6..c3a4989e0d 100644
--- a/doc/admin-guide/plugins/header_rewrite.en.rst
+++ b/doc/admin-guide/plugins/header_rewrite.en.rst
@@ -1378,7 +1378,7 @@ the client where the requested data was served from.::
set-header ATS-SRVR-UUID %{ID:UNIQUE}
Apply rate limiting for some select requests
-------------------------------------
+--------------------------------------------
This rule will conditiionally, based on the client request headers, apply rate
limiting to the request.::
diff --git a/doc/admin-guide/plugins/txn_box/reference.en.rst
b/doc/admin-guide/plugins/txn_box/reference.en.rst
index 2c01a9ecf3..35e5bde1f8 100755
--- a/doc/admin-guide/plugins/txn_box/reference.en.rst
+++ b/doc/admin-guide/plugins/txn_box/reference.en.rst
@@ -33,7 +33,7 @@ Glossary
.. glossary::
:sorted:
- transaction
+ transaction (txn_box)
A :term:`request` and the corresponding :term:`response`.
request
diff --git a/doc/developer-guide/api/functions/TSActionCancel.en.rst
b/doc/developer-guide/api/functions/TSActionCancel.en.rst
index 8934710006..1f8edd0530 100644
--- a/doc/developer-guide/api/functions/TSActionCancel.en.rst
+++ b/doc/developer-guide/api/functions/TSActionCancel.en.rst
@@ -16,7 +16,7 @@
.. include:: ../../../common.defs
-.. default-domain:: c
+.. default-domain:: cpp
TSActionCancel
**************
diff --git a/doc/developer-guide/api/functions/TSContScheduleEveryOnPool.en.rst
b/doc/developer-guide/api/functions/TSContScheduleEveryOnPool.en.rst
index 0116395508..49c9d8a845 100644
--- a/doc/developer-guide/api/functions/TSContScheduleEveryOnPool.en.rst
+++ b/doc/developer-guide/api/functions/TSContScheduleEveryOnPool.en.rst
@@ -16,7 +16,7 @@
.. include:: ../../../common.defs
-.. default-domain:: c
+.. default-domain:: cpp
TSContScheduleEveryOnPool
*************************
diff --git a/doc/developer-guide/api/functions/TSContScheduleOnThread.en.rst
b/doc/developer-guide/api/functions/TSContScheduleOnThread.en.rst
index 41148a9d3a..a983777181 100644
--- a/doc/developer-guide/api/functions/TSContScheduleOnThread.en.rst
+++ b/doc/developer-guide/api/functions/TSContScheduleOnThread.en.rst
@@ -16,7 +16,7 @@
.. include:: ../../../common.defs
-.. default-domain:: c
+.. default-domain:: cpp
TSContScheduleOnThread
**********************
diff --git
a/doc/developer-guide/api/functions/TSHttpTxnResponseActionSet.en.rst
b/doc/developer-guide/api/functions/TSHttpTxnResponseActionSet.en.rst
index e7d426ea52..31dff85f5c 100644
--- a/doc/developer-guide/api/functions/TSHttpTxnResponseActionSet.en.rst
+++ b/doc/developer-guide/api/functions/TSHttpTxnResponseActionSet.en.rst
@@ -41,7 +41,7 @@ Therefore, plugins which set the ResponseAction to retry
must also un-set it after the subsequent success or failure,
or ATS will retry forever!
-The passed *action must not be null, and is copied and may be
+The passed *action* must not be null, and is copied and may be
destroyed after this call returns.
Callers must maintain owernship of action.hostname,
diff --git a/doc/developer-guide/cripts/cripts-matcher.en.rst
b/doc/developer-guide/cripts/cripts-matcher.en.rst
index 0cd5d73336..4e9b7aa8df 100644
--- a/doc/developer-guide/cripts/cripts-matcher.en.rst
+++ b/doc/developer-guide/cripts/cripts-matcher.en.rst
@@ -73,7 +73,7 @@ All matchers have the following functions:
Function Description
============================
====================================================================
``match()`` Match the given string against the matcher.
-``contains()` Another name for ``match()``
+``contains()`` Another name for ``match()``
``add()`` Add another element to the matcher (can not be
used with ``static``)
============================
====================================================================
diff --git a/doc/developer-guide/plugins/actions/index.en.rst
b/doc/developer-guide/plugins/actions/index.en.rst
index 8275caa915..841a1d4849 100644
--- a/doc/developer-guide/plugins/actions/index.en.rst
+++ b/doc/developer-guide/plugins/actions/index.en.rst
@@ -173,5 +173,5 @@ cancel the action. The following sample code implements
this:
The action functions are:
-- :c:func:`TSActionCancel`
-- :c:func:`TSActionDone`
+- :cpp:func:`TSActionCancel`
+- :cpp:func:`TSActionDone`
