Hi Will, Thanks for reviewing. On 6/9/20 12:02 PM, Will Deacon wrote: > On Wed, May 27, 2020 at 10:17:37PM +0100, Dave Martin wrote: >> Add documentation for the PR_PAC_RESET_KEYS ioctl added in Linux >> 5.0 for arm64. > > [...] > >> +If the arguments are invalid, >> +and in particular if >> +.I arg2 >> +contains set bits that are unrecognized >> +or that correspond to a key not available on this platform, >> +the call fails with error >> +.BR EINVAL . >> +.IP >> +.B Warning: >> +Because the compiler or run-time environment >> +may be using some or all of the keys, >> +a successful >> +.IP >> +For more information, see the kernel source file >> +.I Documentation/arm64/pointer\-authentication.rst >> +.\"commit b693d0b372afb39432e1c49ad7b3454855bc6bed >> +(or >> +.I Documentation/arm64/pointer\-authentication.txt >> +before Linux 5.3). >> +.B PR_PAC_RESET_KEYS >> +may crash the calling process. > > I might be misreading this, but this looks like the kernel reference appears > mid-sentence. It's hidden as a comment (.\"). > Regardless, I think we should drop the kernel doc reference, > as I mentioned on the SVE patches. I actually request that people add these kinds of comments in the source. It helps me verify details in patches, and is also handy when checking details in the future. > With that: > > Acked-by: Will Deacon <will@xxxxxxxxxx> Thanks. Cheers, Michael -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/
