Re: [PATCH] highmem: Document kunmap_local()

[Christoph Hellwig]

On Sun, Jan 23, 2022 at 05:30:44PM -0800, ira.weiny@xxxxxxxxx wrote:
> + * __addr is often an address returned from kmap_local_page().  However,
> + * this address can be any address within the mapped page.  It does not need to
> + * be the exact address returned from kmap_local_page()
> + */

I'd word this a little different:

> + * __addr is often an address returned from kmap_local_page().  However,
> + * this address can be any address within the mapped page.  It does not need to
> + * be the exact address returned from kmap_local_page()
> + */

 * @__addr can be any address within the mapped page.  Commonly it is the
 * address return from kmap_local_page(), but it can also include offsets.

But documenting this definitively is a good idea!