From 99a0b5e405a5506a98c4897745fed6ba1ac8406f Mon Sep 17 00:00:00 2001 From: Matthew Woehlke Date: Thu, 8 Jan 2026 15:19:28 -0500 Subject: [PATCH] Clarify `link_location` documentation Mark `link_location` as 'conditionally required'. Add a note clarifying that this attribute is sometimes required, and explaining when. Fixes: #100 --- schema.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/schema.rst b/schema.rst index f31d5cf..ce5a8de 100644 --- a/schema.rst +++ b/schema.rst @@ -436,6 +436,7 @@ Attribute names are case sensitive. .. cps:attribute:: link_location :type: string :context: component configuration + :conditionally-required: Specifies an alternate location of the component that should be used when linking against the component. @@ -450,6 +451,10 @@ Attribute names are case sensitive. (see `Package Searching`_). This is recommended, as it allows packages to be relocatable. + This attribute is typically required + for |component|\ s of :string:`"dylib"` :attribute:`type` + which have separate link-time and run-time artifacts. + .. ---------------------------------------------------------------------------- .. cps:attribute:: link_requires :type: list(string)