Re: RWF_DONTCACHE documentation

[Jens Axboe <axboe@kernel.dk>]

On 8/17/25 10:01 PM, Alejandro Colomar wrote:
> Hi Jens,
> 
> On Mon, Aug 11, 2025 at 11:25:52AM -0600, Jens Axboe wrote:
>>> Other than this comments, the text looks good to me.  Thanks!
>>
>> I kind of walked away from this one as I didn't have time or motivation
>> to push it forward. FWIW, if you want to massage it into submission
>> that'd be greatly appreciated. I'm not a regular man page contributor
>> nor do I aim to be, but I do feel like we should this feature
>> documented.
> 
> I understand your lack of interest in writing quality man(7) source code
> if that means iterations of patches.  However, you may find the build

It's not really lack of interest, it's just that there's only so much
time and the idea of a back and forth on documentation isn't high on the
list :-)

> system helpful to find some of the most obvious mistakes by yourself.
> This might help you in future patches.
> 
> 	$ make lint-man build-all -R
> 	TROFF		.tmp/man/man2/readv.2.cat.set
> 	an.tmac:.tmp/man/man2/readv.2:316: style: .IR expects at least 2 arguments, got 1
> 	an.tmac:.tmp/man/man2/readv.2:395: style: .IR expects at least 2 arguments, got 1
> 	make: *** [/srv/alx/src/linux/man-pages/man-pages/contrib/share/mk/build/catman/troff.mk:66: .tmp/man/man2/readv.2.cat.set] Error 1
> 	make: *** Deleting file '.tmp/man/man2/readv.2.cat.set'

I'll remember for next time!

> Here's a diff with all the issues I raised fixed.  Please add a commit
> message, and I'll apply it.

Beautiful, thank you! Maybe paste the same section into writev.2 as
well? For commit message, something ala

man/man2/readv.2: document RWF_DONTCACHE

Add a description of the RWF_DONTCACHE IO flag, which tells the kernel
that any page cache instantiated by this IO, should be dropped when the
operation has completed.

?

-- 
Jens Axboe