Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixes: fix issues found during translation review #263

Merged
merged 7 commits into from
Dec 12, 2024

Conversation

jonas-rem
Copy link
Collaborator

This PR fixes some issues that have been found while reviewing the translation system.

  • Move external ilnks to doc-bsp-yocto to sphinx references
  • Reduce some unneded substitutions
  • minor fixes that I saw on the way

The substitution

  ref-getting-started-find-correct-device

is a link to a chapter and resolves to

  Finding the Correct Device <getting-started-find-correct-device>`
  in Getting Started.

Substitutions should be kept to a minimum and used only when really
needed (e.g. linking to platform specific content).

Signed-off-by: Jonas Remmert <[email protected]>
The substitution

  |ref-disable-emmc-part|

is a link to a chapter and resolves to

  :ref:`Disable booting from eMMC boot partitions <emmc-disable-boot-part>`
  from Linux.

Substitutions should be kept to a minimum and used only when really
needed (e.g. linking to platform specific content).

Signed-off-by: Jonas Remmert <[email protected]>
Some platforms did not link properly to the chapter "Resizing ext4 Root
Filesystem".

Signed-off-by: Jonas Remmert <[email protected]>
The PD22.1.1 release is based on hardknott. The bsp manual linked
kirkstone instead.

Signed-off-by: Jonas Remmert <[email protected]>
In order to prepare for a change of global links to internal references
for the yocto manual references, the gpio and pcie chapter that uses the
linking has to be moved to the leave documents. Those older bsps are
based on Yocto hardknott, where no internal yocto manual exist.

Once the gpio section is moved, all other manuals can be moved to
internal references.

Signed-off-by: Jonas Remmert <[email protected]>
When linking to internal (doc-bsp-yocto) documents or chapters,
cross-references have advantages over external links. Referencing via
external links does not allowed as external links are not sensitive to
the currently selected language.

Therefor this commit changes all external links to doc-bsp-yocto content
to sphinx references.

Signed-off-by: Jonas Remmert <[email protected]>
Add a rule that internal chapters have to be linked with sphinx
references instead of external links.

Signed-off-by: Jonas Remmert <[email protected]>
@jonas-rem jonas-rem changed the title fixes: fix some issues found during translation reviews fixes: fix issues found during translation review Dec 9, 2024
Copy link
Collaborator

@annie-pixel annie-pixel left a comment

Choose a reason for hiding this comment

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

okay

@jonas-rem jonas-rem merged commit b7f05d5 into main Dec 12, 2024
5 checks passed
@jonas-rem jonas-rem deleted the WIP/[email protected]/fix_replacements branch December 12, 2024 11: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.

2 participants