Skip to content

Fix Ethernet Samples and docs#334

Merged
KonradBreitsprecherBkd merged 5 commits into
mainfrom
dev/fix-eth-samples
Jun 11, 2026
Merged

Fix Ethernet Samples and docs#334
KonradBreitsprecherBkd merged 5 commits into
mainfrom
dev/fix-eth-samples

Conversation

@KonradBreitsprecherBkd

@KonradBreitsprecherBkd KonradBreitsprecherBkd commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Based on #333, this PR fixes documentation and sample inconsistencies in Ethernet docs/code samples.

Changes

  • Removed duplicate frameCheckSequence declaration in docs/code-samples/eth/ETH_Sender_Receiver.cpp.
  • Fix frame construction and usercontext
  • Fixed inconsistent variable names in docs/code-samples/eth/ETH_Erroneous_Transmissions.cpp:
    • ethernetFrame -> frame
    • invalidEthernetFrame -> invalidFrame
  • Aligned related handler wording in ETH_Erroneous_Transmissions.cpp to FrameTransmitHandler.
  • Updated docs/api/services/ethernet.rst to remove outdated transmitId wording for EthernetFrameEvent and describe correlation via userContext.

Signed-off-by: Konrad Breitsprecher <Konrad.Breitsprecher@vector.com>
@KonradBreitsprecherBkd KonradBreitsprecherBkd added the needs reviewer This issue is looking for a reviewer. label Jun 9, 2026

@MariusBgm MariusBgm left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

the ethernetframe needs to be constructed in a vector, EthernetFrame.frame is only a Span

Comment thread docs/code-samples/eth/ETH_Erroneous_Transmissions.cpp Outdated
Comment thread docs/code-samples/eth/ETH_Sender_Receiver.cpp Outdated
KonradBreitsprecherBkd and others added 4 commits June 9, 2026 15:11
Co-authored-by: Marius Börschig <marius.boerschig@vector.com>
Signed-off-by: KonradBreitsprecherBkd <117755498+KonradBreitsprecherBkd@users.noreply.github.com>
Co-authored-by: Marius Börschig <marius.boerschig@vector.com>
Signed-off-by: KonradBreitsprecherBkd <117755498+KonradBreitsprecherBkd@users.noreply.github.com>
Signed-off-by: KonradBreitsprecherBkd <117755498+KonradBreitsprecherBkd@users.noreply.github.com>
Signed-off-by: Konrad Breitsprecher <Konrad.Breitsprecher@vector.com>
@KonradBreitsprecherBkd KonradBreitsprecherBkd removed the needs reviewer This issue is looking for a reviewer. label Jun 10, 2026
@KonradBreitsprecherBkd KonradBreitsprecherBkd merged commit b743b7b into main Jun 11, 2026
15 checks passed
@KonradBreitsprecherBkd KonradBreitsprecherBkd deleted the dev/fix-eth-samples branch June 11, 2026 08:58
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