Skip to content

Feature/extlinks#382

Closed
StaticRocket wants to merge 2 commits into
TexasInstruments:masterfrom
StaticRocket:feature/extlinks
Closed

Feature/extlinks#382
StaticRocket wants to merge 2 commits into
TexasInstruments:masterfrom
StaticRocket:feature/extlinks

Conversation

@StaticRocket

Copy link
Copy Markdown
Member
  • feat(extlinks): use ti-linux-kernel-binding role

    Use the new ti-linux-kernel-binding role provided through extlinks to reduce
    text and allow for quick branch changes.

    Signed-off-by: Randolph Sapp rs@ti.com

  • feat(extlinks): add extlinks and a suitable config

    Add the extlinks sphinx extensions and a basic JSON configuration file that we
    will load during the build. The conf.py is already pretty unwieldy so keeping
    this separate is probably a good idea.

    Signed-off-by: Randolph Sapp rs@ti.com

Add the extlinks sphinx extensions and a basic JSON configuration file
that we will load during the build. The conf.py is already pretty
unwieldy so keeping this separate is probably a good idea.

Signed-off-by: Randolph Sapp <rs@ti.com>
Use the new ti-linux-kernel-binding role provided through extlinks to
reduce text and allow for quick branch changes.

Signed-off-by: Randolph Sapp <rs@ti.com>
@github-actions

Copy link
Copy Markdown

New warnings found with rstcheck:

source/linux/Foundational_Components_IPC_J784S4.rst:204: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J784S4.rst:204: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC64x.rst:161: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC64x.rst:161: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC_J722S.rst:161: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J722S.rst:161: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC_J7200.rst:155: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J7200.rst:155: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC_J742S2.rst:198: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J742S2.rst:198: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC62ax.rst:167: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC62ax.rst:167: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC62x.rst:161: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC62x.rst:161: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC_J721E.rst:227: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J721E.rst:227: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC_J721S2.rst:181: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J721S2.rst:181: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC62px.rst:158: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC62px.rst:158: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst:71: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst:71: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst:84: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst:84: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst:84: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst:84: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".

@StaticRocket

Copy link
Copy Markdown
Member Author

This draft is to propose usage of extlinks as opposed to explicit links for quicker referencing and global updates to branches. It currently goes over one application of the extension: short links to device tree bindings.

@StaticRocket

Copy link
Copy Markdown
Member Author

Eh, I'm going to close this out. I'm not really sure how helpful it will be. It has the issue of potentially generating invalid links when people update the version tags in the URL builder strings. It also doesn't mesh well with rstcheck; new additions will need be be synced with the rstcheck role ignore list.

@StaticRocket StaticRocket deleted the feature/extlinks branch September 4, 2025 22:09
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.

5 participants