Linux Sound subsystem development
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: anish kumar <yesanishhere@gmail.com>, broonie@kernel.org
Cc: lgirdwood@gmail.com, perex@perex.cz, tiwai@suse.com,
	linux-kernel@vger.kernel.org, linux-sound@vger.kernel.org,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH V2] ASoC: doc: update clocking
Date: Wed, 30 Oct 2024 16:18:46 -0600	[thread overview]
Message-ID: <874j4ts08p.fsf@trenco.lwn.net> (raw)
In-Reply-To: <CABCoZhAgnkDReqdMTgEjKYX4b9y0XqocEheQR1DhsBCtp7zpHg@mail.gmail.com>

anish kumar <yesanishhere@gmail.com> writes:

>> This feels like it is (or should be) duplicating the kerneldoc generated
>> documentation - I'm not sure that we can cross reference the two
>> sensibly through?
>
> Jonathan, wondering if you know a way to link the clock functions defined
> in https://github.com/torvalds/linux/blob/master/sound/soc/soc-dai.c here?

I'm not quite sure what your question is.  Kerneldoc comments can be
brought into the documentation, of course - that's a big part of what
the build system does.  You can link to that documentation just by
saying function() - nothing more required.  What else are you looking
for?

Thanks,

jon

  reply	other threads:[~2024-10-30 22:18 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-29 23:56 [PATCH V2] ASoC: doc: update clocking anish kumar
2024-10-30  1:51 ` Bagas Sanjaya
2024-10-30 13:08 ` Mark Brown
2024-10-30 15:56   ` anish kumar
2024-10-30 22:18     ` Jonathan Corbet [this message]
2024-10-31  3:54       ` anish kumar

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=874j4ts08p.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=broonie@kernel.org \
    --cc=lgirdwood@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-sound@vger.kernel.org \
    --cc=perex@perex.cz \
    --cc=tiwai@suse.com \
    --cc=yesanishhere@gmail.com \
    /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