Conversation
BHahn42618
commented
Mar 3, 2026
BHahn42618
commented
- fix uuu.rsti include path for imx8mp-fpsc manuals
- fix emmc bootparts link in uuu chapter
- include uuu flash emmc part for imx95 ALPHA2 release
BHahn42618
requested review from
cstoidner,
landerweit-phytec,
mschwan-phytec,
tremmet and
ymoog
as code owners
ymoog
left a comment
ymoog
left a comment
There was a problem hiding this comment.
In your second commit message:
bsp: uuu: fix emmc bootparts link
you also modify rauc in addition to bsp, please drop bsp:
This link here goes to another include file. This is unstable and will
Please add reference to what "This link here" refers to.
lead to link to other (wrong) manuals. Fix this by linking to the
Please also add another sentence why it linked to other manuals.
bootloader offsets section of the RAUC manual.
And here to which it links now and why/how that fixes the problem.
Changes themselves lgtm.
| :end-before: .. bootloader-offsets-marker | ||
|
|
||
| .. _walnascar-bootloader-offsets: | ||
|
|
||
| .. include:: common/reference.rsti | ||
| :start-after: .. bootloader-offsets-marker |
There was a problem hiding this comment.
I really don't like these kind of inserts, where the included text should be modified in the first place instead. I'd suggest using a link in source/rauc/common/reference.rsti at the desired place directly. The outcome is the same, and it's simpler.
There was a problem hiding this comment.
Currently yes, the outcome would be the same, as the reference.rsti is only included in one manual, but if this changes in the future and it is included in multiple manuals, it will lead to the same issue that we had before, where the link will link to one of the manuals, but you can not control which one. And this might go undetected when creating a new rauc manual.
| .. |u-boot-tag| replace:: v2021.04_2.2.0-phy17 | ||
|
|
||
| .. RAUC | ||
| .. |ref-bootloader-offsets-marker| replace:: :ref:`Disable booting from e.MMC boot partitions <kirkstone-bootloader-offsets>` |
There was a problem hiding this comment.
Shouldn't this reference substitution reside in the .. Ref Substitutions section below?
There was a problem hiding this comment.
I guess this would also be a good place. Should I change this for all manuals?
Remove one of the slashes to get the correct format for the include path. Signed-off-by: Benjamin Hahn <B.Hahn@phytec.de>
The emmc-disable-boot-part link goes to another include file which is included in multiple manuals. This will lead to linking to other (wrong) manuals, as sphinx will see the same link destination across different manuals and will take one destination for all links. Fix this by linking to the bootloader offsets section of the RAUC manual. Signed-off-by: Benjamin Hahn <B.Hahn@phytec.de>
Include uuu flash emmc part for ALPHA2 release. Signed-off-by: Benjamin Hahn <B.Hahn@phytec.de>
BHahn42618
force-pushed
the
WIP/bhahn/imx95_alpha2_uuu
branch
from
f2c5935 to
8006cb7
Compare
ymoog
left a comment
ymoog
left a comment
There was a problem hiding this comment.
Your first commit description still claims/implies that something was wrong/incorrect before. You said this was not the case, it was already correct. Do not claim that you fix something when it was simply a style issue.
Also, you did not add how you resolve the linking problem. Please add that.
3 participants
