Em Wed, 02 Jun 2021 12:36:05 -0600
Jonathan Corbet <corbet@xxxxxxx> escreveu:
> Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> writes:
>
> > That's said, automarkup.py has a rule to convert Documentation/<foo>.rst
> > into :doc:`<foo>`. So, an alternative approach would be to convert
> > treewide all :doc:`<foo>` into Documentation/<foo>.rst and add something
> > at checkpatch.pl to recommend to avoid :doc: notation.
>
> That seems like the right approach to me. We have the automarkup
> capability, we might as well make use of it...
Hmm...
This patch caused a regression:
<patch>
PATCH] media: admin-guide: avoid using ReSt :doc:`foo` markup
The :doc:`foo` tag is auto-generated via automarkup.py.
So, use the filename at the sources, instead of :doc:`foo`.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
diff --git a/Documentation/admin-guide/media/index.rst b/Documentation/admin-guide/media/index.rst
index 6e0d2bae7154..5dbf6d02096a 100644
--- a/Documentation/admin-guide/media/index.rst
+++ b/Documentation/admin-guide/media/index.rst
@@ -11,10 +11,10 @@ its supported drivers.
Please see:
-- :doc:`/userspace-api/media/index`
+- Documentation/userspace-api/media/index.rst
for the userspace APIs used on media devices.
-- :doc:`/driver-api/media/index`
+- Documentation/driver-api/media/index.rst
for driver development information and Kernel APIs used by
media devices;
</patch>
This is the diff for the HTML output:
<diff>
diff --git a/admin-guide/media/index.html b/admin-guide/media/index.html
index 94c0cdf51579..28c083b75896 100644
--- a/admin-guide/media/index.html
+++ b/admin-guide/media/index.html
@@ -339,12 +339,12 @@ its supported drivers.</p>
<p>Please see:</p>
<ul class="simple">
<li><dl class="simple">
-<dt><a class="reference internal" href="../../userspace-api/media/index.html"><span class="doc">Linux Media Infrastructure userspace API</span></a></dt><dd><p>for the userspace APIs used on media devices.</p>
+<dt>Documentation/userspace-api/media/index.rst</dt><dd><p>for the userspace APIs used on media devices.</p>
</dd>
</dl>
</li>
<li><dl class="simple">
-<dt><a class="reference internal" href="../../driver-api/media/index.html"><span class="doc">Media subsystem kernel internal API</span></a></dt><dd><p>for driver development information and Kernel APIs used by
+<dt>Documentation/driver-api/media/index.rst</dt><dd><p>for driver development information and Kernel APIs used by
media devices;</p>
</dd>
</dl>
</diff>
It sounds that automarkup.py ignored it. Maybe because it is inside
a list?
Thanks,
Mauro
