Re: [PATCH 4/6] Protectable Memory

From: Mike Rapoport
Date: Mon Feb 12 2018 - 07:54:03 EST


On Mon, Feb 12, 2018 at 01:43:11PM +0200, Mike Rapoport wrote:
> On Mon, Feb 12, 2018 at 01:26:28PM +0200, Igor Stoppa wrote:
> > On 11/02/18 14:37, Mike Rapoport wrote:
> > > On Sun, Feb 11, 2018 at 05:19:18AM +0200, Igor Stoppa wrote:
> >
> > >> + * Return: 0 if the object does not belong to pmalloc, 1 if it belongs to
> > >> + * pmalloc, -1 if it partially overlaps pmalloc meory, but incorectly.
> > >
> > > typo: ^ memory
> >
> > thanks :-(
> >
> > [...]
> >
> > >> +/**
> > >> + * When the sysfs is ready to receive registrations, connect all the
> > >> + * pools previously created. Also enable further pools to be connected
> > >> + * right away.
> > >> + */
> > >
> > > This does not seem as kernel-doc comment. Please either remove the second *
> > > from the opening comment mark or reformat the comment.
> >
> > For this too, I thought I had caught them all, but I was wrong ...
> >
> > I didn't find any mention of automated checking for comments.
> > Is there such tool?
>
> I don't know if there is a tool. I couldn't find anything in scripts, maybe
> somebody have such tool out of tree.
>
> For now, I've added mm-api.rst that includes all mm .c files and run 'make
> htmldocs' which spits plenty of warnings and errors.

Actually, you can run 'scripts/kernel-doc -v -none <filename>' to check
comments starting with '/**'. I afraid it won't catch formatted blocks that
start with '/*'


--
Sincerely yours,
Mike.