Bug 252423 - handbook: login.conf(5) "memoryuse" documented incorrectly.
Summary: handbook: login.conf(5) "memoryuse" documented incorrectly.
Status: Closed Overcome By Events
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Sergio Carlavilla Delgado
URL: https://docs.freebsd.org/en/books/han...
Keywords: needs-patch
Depends on:
Blocks: handbook-2022
  Show dependency tree / graph
 
Reported: 2021-01-04 22:50 UTC by Robert Clausecker
Modified: 2023-09-27 17:21 UTC (History)
4 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Robert Clausecker freebsd_committer freebsd_triage 2021-01-04 22:50:10 UTC 
The handbook says about the memoryuse field in login.conf(5)

> The maximum amount of memory a process may consume at any given time. It 
> includes both core memory and swap usage. This is not a catch-all limit for 
> restricting memory consumption, but is a good start.

This is clearly incorrect.  The memoryuse field accounts for core memory usage only.  The man page login.conf(5) is correct in this regard.

> Maximum of core memory use size limit.

Please fix the handbook.
Comment 2 Pau Amma 2022-04-11 04:06:51 UTC 
Now table 1 in https://docs.freebsd.org/en/books/handbook/security/#security-resourcelimits

login.conf(5) says:

     memoryuse          size                Maximum of core memory use size
                                            limit.

and

     vmemoryuse         size                Maximum permitted total VM usage
                                            per process.

Should the handbook also mention vmemoryuse?
Comment 3 Robert Clausecker freebsd_committer freebsd_triage 2022-04-11 09:48:48 UTC 
Yes, mentioning vmemoryuse would be a good idea.
Comment 4 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2023-09-27 17:21:34 UTC 
I'm gonna close this PR as overcome by events.
We upgraded the chapter in this commit: https://cgit.freebsd.org/doc/commit/?id=99333306