* [PATCH] docs: dt: Use full path to enable cross-reference
@ 2020-11-23 12:13 Nícolas F. R. A. Prado
2020-11-30 21:24 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Nícolas F. R. A. Prado @ 2020-11-23 12:13 UTC (permalink / raw)
To: Rob Herring, Jonathan Corbet
Cc: Mauro Carvalho Chehab, devicetree, linux-doc, linux-kernel,
lkcamp, andrealmeid
Use full path to reference writing-schema.rst so that it becomes a
cross-reference.
Signed-off-by: Nícolas F. R. A. Prado <nfraprado@protonmail.com>
---
Hi Jon,
do you think this would be the way to go, or should we instead extend automarkup
to work on relative paths to doc pages, so that this reference would work as is?
Thanks,
Nícolas
Documentation/devicetree/bindings/submitting-patches.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
index 0aab2b3f16d0..68129ff09967 100644
--- a/Documentation/devicetree/bindings/submitting-patches.rst
+++ b/Documentation/devicetree/bindings/submitting-patches.rst
@@ -25,7 +25,8 @@ I. For patch submitters
make dt_binding_check
- See ../writing-schema.rst for more details about schema and tools setup.
+ See Documentation/devicetree/writing-schema.rst for more details about
+ schema and tools setup.
3) DT binding files should be dual licensed. The preferred license tag is
(GPL-2.0-only OR BSD-2-Clause).
--
2.29.2
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] docs: dt: Use full path to enable cross-reference
2020-11-23 12:13 [PATCH] docs: dt: Use full path to enable cross-reference Nícolas F. R. A. Prado
@ 2020-11-30 21:24 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2020-11-30 21:24 UTC (permalink / raw)
To: Nícolas F. R. A. Prado
Cc: Rob Herring, Mauro Carvalho Chehab, devicetree, linux-doc,
linux-kernel, lkcamp, andrealmeid
On Mon, 23 Nov 2020 12:13:46 +0000
Nícolas F. R. A. Prado <nfraprado@protonmail.com> wrote:
> Use full path to reference writing-schema.rst so that it becomes a
> cross-reference.
>
> Signed-off-by: Nícolas F. R. A. Prado <nfraprado@protonmail.com>
> ---
>
> Hi Jon,
>
> do you think this would be the way to go, or should we instead extend automarkup
> to work on relative paths to doc pages, so that this reference would work as is?
Sorry, I missed this before ... dunno. I suppose that recognizing
relative paths would be a friendly gesture toward our documentation
writers and might be worth doing.
Either way, it occurs to me that automarkup should check to see whether
the file actually exists and complain if it doesn't.
For now, I'll apply this one, though.
Thanks,
jon
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-11-30 21:24 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-11-23 12:13 [PATCH] docs: dt: Use full path to enable cross-reference Nícolas F. R. A. Prado
2020-11-30 21:24 ` Jonathan Corbet
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).