From 96964b4372dabf91dc71ae314e7118bcffe82d1f Mon Sep 17 00:00:00 2001 From: Aaron Fiore Date: Wed, 18 Feb 2026 16:37:17 -0800 Subject: [PATCH] container: root: plugin: common: fix docs (custom plugin location) `DOCKER_FINANCE_CLIENT_PLUGINS` is bind-mounted to `DOCKER_FINANCE_CONTAINER_PLUGINS` and docs must reflect container view. --- container/src/root/plugin/common/utility.hh | 28 ++++++++++----------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/container/src/root/plugin/common/utility.hh b/container/src/root/plugin/common/utility.hh index 063cf2b..abb7512 100644 --- a/container/src/root/plugin/common/utility.hh +++ b/container/src/root/plugin/common/utility.hh @@ -141,7 +141,7 @@ class Plugin final //! //! Will load: //! -//!   ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc +//!   ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc //! //! and pass `using bar = char; bar b;` to the plugin's loader (plugin-implementation defined). //! @@ -178,12 +178,12 @@ void load(const common::PluginPath& path, const common::PluginArgs& args) //! Will load: //! //!   `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n -//!   `${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc` +//!   `${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc` //! //! And pass plugin-implementation defined auto-loader arguments: //! //!   `using foo = int; foo f;` for `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n -//!   `using bar = char; bar b;` for `${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc` +//!   `using bar = char; bar b;` for `${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc` //! //! \warning //! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n @@ -228,7 +228,7 @@ void load( //! //! Will load: //! -//!   ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc +//!   ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc //! //! and pass `using bar = char; bar b;` to the plugin's loader (plugin-implementation defined). //! @@ -260,7 +260,7 @@ void load(const std::string& path, const std::string& arg = {}) //! Will load both: //! //!   ${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc\n -//!   ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc +//!   ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc //! //! \warning //! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n @@ -306,7 +306,7 @@ void load(const std::initializer_list& paths) //! //! Will unload: //! -//!   ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc +//!   ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc //! //! and pass `using bar = char; bar b;` to the plugin's unloader (plugin-implementation defined). //! @@ -343,12 +343,12 @@ void unload(const common::PluginPath& path, const common::PluginArgs& args) //! Will unload: //! //!   `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n -//!   `${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc` +//!   `${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc` //! //! And pass plugin-implementation defined auto-unloader arguments: //! //!   `using foo = int; foo f;` for `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n -//!   `using bar = char; bar b;` for `${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc` +//!   `using bar = char; bar b;` for `${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc` //! //! \warning //! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n @@ -393,7 +393,7 @@ void unload( //! //! Will unload: //! -//!   ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc +//!   ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc //! //! and pass `using bar = char; bar b;` to the plugin's unloader (plugin-implementation defined). //! @@ -425,7 +425,7 @@ void unload(const std::string& path, const std::string& arg = {}) //! Will unload both: //! //!   ${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc\n -//!   ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc +//!   ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc //! //! \warning //! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n @@ -497,12 +497,12 @@ void reload(const common::PluginPath& path, const common::PluginArgs& args) //! Will reload: //! //!   `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n -//!   `${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc` +//!   `${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc` //! //! And pass plugin-implementation defined auto-loader arguments: //! //!   `using foo = int; foo f;` for `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n -//!   `using bar = char; bar b;` for `${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc` +//!   `using bar = char; bar b;` for `${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc` //! //! \warning //! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n @@ -547,7 +547,7 @@ void reload( //! //! Will reload: //! -//!   ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc +//!   ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc //! //! and pass `using bar = char; bar b;` to the plugin's auto-unloader (plugin-implementation defined). //! @@ -581,7 +581,7 @@ void reload( //! Will reload both: //! //!   ${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc\n -//!   ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc +//!   ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc //! //! \warning //! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n