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.

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

Documentation for RR and Strict Queues #2223

Closed
wants to merge 66 commits into from
Closed

Conversation

csziklai
Copy link
Contributor

@csziklai csziklai commented Jul 24, 2024

This PR makes progress towards #2191 by adding documentation about round robin and strict queues. Additionally, it completes the last checkbox of #2226 by updating the documentation to use the new style of PIFOs.

@anshumanmohan
Copy link
Contributor

Whoops there's something wrong with the commit history. I think it's because you made this branch while on an old commit of main (probably because you switched from Calyx on Havarti to Calyx on your own computer after a while!) Luckily the "files changed" tab is still looking fine. But in general, before making a new branch, try to git pull the branch that you are about to leave. This gives you the latest code in your branch and avoids headache later :)

Copy link
Contributor

@anshumanmohan anshumanmohan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As described in #2226, I am requesting a broader change to this text and I'll review this PR after those changes are in! For now maybe mark this one as a draft?

@csziklai csziklai marked this pull request as draft July 26, 2024 14:39
@csziklai csziklai marked this pull request as ready for review July 30, 2024 17:49
@csziklai
Copy link
Contributor Author

Because of the same mistake I had made earlier with branching off a deleted branch, please disregard this PR and instead review #2237.

@csziklai csziklai closed this Jul 30, 2024
@csziklai csziklai deleted the queues-doc-rr-and-strict branch July 30, 2024 17:56
csziklai added a commit that referenced this pull request Aug 9, 2024
This PR makes progress towards #2226 by updating variable names and
comments to account for the fact that round robin PIFOs can make n-way
trees. Additionally, it implements a PIFO tree and a more complicated
tree (`complicated_tree.py`) using round robin and strict queues. This
accounts for the first three checkboxes of #2226. The docs have been
updated to reflect the new PIFO style in #2223. To run the relevant
tests,
```
runt -i "queues"
```

(For sdn.py, I removed the stats component stuff because I thought it
was mentioned that this wasn't important and so the new style PIFOs are
not equipped to do stats. If it needs to be there, let me know.)

---------

Co-authored-by: Anshuman Mohan <[email protected]>
csziklai added a commit that referenced this pull request Aug 9, 2024
This PR makes progress towards
#2191 by adding documentation
about round robin and strict queues. Additionally, it completes the last
checkbox of #2226 by updating the
documentation to use the new style of PIFOs. Recently, it also updates
the documentation to reflect the removal of peek (#2241). Because of a
git mistake carried forward, this PR supersedes #2223.

---------

Co-authored-by: Anshuman Mohan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants