From: Jonathan Corbet <corbet@lwn.net>
To: Alexandre Torgue <alexandre.torgue@st.com>
Cc: "linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
"mcoquelin.stm32@gmail.com" <mcoquelin.stm32@gmail.com>,
Gerald BAEZA <gerald.baeza@st.com>,
"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>
Subject: Re: [PATCH] Documentation: add link to stm32mp157 docs
Date: Thu, 29 Aug 2019 09:44:58 -0600 [thread overview]
Message-ID: <20190829094458.590884ba@lwn.net> (raw)
In-Reply-To: <5257eff7-418b-8e94-1ced-30718dd3f5dc@st.com>
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
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2019-08-29 15:45 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-27 12:19 [PATCH] Documentation: add link to stm32mp157 docs Gerald BAEZA
2019-08-27 13:48 ` Jonathan Corbet
2019-08-27 15:23 ` Alexandre Torgue
2019-08-29 15:44 ` Jonathan Corbet [this message]
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=20190829094458.590884ba@lwn.net \
--to=corbet@lwn.net \
--cc=alexandre.torgue@st.com \
--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;
as well as URLs for NNTP newsgroup(s).