Skip to content

docs/stdlib/fifo: document fifo stream interfaces #1475

New issue

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

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

Already on GitHub? # to your account

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

Conversation

purdeaandrei
Copy link
Contributor

Rendered document:
image

@whitequark
Copy link
Member

These interfaces are meant to be transitionary, and the FIFOs themselves should be adapted to be stream-first. However, that would require some amount of design work and an RFC.

I realize we should probably document these things as they are in the interim, but I'm going to think for a while about how we document them.

@purdeaandrei
Copy link
Contributor Author

I understand, the renamed signals look not so idiomatic.

Just... my perspective as a new user was:

  1. I read the Data streams page, including the Completed pipeline example where I saw SyncFIFOBuffered connected up as a stream
  2. I got to the FIFO page, and I saw no sign of stream interface, so my first reaction was: something's not quite right, and I had to look in the source code to figure it out.

Are the names of w_stream/r_stream likely to change for the FIFOs?
Cause if what's gonna happen is that the old single wire non-stream signals will disappear, and the fifo will only support the stream interface, then it sounds more like we should be deprecating the single wires, and documenting w_stream/r_stream.

@whitequark
Copy link
Member

Are the names of w_stream/r_stream likely to change for the FIFOs?
Cause if what's gonna happen is that the old single wire non-stream signals will disappear, and the fifo will only support the stream interface, then it sounds more like we should be deprecating the single wires, and documenting w_stream/r_stream.

I'm actually considering whether or not we should deprecate the interface entirely and make a new stream-only one. This is undecided yet.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants