Skip to content

Commit

Permalink
docs: More :: less ===
Browse files Browse the repository at this point in the history
Feeback from Hansu.
  • Loading branch information
smoe authored and hansu committed Sep 2, 2024
1 parent 7b20bd1 commit 6f0dcaf
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 27 deletions.
2 changes: 1 addition & 1 deletion debian/control.top.in
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Build-Depends:
Build-Depends-Indep:
@DOC_DEPENDS@,
Build-Conflicts: libjpeg8-dev, libtiff4-dev
Standards-Version: 4.6.1
Standards-Version: 4.7.0
Homepage: https://linuxcnc.org/
Vcs-Browser: https://github.com/LinuxCNC/linuxcnc
Vcs-Git: https://github.com/LinuxCNC/linuxcnc.git
Expand Down
49 changes: 23 additions & 26 deletions docs/src/man/man3/hal_stream.3hal.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ hal_stream - non-blocking realtime streams

== SYNOPSIS

....
[source,c]
----
#include <hal.h>
int hal_stream_create(hal_stream_t* stream, int comp_id, int key, int depth, const char* typestring);
void hal_stream_destroy(hal_stream_t* stream);
Expand All @@ -30,7 +31,7 @@ bool hal_stream_writable(hal_stream_t* stream);
void hal_stream_wait_writable(hal_stream_t* stream, sig_atomic_t* stop);
void hal_stream_wait_readable(hal_stream_t* stream, sig_atomic_t* stop);
#endif
....
----

== DESCRIPTION

Expand All @@ -46,30 +47,26 @@ The non-realtime part can be *halstreamer* or *halsampler*.
In the case of *halstreamer* the key is 0x48535430 plus the channel number.
In the case of *halsampler* the key is 0x48534130 plus the channel number.

=== *hal_stream_create*

Create the given stream, initializing the _stream_ which is passed by reference.
It is an undiagnosed error if a stream has already been created with the same _key_.

=== *hal_stream_destroy*

Destroy the given stream. It is an undiagnosed error if the stream is
still attached by another component. It is an undiagnosed error if the
stream was attached with *hal_stream_attach* rather than created with
*hal_stream_create*. It is an undiagnosed error if the call to
*hal_stream_destroy* is omitted.

=== *hal_stream_attach*

Attach the given stream, which was already created by *hal_stream_create*.
If the typestring is specified, this call fails if it does not match the typestring the stream was created with.
If the typestring argument is NULL, then any typestring is accepted.

=== *hal_stream_detach*

Detach the given stream. It is an undiagnosed error if the stream was
created with *hal_stream_create* rather than attached with *hal_stream_attach*.
It is an undiagnosed error if the call to *hal_stream_detach* is omitted.
*hal_stream_create*::
Create the given stream, initializing the _stream_ which is passed by reference.
It is an undiagnosed error if a stream has already been created with the same _key_.

*hal_stream_destroy*::
Destroy the given stream. It is an undiagnosed error if the stream is
still attached by another component. It is an undiagnosed error if the
stream was attached with *hal_stream_attach* rather than created with
*hal_stream_create*. It is an undiagnosed error if the call to
*hal_stream_destroy* is omitted.

*hal_stream_attach*::
Attach the given stream, which was already created by *hal_stream_create*.
If the typestring is specified, this call fails if it does not match the typestring the stream was created with.
If the typestring argument is NULL, then any typestring is accepted.

*hal_stream_detach*::
Detach the given stream. It is an undiagnosed error if the stream was
created with *hal_stream_create* rather than attached with *hal_stream_attach*.
It is an undiagnosed error if the call to *hal_stream_detach* is omitted.

*hal_stream_element_count*:: Returns the number of pins.

Expand Down

0 comments on commit 6f0dcaf

Please sign in to comment.