Skip to content

Commit f961bfb

Browse files
authored
Merge pull request #77 from epics-containers/2024-rework
fix support yaml name for lakeshore
2 parents 5054382 + 2e67d20 commit f961bfb

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/user/tutorials/generic_ioc.rst

+16-2
Original file line numberDiff line numberDiff line change
@@ -415,8 +415,22 @@ the text inside the curly braces and that interpreter has the values of
415415
all the ``definition`` arguments available in its context.
416416
See https://jinja.palletsprojects.com/en/3.0.x/templates/
417417

418-
To make a lakeshore340 YAML file, put the following contents in a file called
419-
``/workspaces/ioc-lakeshore340/ibek-support/lakeshore340/lakeshore340.yaml``:
418+
419+
.. note::
420+
421+
IMPORTANT: the file created below MUST have the suffix ``.ibek.support.yaml``.
422+
This means it is a support yaml file for ``ibek``. This is important because
423+
when ``install.sh`` calls ``ibek support generate-links`` it will look for
424+
files with this suffix and make links to them in the ``ibek-defs`` folder.
425+
426+
In turn when you run ``ibek ioc generate-schema`` it will look in the
427+
``ibek-defs`` folder for all the support definition YAML files and combine
428+
them into a single schema file.
429+
430+
To make a lakeshore340 YAML file, go to the folder
431+
``/workspaces/ioc-lakeshore340/ibek-support/lakeshore340/``
432+
and create a file called ``lakeshore340.ibek.support.yaml``. Add the following
433+
contents:
420434

421435
.. code-block:: yaml
422436

0 commit comments

Comments
 (0)