diff mbox series

docs: dt: Use full path to enable cross-reference

Message ID 20201123121333.59274-1-nfraprado@protonmail.com
State Accepted
Commit 43bc3ed736397e812f14c0eeca27e4fe1ba0577e
Headers show
Series docs: dt: Use full path to enable cross-reference | expand

Commit Message

Nícolas F. R. A. Prado Nov. 23, 2020, 12:13 p.m. UTC
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(-)

Comments

Jonathan Corbet Nov. 30, 2020, 9:24 p.m. UTC | #1
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
diff mbox series

Patch

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).