From: Alexandre Torgue <alexandre.torgue@st.com>
To: Jonathan Corbet <corbet@lwn.net>, Gerald BAEZA <gerald.baeza@st.com>
Cc: "mcoquelin.stm32@gmail.com" <mcoquelin.stm32@gmail.com>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
"linux-stm32@st-md-mailman.stormreply.com"
<linux-stm32@st-md-mailman.stormreply.com>,
"linux-arm-kernel@lists.infradead.org"
<linux-arm-kernel@lists.infradead.org>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] Documentation: add link to stm32mp157 docs
Date: Tue, 27 Aug 2019 17:23:30 +0200 [thread overview]
Message-ID: <5257eff7-418b-8e94-1ced-30718dd3f5dc@st.com> (raw)
In-Reply-To: <20190827074825.64a28e88@lwn.net>
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
>
next prev parent reply other threads:[~2019-08-27 15:23 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-27 12:19 Gerald BAEZA
2019-08-27 13:48 ` Jonathan Corbet
2019-08-27 15:23 ` Alexandre Torgue [this message]
2019-08-29 15:44 ` Jonathan Corbet
2019-10-03 10:05 ` Gerald BAEZA
2019-10-07 15:32 ` Jonathan Corbet
2019-10-08 9:19 ` Gerald BAEZA
2019-10-25 9:42 ` Alexandre Torgue
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5257eff7-418b-8e94-1ced-30718dd3f5dc@st.com \
--to=alexandre.torgue@st.com \
--cc=corbet@lwn.net \
--cc=gerald.baeza@st.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-stm32@st-md-mailman.stormreply.com \
--cc=mcoquelin.stm32@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®