Skip to content

Conversation

@JCBird1012
Copy link

@JCBird1012 JCBird1012 commented Oct 15, 2025

This change was made in #15437 and has been active as of zfs-2.3.0.

I'm not sure the convention for dealing with behavior changes between ZFS versions in docs, so I left the pre-v2.3.0 behavior listed, and notated it as such. Let me know if I should remove it.

This change was made in #15437 and has been active as of zfs-2.3.0
@Copilot Copilot AI review requested due to automatic review settings October 15, 2025 13:56
@JCBird1012 JCBird1012 changed the title fix: arc_default_max on Linux matches FreeBSD as of zfs-2.3.0 fix: arc_default_max (zfs_arc_max) on Linux matches FreeBSD as of zfs-2.3.0 Oct 15, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Updates the module parameters documentation to reflect the change in default ARC max sizing on Linux as of OpenZFS 2.3.0, aligning it with FreeBSD.

  • Document post-2.3.0 behavior: Linux matches FreeBSD (max ARC = max(all_memory - 1GB, 5/8 of memory))
  • Retain and label pre-2.3.0 behavior for Linux

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment on lines +2375 to 2381
* **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``

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant