Docs: Add performance advice for IO.read & friends
What does this MR do?
Several functions on File and IO read the source in its entirey (i.e. until hitting EOF), which can lead to memory bloat if the file is large, as well as mistuning the garbage collector for future allocations of similar size, which are unlikely to ever happen.
After discarding the idea of having a Cop enforcing these rules, we instead opted for just expanding on this problem in our performance docs.
Related issues
Closes #212208 (closed)
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Matthias Käppler