doc: Correct the description of ->release_folio
authorMatthew Wilcox (Oracle) <willy@infradead.org>
Fri, 2 Jun 2023 20:33:20 +0000 (16:33 -0400)
committerMatthew Wilcox (Oracle) <willy@infradead.org>
Mon, 24 Jul 2023 22:04:30 +0000 (18:04 -0400)
commit32b29cc9db455f69ac792c637aea11493bfaf1bc
treed7e267d273f145ae1514201b056d793833c194f6
parenta221ab717c43147f728d93513923ba3528f861bf
doc: Correct the description of ->release_folio

The filesystem ->release_folio method is called under more circumstances
now than when the documentation was written.  The second sentence
describing the interpretation of the return value is the wrong polarity
(false indicates failure, not success).  And the third sentence is also
wrong (the kernel calls try_to_free_buffers() instead).

So replace the entire paragraph with a detailed description of what the
state of the folio may be, the meaning of the gfp parameter, why the
method is being called and what the filesystem is expected to do.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Reviewed-by: Darrick J. Wong <djwong@kernel.org>
Documentation/filesystems/locking.rst