RE: [PATCH] Documentation: add link to stm32mp157 docs

From: Gerald BAEZA
Date: Thu Oct 03 2019 - 06:06:06 EST


Hi Jonathan

> From: Alexandre TORGUE <alexandre.torgue@xxxxxx>
> Hi Jonathan,
>
> On 8/27/19 3:48 PM, Jonathan Corbet wrote:
> > On Tue, 27 Aug 2019 12:19:32 +0000
> > Gerald BAEZA <gerald.baeza@xxxxxx> wrote:
> >
> >> Link to the online stm32mp157 documentation added in the overview.
> >>
> >> Signed-off-by: Gerald Baeza <gerald.baeza@xxxxxx>
> >> ---
> >> Documentation/arm/stm32/stm32mp157-overview.rst | 6 ++++++
> >> 1 file changed, 6 insertions(+)
> >>
> >> diff --git a/Documentation/arm/stm32/stm32mp157-overview.rst
> >> b/Documentation/arm/stm32/stm32mp157-overview.rst
> >> index f62fdc8..8d5a476 100644
> >> --- a/Documentation/arm/stm32/stm32mp157-overview.rst
> >> +++ b/Documentation/arm/stm32/stm32mp157-overview.rst
> >> @@ -14,6 +14,12 @@ It features:
> >> - Standard connectivity, widely inherited from the STM32 MCU family
> >> - Comprehensive security support
> >>
> >> +Resources
> >> +---------
> >> +
> >> +Datasheet and reference manual are publicly available on ST website:
> >> +.. _STM32MP157:
> >> +https://www.st.com/en/microcontrollers-
> microprocessors/stm32mp157.ht
> >> +ml
> >> +
> >
> > Adding the URL is a fine idea. But you don't need the extra syntax to
> > create a link if you're not going to actually make a link out of it.
> > So I'd take the ".. _STM32MP157:" part out and life will be good.
> >
>
> We also did it for older stm32 product. Idea was to not have the "full"
> address but just a shortcut of the link when html file is read. It maybe makes
> no sens ? (if yes we will have to update older stm32 overview :))

Example in https://www.kernel.org/doc/html/latest/arm/stm32/stm32h743-overview.html

Do you agree to continue like this ?

Best regards,

GÃrald

> thanks
> Alex
>
>
> > Thanks,
> >
> > jon
> >