This is an automated email from the ASF dual-hosted git repository.
dmeden 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 73a668cfd1 docs: Update cmake documentation for experimental plugins.
(#11078)
73a668cfd1 is described below
commit 73a668cfd1ff3822c40472472af6473f21219681
Author: Damian Meden <[email protected]>
AuthorDate: Wed Feb 28 12:39:39 2024 +0100
docs: Update cmake documentation for experimental plugins. (#11078)
* docs: Update cmake documentation for experimental plugins.
---
doc/admin-guide/plugins/combo_handler.en.rst | 9 ++++-----
doc/admin-guide/plugins/header_freq.en.rst | 7 +++----
doc/admin-guide/plugins/icap.en.rst | 8 +++-----
doc/admin-guide/plugins/index.en.rst | 5 +----
doc/admin-guide/plugins/regex_revalidate.en.rst | 5 ++---
doc/admin-guide/plugins/stek_share.en.rst | 5 +++--
doc/admin-guide/plugins/url_sig.en.rst | 11 +++++------
doc/admin-guide/plugins/wasm.en.rst | 14 ++++++++++----
doc/developer-guide/plugins/example-plugins/index.en.rst | 6 +++---
9 files changed, 34 insertions(+), 36 deletions(-)
diff --git a/doc/admin-guide/plugins/combo_handler.en.rst
b/doc/admin-guide/plugins/combo_handler.en.rst
index 926c5188da..88103ba099 100644
--- a/doc/admin-guide/plugins/combo_handler.en.rst
+++ b/doc/admin-guide/plugins/combo_handler.en.rst
@@ -1,3 +1,4 @@
+.. include:: ../../common.defs
.. _admin-plugins-combo-handler:
Combo Handler Plugin
@@ -29,11 +30,9 @@ or Javascript files into one.
Installation
============
-This plugin is only built if the configure option ::
-
- --enable-experimental-plugins
-
-is given at build time. Note that this plugin is built and installed in
+To make this plugin available, you must enable experimental plugins when
+building |TS| by passing the ``-DBUILD_EXPERIMENTAL_PLUGINS=ON`` to the
``cmake``
+command when building. Note that this plugin is built and installed in
combination with the ESI module, since they share common code.
Configuration
diff --git a/doc/admin-guide/plugins/header_freq.en.rst
b/doc/admin-guide/plugins/header_freq.en.rst
index ad150d7b59..74761bb75b 100644
--- a/doc/admin-guide/plugins/header_freq.en.rst
+++ b/doc/admin-guide/plugins/header_freq.en.rst
@@ -38,10 +38,9 @@ writeable by the traffic_server process's user::
Installation
------------
-Since Header Frequency plugin is an expiremental plugin, |TS| must be
configured
-to build experimental plugins in order to use it::
-
- -DBUILD_EXPERIMENTAL_PLUGINS=ON
+Since Header Frequency plugin is an expiremental plugin. To make this plugin
available,
+you must enable experimental plugins when building |TS| by passing the
+``-DBUILD_EXPERIMENTAL_PLUGINS=ON`` to the ``cmake`` command when building.
Once built, add the following line to :file:`plugin.config` and restart |TS|
to use it::
diff --git a/doc/admin-guide/plugins/icap.en.rst
b/doc/admin-guide/plugins/icap.en.rst
index 02167c9d81..6bb4f95517 100644
--- a/doc/admin-guide/plugins/icap.en.rst
+++ b/doc/admin-guide/plugins/icap.en.rst
@@ -35,11 +35,9 @@ regarding the infection.
Installation
------------
-This plugin is only built if the configure option ::
-
- --enable-experimental-plugins
-
-is given at build time.
+To make this plugin available, you must enable experimental plugins when
+building |TS| by passing the ``-DBUILD_EXPERIMENTAL_PLUGINS=ON`` to the
``cmake``
+command when building.
To use this plugin, you need to compile the plugin and add the following line
in plugin.config (assuming the compiled plugin library is called
icap_plugin.so):
diff --git a/doc/admin-guide/plugins/index.en.rst
b/doc/admin-guide/plugins/index.en.rst
index 654124c298..5e33fcf722 100644
--- a/doc/admin-guide/plugins/index.en.rst
+++ b/doc/admin-guide/plugins/index.en.rst
@@ -157,11 +157,8 @@ Experimental plugins
Plugins that are considered experimental are located in the
`plugins/experimental
<https://git-wip-us.apache.org/repos/asf?p=trafficserver.git;a=tree;f=plugins/experimental;hb=HEAD>`_
directory of the |TS| source tree. Experimental plugins can be compiled by
passing the
-`--enable-experimental-plugins` option to `configure`::
+``-DBUILD_EXPERIMENTAL_PLUGINS=ON``` variable to ``cmake`` command when
building.
- $ autoconf -i
- $ ./configure --enable-experimental-plugins
- $ make
.. toctree::
:hidden:
diff --git a/doc/admin-guide/plugins/regex_revalidate.en.rst
b/doc/admin-guide/plugins/regex_revalidate.en.rst
index 6bd1513bd5..9a08cb055d 100644
--- a/doc/admin-guide/plugins/regex_revalidate.en.rst
+++ b/doc/admin-guide/plugins/regex_revalidate.en.rst
@@ -46,9 +46,8 @@ Installation
============
To make this plugin available, you must enable experimental plugins when
-building |TS|::
-
- ./configure --enable-experimental-plugins
+building |TS| by passing the ``-DBUILD_EXPERIMENTAL_PLUGINS=ON`` to the
``cmake`` command
+when building.
Configuration
=============
diff --git a/doc/admin-guide/plugins/stek_share.en.rst
b/doc/admin-guide/plugins/stek_share.en.rst
index abdd428eea..e5cfbfeff3 100644
--- a/doc/admin-guide/plugins/stek_share.en.rst
+++ b/doc/admin-guide/plugins/stek_share.en.rst
@@ -50,8 +50,9 @@ The NuRaft library must be installed for this plugin to
build. It can be specifi
This plugin also uses `YAML-CPP library <https://github.com/jbeder/yaml-cpp>`
for reading the configuration file.
The YAML-CPP library must be installed for this plugin to build. It can be
specified by the `--with-yaml-cpp` argument to configure.
-As part of the experimental plugs, the `--enable-experimental-plugins` option
must also be given to configure to build this plugin.
-
+To make this plugin available, you must enable experimental plugins when
+building |TS| by passing the ``-DBUILD_EXPERIMENTAL_PLUGINS=ON`` to the
``cmake`` command
+when building.
Config File
===========
diff --git a/doc/admin-guide/plugins/url_sig.en.rst
b/doc/admin-guide/plugins/url_sig.en.rst
index 32894dfff2..99f84b56a0 100644
--- a/doc/admin-guide/plugins/url_sig.en.rst
+++ b/doc/admin-guide/plugins/url_sig.en.rst
@@ -36,9 +36,9 @@ if there were no query string at all.
Installation
============
-To make this plugin available, you must enable experimental plugins
-
- ./configure --enable-experimental-plugins
+To make this plugin available, you must enable experimental plugins when
+building |TS| by passing the ``-DBUILD_EXPERIMENTAL_PLUGINS=ON`` to the
``cmake`` command
+when building.
Configuration
=============
@@ -300,9 +300,8 @@ active.
Example
=======
-#. Enable experimental plugins when building |TS|::
-
- ./configure --enable-experimental-plugins
+#. Enable experimental plugins when building |TS| by by passing
+ the ``-DBUILD_EXPERIMENTAL_PLUGINS=ON`` to the ``cmake`` command.
#. Generate a secrets configuration for |TS| (replacing the output location
with something appropriate to your |TS| installation)::
diff --git a/doc/admin-guide/plugins/wasm.en.rst
b/doc/admin-guide/plugins/wasm.en.rst
index f1ad0b7d4b..0e58777285 100644
--- a/doc/admin-guide/plugins/wasm.en.rst
+++ b/doc/admin-guide/plugins/wasm.en.rst
@@ -14,6 +14,9 @@
implied. See the License for the specific language governing
permissions and limitations under the License.
+
+.. include:: ../../common.defs
+
.. _admin-plugins-wasm:
@@ -101,12 +104,15 @@ Compiling the Plugin
**Configure ATS to compile with experimental plugins**
+To make this plugin available, you must enable experimental plugins when
+building |TS| by passing the ``-DBUILD_EXPERIMENTAL_PLUGINS=ON`` to the
``cmake`` command
+when building.
+
::
- autoreconf -f -i
- ./configure --enable-debug=yes --enable-experimental-plugins=yes
- make
- sudo make install
+ $ cmake ... -DCMAKE_BUILD_TYPE="Debug" -DBUILD_EXPERIMENTAL_PLUGINS=ON
+ $ cmake --build ...
+ $ sudo cmake --install ...
Examples
========
diff --git a/doc/developer-guide/plugins/example-plugins/index.en.rst
b/doc/developer-guide/plugins/example-plugins/index.en.rst
index b40c4e9562..dd9d3f8c7b 100644
--- a/doc/developer-guide/plugins/example-plugins/index.en.rst
+++ b/doc/developer-guide/plugins/example-plugins/index.en.rst
@@ -48,9 +48,9 @@ understand the following topics:
- Working with HTTP header functions
The two sample plugins discussed in this chapter are ``denylist_1.cc``
-and ``basic_auth.cc``. To build and install the example plugins use ::
-
- ./configure --enable-example-plugins
+and ``basic_auth.cc``. To make this two plugins available, you must enable
experimental plugins when
+building |TS| by passing the ``-DENABLE_EXAMPLE=ON`` to the ``cmake`` command
+when building.
when :ref:`setting the build configuration <admin-configuration-options>` for
|TS|.
