Skip to content

Commit 2e5c782

Browse files
committed
make support less scary
1 parent 6886061 commit 2e5c782

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

docs/user/tutorials/deploy_example.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ running in your default domain as follows:
3030
You should see some headings and an empty list as you have not yet started an
3131
IOC Instance.
3232

33+
.. note::
34+
35+
The command ``ec`` is the epics-containers command line utilities entry
36+
point. For more information see `CLI` or try ``ec --help``.
37+
38+
3339
The following command will deploy the example IOC instance to your cluster:
3440

3541
.. code-block:: bash

docs/user/tutorials/support_module.rst

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
11
Working with Support Modules
22
=============================
33

4+
TODO: this is currently a stub with some pointers.
5+
6+
TODO: suggest that we will make a new Stream Device that will be a
7+
simple echo server. Use this to step through the process of creating a
8+
new support module.
9+
410
This is a type 3. change from the list at `ioc_change_types`.
511

612
If you are starting a new support module then the preceding tutorials
713
have covered all of the skills you will need.
814

915
To work on a new support module you will need a generic IOC project to
10-
work inside. You could choose to create two new projects, MyNewDeviceSupport
11-
and ioc-MyNewDeviceSupport, or you could create a single project which looks
12-
like a traditional EPICS Support module and merge in the files from
13-
ioc-template.
16+
work inside. You could choose to create two new projects:
17+
18+
:MyNewDeviceSupport:
19+
20+
a traditional EPICS Support module,
21+
22+
:ioc-MyNewDeviceSupport:
23+
24+
a generic IOC container definition based on ioc-template
1425

1526
Once you have created the project(s), working on the support module will
1627
look very similar to the procedures set out here `debug_generic_ioc`
1728

18-
19-
TODO: suggest that we will make a new Stream Device that will be a
20-
simple echo server. Use this to step through the process of creating a
21-
new support module.

0 commit comments

Comments
 (0)