| Message ID | 20230220143729.504064-1-vincent.stehle@arm.com |
|---|---|
| State | Accepted, archived |
| Commit | ac2ac6908095a22bb48ae3ca5f7a2596f7fc13a3 |
| Delegated to: | Heinrich Schuchardt |
| Headers | show |
| Series | doc: uefi: fix links | expand |
On 2/20/23 15:37, Vincent Stehlé wrote: > Fix a couple of links so that they are rendered correctly with sphinx. > > Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com> > Cc: Heinrich Schuchardt <xypron.glpk@gmx.de> > Cc: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> > --- > doc/develop/uefi/fwu_updates.rst | 3 ++- > doc/develop/uefi/uefi.rst | 4 ++-- > 2 files changed, 4 insertions(+), 3 deletions(-) > > diff --git a/doc/develop/uefi/fwu_updates.rst b/doc/develop/uefi/fwu_updates.rst > index 72c850a7908..e4709d82b41 100644 > --- a/doc/develop/uefi/fwu_updates.rst > +++ b/doc/develop/uefi/fwu_updates.rst > @@ -27,7 +27,8 @@ metadata. Individual drivers can be added based on the type of storage > media, and its partitioning method. Details of the storage device > containing the FWU metadata partitions are specified through a U-Boot > specific device tree property `fwu-mdata-store`. Please refer to > -U-Boot `doc <doc/device-tree-bindings/firmware/fwu-mdata-gpt.yaml>`__ > +U-Boot :download:`fwu-mdata-gpt.yaml > +</device-tree-bindings/firmware/fwu-mdata-gpt.yaml>` > for the device tree bindings. > > Enabling the FWU Multi Bank Update feature > diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst > index a944c0fb803..ffe25ca2318 100644 > --- a/doc/develop/uefi/uefi.rst > +++ b/doc/develop/uefi/uefi.rst > @@ -386,8 +386,8 @@ is because the FWU feature supports multiple partitions(banks) of > updatable images, and the actual dfu alt number to which the image is > to be written to is determined at runtime, based on the value of the > update bank to which the image is to be written. For more information > -on the FWU Multi Bank Update feature, please refer `doc > -<doc/develop/uefi/fwu_updates.rst>`__. > +on the FWU Multi Bank Update feature, please refer to > +:doc:`/develop/uefi/fwu_updates`. > > When using the FMP for FIT images, the image index value needs to be > set to 1.
diff --git a/doc/develop/uefi/fwu_updates.rst b/doc/develop/uefi/fwu_updates.rst index 72c850a7908..e4709d82b41 100644 --- a/doc/develop/uefi/fwu_updates.rst +++ b/doc/develop/uefi/fwu_updates.rst @@ -27,7 +27,8 @@ metadata. Individual drivers can be added based on the type of storage media, and its partitioning method. Details of the storage device containing the FWU metadata partitions are specified through a U-Boot specific device tree property `fwu-mdata-store`. Please refer to -U-Boot `doc <doc/device-tree-bindings/firmware/fwu-mdata-gpt.yaml>`__ +U-Boot :download:`fwu-mdata-gpt.yaml +</device-tree-bindings/firmware/fwu-mdata-gpt.yaml>` for the device tree bindings. Enabling the FWU Multi Bank Update feature diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst index a944c0fb803..ffe25ca2318 100644 --- a/doc/develop/uefi/uefi.rst +++ b/doc/develop/uefi/uefi.rst @@ -386,8 +386,8 @@ is because the FWU feature supports multiple partitions(banks) of updatable images, and the actual dfu alt number to which the image is to be written to is determined at runtime, based on the value of the update bank to which the image is to be written. For more information -on the FWU Multi Bank Update feature, please refer `doc -<doc/develop/uefi/fwu_updates.rst>`__. +on the FWU Multi Bank Update feature, please refer to +:doc:`/develop/uefi/fwu_updates`. When using the FMP for FIT images, the image index value needs to be set to 1.
Fix a couple of links so that they are rendered correctly with sphinx. Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com> Cc: Heinrich Schuchardt <xypron.glpk@gmx.de> Cc: Ilias Apalodimas <ilias.apalodimas@linaro.org> --- doc/develop/uefi/fwu_updates.rst | 3 ++- doc/develop/uefi/uefi.rst | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-)