Linux-remoteproc Archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: anish kumar <yesanishhere@gmail.com>,
	ohad@wizery.com, bjorn.andersson@linaro.org,
	mathieu.poirier@linaro.org
Cc: linux-remoteproc@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, kernel test robot <lkp@intel.com>
Subject: Re: [PATCH 0/1] remoteproc documentation changes
Date: Wed, 23 Oct 2024 07:53:16 -0600	[thread overview]
Message-ID: <87a5evncxf.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20241023053357.5261-1-yesanishhere@gmail.com>

anish kumar <yesanishhere@gmail.com> writes:

> This patch series transitions the documentation
> for remoteproc from the staging directory to the
> mainline kernel. It introduces both kernel and
> user-space APIs, enhancing the overall documentation
> quality.
>
> V4:
> Fixed compilation errors and moved documentation to
> driver-api directory.
>
> V3:
> Seperated out the patches further to make the intention
> clear for each patch.
>
> V2:
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202410161444.jOKMsoGS-lkp@intel.com/

So I think you could make better use of kerneldoc comments for a number
of your APIs and structures - a project for the future.  I can't judge
the remoteproc aspects of this, but from a documentation mechanics point
of view, this looks about ready to me.  In the absence of objections
I'll apply it in the near future.

Thanks,

jon

  parent reply	other threads:[~2024-10-23 13:53 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-23  5:33 [PATCH 0/1] remoteproc documentation changes anish kumar
2024-10-23  5:33 ` [PATCH V4 1/7] Remoteproc: Documentation: add the main index anish kumar
2024-10-24 15:42   ` Mathieu Poirier
2024-10-24 17:51     ` anish kumar
2024-10-23  5:33 ` [PATCH V4 2/7] Documentation: remoteproc: move from staging anish kumar
2024-10-23  5:33 ` [PATCH V4 3/7] Documentation: remoteproc: add more information anish kumar
2024-10-24 15:53   ` Mathieu Poirier
2024-10-24 18:17     ` anish kumar
2024-10-25 14:57       ` Mathieu Poirier
2024-10-25 15:13         ` anish kumar
2024-10-25 15:18           ` Mathieu Poirier
2024-10-23  5:33 ` [PATCH V4 4/7] Remoteproc: Documentation: add driver api anish kumar
2024-10-23  5:33 ` [PATCH V4 5/7] Remoteproc: Documentation: add userspace api anish kumar
2024-10-23  5:33 ` [PATCH V4 6/7] MAINTAINERS: remoteproc documentation path update anish kumar
2024-10-23  5:33 ` [PATCH V4 7/7] rpmsg: Documentation: update the path anish kumar
2024-10-23 13:53 ` Jonathan Corbet [this message]
2024-10-23 14:43   ` [PATCH 0/1] remoteproc documentation changes Jonathan Corbet
2024-10-23 15:35   ` Mathieu Poirier
  -- strict thread matches above, loose matches on Subject: below --
2024-10-22 21:35 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=87a5evncxf.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=bjorn.andersson@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-remoteproc@vger.kernel.org \
    --cc=lkp@intel.com \
    --cc=mathieu.poirier@linaro.org \
    --cc=ohad@wizery.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).