EvergreenCrypto/docker-finance
1
1
Fork 1
Code Issues 31 Pull Requests Actions Releases 10 Activity

container: root: plugin: common: fix docs (custom plugin location)

Browse Source 
`DOCKER_FINANCE_CLIENT_PLUGINS` is bind-mounted to
`DOCKER_FINANCE_CONTAINER_PLUGINS` and docs must reflect container view.
This commit is contained in:
Aaron Fiore
2026-02-18 16:37:17 -08:00
parent 699c838214
commit 96964b4372
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
container/src/root/plugin/common/utility.hh
View File

@@ -141,7 +141,7 @@ class Plugin final
//! //!
//! Will 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). //! 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: //! Will load:
//! //!
//!   `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n //!   `${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: //! 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 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 //! \warning
//! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n //! 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: //! 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). //! 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: //! Will load both:
//! //!
//!   ${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc\n //!   ${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 //! \warning
//! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n //! 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<std::string>& paths)
//! //!
//! Will unload: //! Will unload:
//! //!
//! &emsp; ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc //! &emsp; ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc
//! //!
//! and pass `using bar = char; bar b;` to the plugin's unloader (plugin-implementation defined). //! 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: //! Will unload:
//! //!
//! &emsp; `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n //! &emsp; `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n
//! &emsp; `${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc` //! &emsp; `${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc`
//! //!
//! And pass plugin-implementation defined auto-unloader arguments: //! And pass plugin-implementation defined auto-unloader arguments:
//! //!
//! &emsp; `using foo = int; foo f;` for `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n //! &emsp; `using foo = int; foo f;` for `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n
//! &emsp; `using bar = char; bar b;` for `${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc` //! &emsp; `using bar = char; bar b;` for `${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc`
//! //!
//! \warning //! \warning
//! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n //! 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: //! Will unload:
//! //!
//! &emsp; ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc //! &emsp; ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc
//! //!
//! and pass `using bar = char; bar b;` to the plugin's unloader (plugin-implementation defined). //! 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: //! Will unload both:
//! //!
//! &emsp; ${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc\n //! &emsp; ${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc\n
//! &emsp; ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc //! &emsp; ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc
//! //!
//! \warning //! \warning
//! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n //! 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: //! Will reload:
//! //!
//! &emsp; `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n //! &emsp; `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n
//! &emsp; `${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc` //! &emsp; `${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc`
//! //!
//! And pass plugin-implementation defined auto-loader arguments: //! And pass plugin-implementation defined auto-loader arguments:
//! //!
//! &emsp; `using foo = int; foo f;` for `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n //! &emsp; `using foo = int; foo f;` for `${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc`\n
//! &emsp; `using bar = char; bar b;` for `${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc` //! &emsp; `using bar = char; bar b;` for `${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc`
//! //!
//! \warning //! \warning
//! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n //! 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: //! Will reload:
//! //!
//! &emsp; ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc //! &emsp; ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc
//! //!
//! and pass `using bar = char; bar b;` to the plugin's auto-unloader (plugin-implementation defined). //! 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: //! Will reload both:
//! //!
//! &emsp; ${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc\n //! &emsp; ${DOCKER_FINANCE_CONTAINER_REPO}/plugins/root/example/example.cc\n
//! &emsp; ${DOCKER_FINANCE_CLIENT_PLUGINS}/root/example/example.cc //! &emsp; ${DOCKER_FINANCE_CONTAINER_PLUGINS}/root/example/example.cc
//! //!
//! \warning //! \warning
//! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n //! To utilize plugin auto-(un)loader functionality, the plugin's parent directory *MUST* align with the plugin's namespace\n