[PR #1941] [MERGED] [RUST] Document EIA-708 buffer size and remove debug logging #2739

Open
opened 2026-01-29 17:23:41 +00:00 by claunia · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/CCExtractor/ccextractor/pull/1941
Author: @Harshdhall01
Created: 12/31/2025
Status: Merged
Merged: 1/1/2026
Merged by: @cfsmp3

Base: masterHead: cleanup-rust-todos


📝 Commits (3)

  • 9ca2617 Document EIA-708 buffer size and remove debug logging
  • 868fac5 Update CHANGES.TXT with Rust documentation improvements
  • 5564aa8 Merge upstream/master and resolve CHANGES.TXT conflict

📊 Changes

3 files changed (+11 additions, -2 deletions)

View changed files

📝 docs/CHANGES.TXT (+6 -0)
📝 src/rust/lib_ccxr/src/common/constants.rs (+5 -1)
📝 src/rust/lib_ccxr/src/net/target.rs (+0 -1)

📄 Description

Summary

Addresses two TODO items in the Rust codebase:

  1. Document EIA_708_BUFFER_LENGTH: Added proper documentation explaining the buffer size choice
  2. Remove debug print: Removed unnecessary debug logging from target.rs

Changes

constants.rs (Line ~150)

  • Replaced TODO comment with detailed documentation
  • Explains that 2048 bytes is 16x the CEA-708 spec minimum (128 bytes)
  • Added reference to CEA-708-E Section 8.4.3

target.rs (Line ~85)

  • Removed debug logging of target address as requested by TODO

Research

According to CEA-708-E specification Section 8.4.3, the minimum Service Input Buffer size is 128 bytes. CCExtractor uses 2048 bytes (16x larger) to provide adequate safety margin for buffer management.

Testing

Changes are documentation and debug cleanup only
No functional/logic changes
CI will verify build compatibility

Part of ongoing Rust codebase cleanup effort to resolve TODO items.


In raising this pull request, I confirm the following:

  • I have read and understood the contributors guide.
  • I have checked that another pull request for this purpose does not exist.
  • I have considered, and confirmed that this submission will be valuable to others.
  • I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  • I give this submission freely, and claim no ownership to its content.
  • I have mentioned this change in the changelog.

My familiarity with the project:

  • I have never used CCExtractor.
  • I have used CCExtractor just a couple of times.
  • I absolutely love CCExtractor, but have not contributed previously.
  • I am an active contributor to CCExtractor.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/CCExtractor/ccextractor/pull/1941 **Author:** [@Harshdhall01](https://github.com/Harshdhall01) **Created:** 12/31/2025 **Status:** ✅ Merged **Merged:** 1/1/2026 **Merged by:** [@cfsmp3](https://github.com/cfsmp3) **Base:** `master` ← **Head:** `cleanup-rust-todos` --- ### 📝 Commits (3) - [`9ca2617`](https://github.com/CCExtractor/ccextractor/commit/9ca26171d6f691ef52a65395c633e5fa8a47d4c8) Document EIA-708 buffer size and remove debug logging - [`868fac5`](https://github.com/CCExtractor/ccextractor/commit/868fac5423716396684b977d42db37ba55141dc0) Update CHANGES.TXT with Rust documentation improvements - [`5564aa8`](https://github.com/CCExtractor/ccextractor/commit/5564aa8a545c6912106b3ed0b61989f2b8aa8bf7) Merge upstream/master and resolve CHANGES.TXT conflict ### 📊 Changes **3 files changed** (+11 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `docs/CHANGES.TXT` (+6 -0) 📝 `src/rust/lib_ccxr/src/common/constants.rs` (+5 -1) 📝 `src/rust/lib_ccxr/src/net/target.rs` (+0 -1) </details> ### 📄 Description ## Summary Addresses two TODO items in the Rust codebase: 1. **Document EIA_708_BUFFER_LENGTH**: Added proper documentation explaining the buffer size choice 2. **Remove debug print**: Removed unnecessary debug logging from target.rs ## Changes ### constants.rs (Line ~150) - Replaced TODO comment with detailed documentation - Explains that 2048 bytes is 16x the CEA-708 spec minimum (128 bytes) - Added reference to CEA-708-E Section 8.4.3 ### target.rs (Line ~85) - Removed debug logging of target address as requested by TODO ## Research According to CEA-708-E specification Section 8.4.3, the minimum Service Input Buffer size is 128 bytes. CCExtractor uses 2048 bytes (16x larger) to provide adequate safety margin for buffer management. ## Testing ✅ Changes are documentation and debug cleanup only ✅ No functional/logic changes ✅ CI will verify build compatibility ## Related Part of ongoing Rust codebase cleanup effort to resolve TODO items. --- **In raising this pull request, I confirm the following:** - [x] I have read and understood the [contributors guide](https://github.com/CCExtractor/ccextractor/blob/master/.github/CONTRIBUTING.md). - [x] I have checked that another pull request for this purpose does not exist. - [x] I have considered, and confirmed that this submission will be valuable to others. - [x] I accept that this submission may not be used, and the pull request closed at the will of the maintainer. - [x] I give this submission freely, and claim no ownership to its content. - [x] I have mentioned this change in the [changelog](https://github.com/CCExtractor/ccextractor/blob/master/docs/CHANGES.TXT). **My familiarity with the project:** - [ ] I have never used CCExtractor. - [ ] I have used CCExtractor just a couple of times. - [ ] I absolutely love CCExtractor, but have not contributed previously. - [x] I am an active contributor to CCExtractor. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-29 17:23:41 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/ccextractor#2739