public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Matti Vaittinen <mazziesaccount@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>, Jonathan Cameron <jic23@kernel.org>
Cc: Jonathan Cameron <Jonathan.Cameron@Huawei.com>,
	"Vaittinen, Matti" <Matti.Vaittinen@fi.rohmeurope.com>,
	linux-iio <linux-iio@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	linux-doc@vger.kernel.org
Subject: Re: ROHM ALS, integration time
Date: Wed, 1 Feb 2023 07:55:13 +0200	[thread overview]
Message-ID: <1e93f48b-57b8-f55a-8e49-9cebfeaca32a@gmail.com> (raw)
In-Reply-To: <877cx24gsj.fsf@meer.lwn.net>

On 1/31/23 21:58, Jonathan Corbet wrote:
> Jonathan Cameron <jic23@kernel.org> 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! ~~


      reply	other threads:[~2023-02-01  5:55 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <65c7c45a-c953-e418-f640-9e46841151a1@gmail.com>
     [not found] ` <20230130130231.000013b6@Huawei.com>
     [not found]   ` <9b3dcc7a-a0f8-38ee-4381-d330004d436f@fi.rohmeurope.com>
     [not found]     ` <20230130171218.00007802@Huawei.com>
     [not found]       ` <0e0d45b7-e582-82b2-9bac-1f70f9dad9f7@gmail.com>
2023-01-30 20:19         ` ROHM ALS, integration time Jonathan Cameron
2023-01-31 19:58           ` Jonathan Corbet
2023-02-01  5:55             ` Matti Vaittinen [this message]

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=1e93f48b-57b8-f55a-8e49-9cebfeaca32a@gmail.com \
    --to=mazziesaccount@gmail.com \
    --cc=Jonathan.Cameron@Huawei.com \
    --cc=Matti.Vaittinen@fi.rohmeurope.com \
    --cc=corbet@lwn.net \
    --cc=jic23@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=mchehab@kernel.org \
    /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