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

[RFCs] Add Flow Graph try_put_and_wait RFC #1513

Open
wants to merge 38 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
e8aa05b
Add rfcs directory
vossmjp Aug 1, 2024
9e6b4ce
Removed deprecated as cause for archive
vossmjp Aug 5, 2024
6b819a3
Update rfcs/README.md
vossmjp Aug 16, 2024
0bc4bba
Update rfcs/README.md
vossmjp Aug 16, 2024
7e0de37
Update rfcs/README.md
vossmjp Aug 16, 2024
6eddaa5
Update rfcs/template.md
vossmjp Aug 16, 2024
f8d7709
Update rfcs/experimental/README.md
vossmjp Aug 16, 2024
86c7031
Update rfcs/template.md
vossmjp Aug 16, 2024
60e7623
Update rfcs/template.md
vossmjp Aug 16, 2024
d70a09a
Update rfcs/README.md
vossmjp Sep 3, 2024
640ee5d
Update rfcs/README.md
vossmjp Sep 3, 2024
ac8e085
Update rfcs/README.md
vossmjp Sep 3, 2024
2076670
Update rfcs/README.md
vossmjp Sep 3, 2024
d329f70
Update rfcs/README.md
vossmjp Sep 3, 2024
06fd104
Update rfcs/template.md
vossmjp Sep 3, 2024
758959a
Update rfcs/template.md
vossmjp Sep 3, 2024
068c26e
Update rfcs/template.md
vossmjp Sep 3, 2024
4d67b5b
Update rfcs/template.md
vossmjp Sep 3, 2024
446927b
Update rfcs/template.md
vossmjp Sep 3, 2024
e449916
Made wording changes in response to review.
vossmjp Sep 3, 2024
ad8ee51
Update rfcs/README.md
vossmjp Sep 3, 2024
5431310
Update rfcs/README.md
vossmjp Sep 3, 2024
6f309e0
Update rfcs/README.md
vossmjp Sep 3, 2024
fd42065
Update rfcs/README.md
vossmjp Sep 3, 2024
344688e
Update rfcs/README.md
vossmjp Sep 3, 2024
074a1e2
Update rfcs/README.md
vossmjp Sep 3, 2024
d407d0c
Update rfcs/README.md
vossmjp Sep 3, 2024
207f07d
Update rfcs/README.md
vossmjp Sep 3, 2024
62d9188
Apply suggestions from code review
vossmjp Sep 3, 2024
30c06ca
Fixed line lengths and made suggested changes after review
vossmjp Sep 3, 2024
93a5a81
Add RFC draft
kboyarinov Sep 11, 2024
8c29592
Add try_put_and_wait RFC
kboyarinov Sep 13, 2024
23f859e
Merge remote-tracking branch 'origin/master' into dev/kboyarinov/try_…
kboyarinov Jan 6, 2025
9abea43
Remove whitespace changes
kboyarinov Jan 6, 2025
ecd4e83
Fix spelling, add information about multi-output nodes support
kboyarinov Jan 6, 2025
4c5b788
Try newline in tables
kboyarinov Feb 24, 2025
513786c
Rework the document
kboyarinov Feb 24, 2025
c566362
Merge remote-tracking branch 'origin/master' into dev/kboyarinov/try_…
kboyarinov Feb 24, 2025
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
Prev Previous commit
Next Next commit
Made wording changes in response to review.
vossmjp committed Sep 3, 2024
commit e449916077f7f3a3a77eff901b52bab39de0991c
30 changes: 19 additions & 11 deletions rfcs/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# oneTBB Design Documents/RFCs

The purpose of the RFC process is to communicate the intent to make
library-wide changes, get feedback prior to the actual implementation,
increase the transparency on why and how decisions are made, and improve
the alignment between different teams involved in oneTBB development.
The RFC process intends to:

- Communicate library-wide changes
- Collect feedback before implementation
- Increase transparency in decision-making
- Align different teams involved in oneTBB development

This directory contains design documents (RFCs) approved
for implementation in oneTBB.
or rejected for implementation in oneTBB.

The possible RFC states are:

@@ -41,24 +43,29 @@ updated with additional information.
A proposal that is subsequently implemented and released in oneTBB
as a preview feature will be moved to the `rfcs/experimental` folder. The
RFC for a preview feature in `rfcs/experimental` should include a description
of what is required to move from experimental to fully supported -- for example, feedback from users, demonstrated performance improvements, etc.
of what is required to move from experimental to fully supported -- for
example, feedback from users, demonstrated performance improvements, etc.

A proposal that is implemented, added to the oneTBB specification, and
supported as a full feature appears in the `rfcs/supported` directory. An RFC for a fully supported feature in the `rfcs/supported` directory should
supported as a full feature appears in the `rfcs/supported` directory. An RFC
for a fully supported feature in the `rfcs/supported` directory should
have a link to the section in the oneTBB specification that has its
formal wording.

A feature that is deprecated or removed or a proposal that is abandoned may be moved to the `rfcs/archived` folder.
A feature that is removed or a proposal that is abandoned or rejected will
be moved to the `rfcs/archived` folder.

## Document Style

The design documents are stored in the `rfcs` directory.

- Each RFC is stored in a separate subdirectory
`rfcs/proposed/<feature>_<extension_description>`
- There must be a `README.md` file that contains the main RFC itself (or links to a file that contains it in the same directory).
- There must be a `README.md` file that contains the main RFC itself (or
links to a file that contains it in the same directory).
- The body of the RFC should be based on [template.md](template.md)
- The directory can contain other supporting files, such as images, tex formulas, and sub-proposals / sub-RFCs.
- The directory can contain other supporting files, such as images, tex
formulas, and sub-proposals / sub-RFCs.
- It is not required to use the markdown file format based on the exact
template file for writing RFCs. However, it is strongly recommended to use
text-based file format that can be rendered by GitHub to allow for easy
@@ -67,4 +74,5 @@ The design documents are stored in the `rfcs` directory.
- If the RFC is written in markdown. The width of the text should be limited by
80 symbols, unless there is a need to violate this rule, e.g. because of
long links or wide tables.
- It is also recommended to read through existing RFCs to better understand the general writing style and required elements.
- It is also recommended to read through existing RFCs to better understand the
general writing style and required elements.
5 changes: 3 additions & 2 deletions rfcs/archived/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Archived Design Documents

Documents may appear in the `rfcs/archived` directory for one of
three reasons:
two reasons:

1. The document describes a feature or extension that has been deprecated and then removed.
1. The document describes a feature or extension that has been deprecated and
then removed.
2. The document describes a feature or extension that was proposed but did
not (ultimately) become a fully support feature.