| Message ID | 1566908347-92201-1-git-send-email-gerald.baeza@st.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Documentation: add link to stm32mp157 docs | expand |
On Tue, 27 Aug 2019 12:19:32 +0000 Gerald BAEZA <gerald.baeza@st.com> wrote: > Link to the online stm32mp157 documentation added > in the overview. > > Signed-off-by: Gerald Baeza <gerald.baeza@st.com> > --- > 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.html > + 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. Thanks, jon
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@st.com> wrote: > >> Link to the online stm32mp157 documentation added >> in the overview. >> >> Signed-off-by: Gerald Baeza <gerald.baeza@st.com> >> --- >> 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.html >> + > > 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 :)) thanks Alex > Thanks, > > jon >
On Tue, 27 Aug 2019 17:23:30 +0200 Alexandre Torgue <alexandre.torgue@st.com> wrote: > >> +Datasheet and reference manual are publicly available on ST website: > >> +.. _STM32MP157: https://www.st.com/en/microcontrollers-microprocessors/stm32mp157.html > >> + > > > > 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 :)) Did you actually run it through Sphinx to see what you get? If I understand the effect you're after, you want something like this: The datasheet and reference manual are publicly available on STM32MP157_. .. _STM32MP157: https://www.st.com/en/microcontrollers-microprocessors/stm32mp157.html IOW you have to actually *use* the label you are setting up. That's a fine way to do it, I guess, though I'm not really convinced it's better than just putting the URL in directly. Thanks, jon
Hi Jonathan > From: Alexandre TORGUE <alexandre.torgue@st.com> > 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@st.com> wrote: > > > >> Link to the online stm32mp157 documentation added in the overview. > >> > >> Signed-off-by: Gerald Baeza <gerald.baeza@st.com> > >> --- > >> 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 > >
On Thu, 3 Oct 2019 10:05:46 +0000 Gerald BAEZA <gerald.baeza@st.com> wrote: > > > 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 ? If you actually use the reference then it's OK, I guess; in the posted document that wasn't happening. I still think it might be a bit more straightforward to just put the URL; that will make the plain-text file a little more readable. In the end, though, it's up to you, go with whichever you prefer. Thanks, jon
Hi Jonathan > From: Jonathan Corbet <corbet@lwn.net> > > On Thu, 3 Oct 2019 10:05:46 +0000 > Gerald BAEZA <gerald.baeza@st.com> wrote: > > > > > 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.ht > > ml > > > > Do you agree to continue like this ? > > If you actually use the reference then it's OK, I guess; in the posted > document that wasn't happening. I still think it might be a bit more > straightforward to just put the URL; that will make the plain-text file a little > more readable. In the end, though, it's up to you, go with whichever you > prefer. So I prefer to keep the patch as it, for better consistency with the others stm32 overviews. Thank you. > > Thanks, > > jon
Hi Jonathan On 10/7/19 5:32 PM, Jonathan Corbet wrote: > On Thu, 3 Oct 2019 10:05:46 +0000 > Gerald BAEZA <gerald.baeza@st.com> wrote: > >>>> 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 ? > > If you actually use the reference then it's OK, I guess; in the posted > document that wasn't happening. I still think it might be a bit more > straightforward to just put the URL; that will make the plain-text file a > little more readable. In the end, though, it's up to you, go with > whichever you prefer. > Do you take this patch or do I have to add it in my STM32 pull request ? Thanks in advance Alex > Thanks, > > jon >
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.html + :Authors: - Ludovic Barre <ludovic.barre@st.com>
Link to the online stm32mp157 documentation added in the overview. Signed-off-by: Gerald Baeza <gerald.baeza@st.com> --- Documentation/arm/stm32/stm32mp157-overview.rst | 6 ++++++ 1 file changed, 6 insertions(+)