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

{FEC} Updated existing documents #855

Merged
merged 17 commits into from
Sep 10, 2019

Conversation

ethouris
Copy link
Collaborator

@ethouris ethouris commented Sep 4, 2019

((DON'T REVIEW BEFORE PARENT IS MERGED: pf-fec-core-packetfilter-api))

@ethouris ethouris requested review from stevomatthews and removed request for stevomatthews September 4, 2019 16:12
@ethouris ethouris added [docs] Area: Improvements or additions to documentation Priority: Critical Status: Review Needed Type: Enhancement Indicates new feature requests labels Sep 5, 2019
@ethouris
Copy link
Collaborator Author

ethouris commented Sep 5, 2019

BLOCKS: #856

@ethouris ethouris added this to the v1.4.0 milestone Sep 5, 2019
@@ -968,7 +968,7 @@ connection parties.

#### SRT_REJ_FILTER

The `SRTO_FILTER` option has been set differently on both connection
The `SRTO_PACKETFILTER` option has been set differently on both connection
parties (NOTE: this flag may not exist yet in this version).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
parties (NOTE: this flag may not exist yet in this version).
parties (NOTE: this flag does not exist in versions prior to 1.3.x).

docs/API.md Outdated
| --------------------- | ----- | ------- | ------ | ------ | -------- | ------- |
| `SRTO_PACKETFILTER` | 1.4.0 | pre | string | | | [...512]|

- **[SET]** - Setup the packet filter. The string must match appropriate syntax
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- **[SET]** - Setup the packet filter. The string must match appropriate syntax
- **[SET]** - Set up the packet filter. The string must match the appropriate syntax

srtcore/common.h Outdated
/// and with the statement that only the sign of the result matters.
/// That is, it returns a negative value if seq1 < seq2,
/// positive if seq1 > seq2, and zero if they are equal.
/// The only tolerable use of this function is only when you
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
/// The only tolerable use of this function is only when you
/// The only useful application of this function is when you

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'd prefer "correct application". The all other uses are not just "useless", but erroneous.

srtcore/common.h Outdated
/// That is, it returns a negative value if seq1 < seq2,
/// positive if seq1 > seq2, and zero if they are equal.
/// The only tolerable use of this function is only when you
/// compare two values and it works faster than seqoff, however
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
/// compare two values and it works faster than seqoff, however
/// compare two values and it works faster than seqoff. However

srtcore/common.h Outdated
/// The only tolerable use of this function is only when you
/// compare two values and it works faster than seqoff, however
/// the result's meaning is only in its sign. DO NOT USE THE
/// VALUE for any other purpose and its not meant to be the
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
/// VALUE for any other purpose and its not meant to be the
/// VALUE for any other purpose. It is not meant to be the

Copy link
Collaborator

@stevomatthews stevomatthews left a comment

Choose a reason for hiding this comment

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

Left some minor suggestions.

@rndi rndi merged commit b5da1ef into Haivision:master Sep 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[docs] Area: Improvements or additions to documentation Priority: Critical Type: Enhancement Indicates new feature requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants