Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/Performance and Tuning/Module Parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2372,6 +2372,10 @@ Maximum size of ARC in bytes.
If set to 0 then the maximum size of ARC
is determined by the amount of system memory installed:

* **Linux** and **FreeBSD**: the larger of ``all_system_memory - 1GB`` and ``5/8 × all_system_memory``

*prior to v2.3.0*

* **Linux**: 1/2 of system memory
* **FreeBSD**: the larger of ``all_system_memory - 1GB`` and ``5/8 × all_system_memory``

Comment on lines +2375 to 2381
Copy link

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The standalone italic line 'prior to v2.3.0' breaks the bullet list into two separate lists and is stylistically inconsistent. For clarity and proper rendering, consider using a Sphinx versionchanged directive and explicit labels, e.g., '.. versionchanged:: 2.3.0' describing the change, and restructure as a single section with labeled subsections or a nested list (e.g., 'As of 2.3.0:' and 'Prior to 2.3.0:'). Also, prefer 'Prior to 2.3.0:' (capitalized, no 'v') to match typical version notation.

Suggested change
* **Linux** and **FreeBSD**: the larger of ``all_system_memory - 1GB`` and ``5/8 × all_system_memory``
*prior to v2.3.0*
* **Linux**: 1/2 of system memory
* **FreeBSD**: the larger of ``all_system_memory - 1GB`` and ``5/8 × all_system_memory``
* As of 2.3.0:
* **Linux** and **FreeBSD**: the larger of ``all_system_memory - 1GB`` and ``5/8 × all_system_memory``
.. versionchanged:: 2.3.0
Prior to 2.3.0:
* **Linux**: 1/2 of system memory
* **FreeBSD**: the larger of ``all_system_memory - 1GB`` and ``5/8 × all_system_memory``

Copilot uses AI. Check for mistakes.
Copy link
Author

@JCBird1012 JCBird1012 Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this suggested change in some ways (it's technically the correct Sphinx way), but not others -

Screenshot 2025-10-15 at 10 03 13

IMO, current behavior should always be listed first, with previous behavior denoted below, so I'm not sure how I feel about it.

Expand Down