[trafficserver] branch master updated: [Doc] Fix build warnings (#7391)

[bn...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

bneradt pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/master by this push:
     new 77714f2  [Doc] Fix build warnings (#7391)
77714f2 is described below

commit 77714f253f3a3ab4ce39877da52e14b6270f6868
Author: Damian Meden <da...@gmail.com>
AuthorDate: Tue Dec 15 20:46:29 2020 +0000

    [Doc] Fix build warnings (#7391)
---
 doc/conf.py                                        |  3 ++
 .../api/functions/TSMgmtDataTypeGet.en.rst         |  2 +-
 doc/developer-guide/api/functions/TSTypes.en.rst   | 39 +++++++++++++++++++++-
 3 files changed, 42 insertions(+), 2 deletions(-)

diff --git a/doc/conf.py b/doc/conf.py
index c9b57a6..4bc2b91 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -179,6 +179,9 @@ nitpick_ignore = [('c:type', 'int64_t'),
                   ('cpp:identifier', 'F'),  # template arg
                   ('cpp:identifier', 'Args'),  # variadic template arg
                   ('cpp:identifier', 'Rest'),  # variadic template arg
+                  ('c:type', 'uint64_t'),
+                  ('c:type', 'uint8_t'),
+                  ('c:type', 'int32_t')
                   ]
 
 # Autolink issue references.
diff --git a/doc/developer-guide/api/functions/TSMgmtDataTypeGet.en.rst b/doc/developer-guide/api/functions/TSMgmtDataTypeGet.en.rst
index 2687078..04e89aa 100644
--- a/doc/developer-guide/api/functions/TSMgmtDataTypeGet.en.rst
+++ b/doc/developer-guide/api/functions/TSMgmtDataTypeGet.en.rst
@@ -19,7 +19,7 @@
 .. default-domain:: c
 
 TSMgmtDataTypeGet
-*************
+*****************
 
 Synopsis
 ========
diff --git a/doc/developer-guide/api/functions/TSTypes.en.rst b/doc/developer-guide/api/functions/TSTypes.en.rst
index 9e5a16a..eb35f77 100644
--- a/doc/developer-guide/api/functions/TSTypes.en.rst
+++ b/doc/developer-guide/api/functions/TSTypes.en.rst
@@ -275,4 +275,41 @@ more widely. Those are described on this page.
 
 .. type:: TSFetchUrlParams_t
 .. type:: TSFetchSM
-.. type:: TSFetchEvent
\ No newline at end of file
+.. type:: TSFetchEvent
+
+.. type:: TSHttpPriority
+
+   The abstract type of the various HTTP priority implementations.
+
+   .. member:: uint8_t priority_type
+
+      The reference to the concrete HTTP priority implementation. This will be
+      a value from TSHttpPriorityType
+
+   .. member:: uint8_t data[7]
+
+      The space allocated for the concrete priority implementation.
+
+      Note that this has to take padding into account. There is a static_assert
+      in ``InkAPI.cc`` to verify that :type:`TSHttpPriority` is at least as large as
+      :type:`TSHttp2Priority`. As other structures are added that are represented by
+      :type:`TSHttpPriority` add more static_asserts to verify that :type:`TSHttpPriority` is as
+      large as it needs to be.
+
+
+.. type:: TSHttp2Priority
+
+   A structure for HTTP/2 priority. For an explanation of these terms with respect
+   to HTTP/2, see RFC 7540, section 5.3.
+
+   .. member:: uint8_t priority_type
+
+      HTTP_PROTOCOL_TYPE_HTTP_2
+
+   .. member:: uint8_t weight
+
+   .. member:: int32_t stream_dependency
+
+      The stream dependency. Per spec, see RFC 7540 section 6.2, this is 31
+      bits. We use a signed 32 bit stucture to store either a valid dependency
+      or -1 if the stream has no dependency.