Page MenuHomeFreeBSD

Fix the stale and incorrect comments in vm/default_pager.c
ClosedPublic

Authored by alc on Dec 13 2016, 6:57 PM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Nov 19, 9:46 PM
Unknown Object (File)
Sun, Nov 10, 5:38 PM
Unknown Object (File)
Oct 23 2024, 8:29 PM
Unknown Object (File)
Oct 19 2024, 8:59 AM
Unknown Object (File)
Oct 19 2024, 8:59 AM
Unknown Object (File)
Oct 19 2024, 8:59 AM
Unknown Object (File)
Oct 19 2024, 8:29 AM
Unknown Object (File)
Oct 2 2024, 8:27 AM
Subscribers
None

Details

Summary

This seems like a classic case of misplaced comments: Comments in place X describe what is going on in place Y. As place Y evolves, no one expects that there are comments elsewhere describing how place Y works.

I've also addressed some style issues.

Test Plan

Tell me if you think that I've actually deleted anything useful.

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

alc retitled this revision from to Fix the stale and incorrect comments in vm/default_pager.c.
alc updated this object.
alc edited the test plan for this revision. (Show Details)
alc added reviewers: markj, kib.
kib edited edge metadata.
This revision is now accepted and ready to land.Dec 13 2016, 7:02 PM
vm/default_pager.c
117 ↗(On Diff #22887)

I'm thinking of changing "this method will" to "this method implementation will".

vm/default_pager.c
117 ↗(On Diff #22887)

In my previous life, where I programmed e.g. in C++, I do not remember a need to use extra-accurate and long 'this method implementation' designator when the reference was obviously to the current implementation.

markj edited edge metadata.
markj added inline comments.
vm/default_pager.c
117 ↗(On Diff #22887)

"this function will"?

vm/default_pager.c
117 ↗(On Diff #22887)

Yes, I'm happy with "function".

This revision was automatically updated to reflect the committed changes.