svn commit: r355137 - head/sys/vm

[Ryan Libby]

On Tue, Dec 3, 2019 at 1:12 PM Ian Lepore <ian at freebsd.org> wrote:
>
> On Tue, 2019-12-03 at 12:59 -0800, Ryan Libby wrote:
> > > +        * XXX UMA_ZONE_OFFPAGE.
>
> All over freebsd we have cryptic XXX comments that have no meaning to
> anyone except whoever wrote them (and, I suspect, no meaning to those
> people either after a couple months have elapsed).
>
> To the degree that XXX represents "possible trouble here" and/or "more
> work to do here", I would argue that any placement of a new XXX
> requires at least a sentence (and probably more like a paragraph) to
> describe why it's there.
>
> -- Ian

Yes, I agree it is cryptic.  This specific XXX is discussed in the
review and is a cookie crumb for planned future work:
https://reviews.freebsd.org/D20722?id=64944#inline-140550

In this case the problem is pre-existing and the comment calls it out so
that we don't miss it in a coming cleanup.  I wrote the block comment
directly above so that it would make sense when the correct flag check
is eventually inserted.

Ryan