fix(linux): Split CSI2RX documentation into platform-specific files#645
Open
Rishikesh-D wants to merge 1 commit intoTexasInstruments:masterfrom
Open
fix(linux): Split CSI2RX documentation into platform-specific files#645Rishikesh-D wants to merge 1 commit intoTexasInstruments:masterfrom
Rishikesh-D wants to merge 1 commit intoTexasInstruments:masterfrom
Conversation
Refactor the CSI documentation to have a per platform file. This improves the maintainability and organization by separating platform-specific content from common documentation The monolithic CSI2RX.rst file has been split into: - CSI2RX_common.rst: Shared introduction, architecture, driver details, and usage instructions - CSI2RX_AM62X.rst: AM62X-specific testing details and sensor information - CSI2RX_AM62PX.rst: AM62PX-specific content including V3Link support and mosaic pipelines - CSI2RX_AM62AX.rst: AM62AX-specific FPDLink camera support and ISP pipelines - CSI2RX_J721E.rst: J721E platform-specific details - CSI2RX_J721S2.rst: J721S2 platform-specific details - CSI2RX_J722S.rst: J722S platform-specific details - CSI2RX_J784S4.rst: J784S4 platform-specific details Signed-off-by: Rishikesh Donadkar <r-donadkar@ti.com>
Rishikesh-D
requested review from
StaticRocket,
VeeruPrudhvi,
cshilwant,
gehariprasath,
jeevantelukula,
praneethbajjuri and
uditkumarti
as code owners
github-actions
bot
assigned
devarsht,
gehariprasath,
praneethbajjuri,
r-vignesh and
uditkumarti
|
New issues found with check_toc_txt.py: |
StaticRocket
requested changes
Apr 6, 2026
Comment on lines
3
to
+5
| .. ifconfig:: CONFIG_part_variant in ('AM62X') | ||
|
|
||
| CSI2RX testing details | ||
| ====================== | ||
|
|
||
| Following sensors have been tested with the latest SDK. | ||
|
|
||
| .. csv-table:: Sensor | ||
| :header: "Sensor","Media Bus Format","Video Format","Resolution" | ||
|
|
||
| "IMX219 RPi Camera","MEDIA_BUS_FMT_SRGGB8_1X8","V4L2_PIX_FMT_SRGGB8","1920x1080" | ||
| "OV5640 MIPI CSI Camera","MEDIA_BUS_FMT_YUYV8_1X16","V4L2_PIX_FMT_YUYV","640x480" | ||
|
|
||
| .. include:: CSI2RX_AM62X.rst |
Member
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment.
@StaticRocket , are you concerned about the section headings getting evaluated in the first processing pass and getting registered globally which will create conflicts in the ref engine?
Contributor
Author
There was a problem hiding this comment.
I don't see such thing happening, as a diff comparison of the output before and after this refactoring shows exact same results. Please let me know if I am missing something.
Member
There was a problem hiding this comment.
Yeah, the diff wouldn't change because it was incorrect to begin with. If you pay attention to the permalinks between different DEVFAMILY types you'll see the issue. You should have also explicitly seen the following warning hinting at this behavior:
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX_AM62PX.rst:1: WARNING: Duplicate explicit target name: "enabling-camera-sensors". [docutils]
Member
|
You split everything up into nice logical sections, why would you want to merge it all back to a single page for the reader anyway? |
Member
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refactor the CSI documentation to have a per platform file. This improves the maintainability and organization by separating platform-specific content from common documentation
The monolithic CSI2RX.rst file has been split into:
Testing: A diff comparison of these files before and after refactoring showed no differences.