Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document stream-base.dbd usage when sCalcout is not needed #95

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document stream-base.dbd usage when sCalcout is not needed #95

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/setup.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h4>Support for <em>asynDriver</em></h4>
ASYN=/home/epics/asyn4-30
</pre>

<h4>Support for <em>sCalcout</em> record</h4>
<h4 id="scalcout">Support for <em>sCalcout</em> record</h4>
<p>
The <a
href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/epics-modules/calc/R3-6-1/documentation/sCalcoutRecord.html"
Expand All @@ -109,7 +109,10 @@ <h4>Support for <em>sCalcout</em> record</h4>
</p>
<p>
Support for the <em>sCalcout</em> is optional. <em>StreamDevice</em> works
as well without <em>sCalcout</em> or <em>SynApps</em>.
as well without <em>sCalcout</em> or <em>SynApps</em>. If your application does
not need this record support, you may load <kbd>stream-base.dbd</kbd> instead of
<kbd>stream.dbd</kbd>, making it optional to include <em>calc</em> as an
application dependency.
</p>

<h4>Support for regular expression matching</h4>
Expand Down Expand Up @@ -185,13 +188,14 @@ <h2>2. Building <em>StreamDevice</em></h2>
Go to the <em>StreamDevice</em> directory
and run <code>make</code> (or <code>gmake</code>).
This will create and install the <em>stream</em> library and the
<kbd>stream.dbd</kbd> file and an example IOC application.
<em>StreamDevice</em> database definition files and an example IOC application.
</p>

<p>
To use <em>StreamDevice</em>, your own application must be built with the
<em>stream</em> and <em>asyn</em> (and optionally <em>pcre</em>) libraries
and must load <kbd>asyn.dbd</kbd> and <kbd>stream.dbd</kbd>.
and must load <kbd>asyn.dbd</kbd> and <kbd>stream.dbd</kbd> (or alternatively
<kbd>stream-base.dbd</kbd>; see <a href="#scalcout">Support for sCalcout record</a>).
</p>
<p>
Include the following lines in your application <kbd>Makefile</kbd>:
Expand Down