On 1/31/23 21:58, Jonathan Corbet wrote:
Jonathan Cameron <jic23@xxxxxxxxxx> writes:
Both the kernel-doc for this header and the ABI docs end up in
the kernel html docs. I wonder if a link is possible...
https://docs.kernel.org/driver-api/iio/core.html#industrial-i-o-devices
would have the iio_chan_type docs I think if there were any.
https://docs.kernel.org/admin-guide/abi-testing.html?highlight=abi#abi-sys-iio-devicex-in-intensityy-raw
is the matching ABI doc.
Mauro, Jon, other docs system experts...
I couldn't immediately find a way to link to a specific ABI docs entry,
is there a means to do it from kernel-doc in a header?
It should just be possible to write out the type or function name and
have the links generated automatically. Have you tried just putting
"enum iio_chan_type" into the text? If the automarkup code doesn't pick
it up, please let me know.
As far as I understand - the problem here is that we would like to have
a link from the enum/definition doc to a specific place in the ABI
document. The ABI document does not have the enum / define / function
"link _target_". (I think adding the enum/function name in the ABI doc
would generate link from ABI doc to enum/function doc - which would be
helpful - but in this case we would like to have a link to opposite
direction. From function/enum doc to specific position in a (sysfs) ABI
documentation. Please, bear with me if this was what your suggestion
should achieve. I'd just like to ensure we are ton a same page with this.)
Yours,
--Matti
--
Matti Vaittinen
Linux kernel developer at ROHM Semiconductors
Oulu Finland
~~ When things go utterly wrong vim users can always type :help! ~~
