Skip to content

[plugins] Document that sizelimit=0 means no limit #4457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pmoravec merged 1 commit into from
Aug 20, 2026
+7 −4
Merged

[plugins] Document that sizelimit=0 means no limit #4457

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions sos/report/plugins/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1684,7 +1684,7 @@ def add_copy_spec(self, copyspecs, sizelimit=None, maxage=None,
:type copyspecs: ``str`` or a ``list`` of strings

:param sizelimit: Limit the total size of collections from `copyspecs`
to this size in MB
to this size in MB. Use 0 for no size limit.
:type sizelimit: ``int``

:param maxage: Collect files with `mtime` not older than this many
Expand Down Expand Up @@ -1953,7 +1953,8 @@ def add_device_cmd(self, cmds, devices, timeout=None, sizelimit=None,
:param timeout: Timeout in seconds to allow each `cmd` to run
:type timeout: ``int``

:param sizelimit: Maximum amount of output to collect, in MB
:param sizelimit: Maximum amount of output to collect, in MB.
Use 0 for no size limit.
:type sizelimit: ``int``

:param chroot: Should sos chroot the command(s) being run
Expand Down Expand Up @@ -2160,7 +2161,8 @@ def add_cmd_output(self, cmds, suggest_filename=None, stdin=None,
:param binary: Is the command expected to produce binary output
:type binary: ``bool``

:param sizelimit: Maximum amount of output in MB to save
:param sizelimit: Maximum amount of output in MB to save.
Use 0 for no size limit.
:type sizelimit: ``int``

:param pred: A predicate to gate if `cmds` should be collected or not
Expand Down Expand Up @@ -2416,7 +2418,8 @@ def _collect_cmd_output(self, cmd, suggest_filename=None,
overriding chroot
:param env: Dict of env vars to set for the cmd
:param binary: Is the output in binary?
:param sizelimit: Maximum size in MB of output to save
:param sizelimit: Maximum size in MB of output to save.
Use 0 for no size limit.
:param subdir: Subdir in plugin directory to save to
:param changes: Does this cmd potentially make a change
on the system?
Expand Down
Loading