⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

Conversation

@StaticRocket
Copy link
Member

Replace these 1 line include files with a TOC tree pointer to the primary file. This can help with switching between distro builds as the path of common files no longer changes.

We currently have 2 different mechanisms to complicate things. One is the TOC tree, the other is arbitrary includes. Modifying the TOC tree is a little hard to parse ahead of time, but it results in a lower likelihood of accidentally creating duplicate content. Using includes results in more files and a deeper file chain you need to parse, but it is clearer ahead of time what is occurring.

I'm in favor of using the TOC tree since that's where a lot of complexity already resides.

Replace these 1 line include files with a TOC tree pointer to the
primary file. This can help with switching between distro builds as the
path of common files no longer changes.

We currently have 2 different mechanisms to complicate things. One is
the TOC tree, the other is arbitrary includes. Modifying the TOC tree is
a little hard to parse ahead of time, but it results in a lower
likelihood of accidentally creating duplicate content. Using includes
results in more files and a deeper file chain you need to parse, but it
is clearer ahead of time what is occurring.

I'm in favor of using the TOC tree since that's where a lot of
complexity already resides.

Signed-off-by: Randolph Sapp <[email protected]>
@github-actions
Copy link

New warnings found with rstcheck:

source/common/How_to_Guides/TMDX654_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
source/common/How_to_Guides/TMDX654_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/common/How_to_Guides/TMDX654_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/common/How_to_Guides/TMDX654_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "6" (ordinal 6)
source/common/How_to_Guides/TMDX654_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/common/How_to_Guides/TMDX654_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/common/How_to_Guides/TMDX654_EVM_Hardware_Setup.rst:564: (ERROR/3) Error in "code-block" directive:
source/common/How_to_Guides/TMDX654_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/common/How_to_Guides/J742S2_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
source/common/How_to_Guides/J742S2_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/common/How_to_Guides/J742S2_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "8" (ordinal 8)
source/common/How_to_Guides/J721S2_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
source/common/How_to_Guides/J721S2_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/common/How_to_Guides/J721S2_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "8" (ordinal 8)
source/common/How_to_Guides/J784S4_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
source/common/How_to_Guides/J784S4_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/common/How_to_Guides/J784S4_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "8" (ordinal 8)
source/common/How_to_Guides/J721E_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/common/How_to_Guides/J721E_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
source/common/How_to_Guides/J721E_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/common/How_to_Guides/J721E_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "8" (ordinal 8)
source/common/How_to_Guides/J7200_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/common/How_to_Guides/J7200_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
source/common/How_to_Guides/J7200_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/common/How_to_Guides/J7200_EVM_Hardware_Setup.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "8" (ordinal 8)

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.

1 participant