OCPBUGS-59774: Update documentation of oc adm must-gather timeout flag

[ardaguclu]

timeout flag in oc adm must-gather only applies to gathering process and it does not apply to copying. In order to clarify the behavior, this PR updates the documentation accordingly.

[openshift-ci-robot]

@ardaguclu: This pull request references Jira Issue OCPBUGS-59774, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target version (4.21.0) matches configured target version for branch (4.21.0)
• bug is in the state New, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @zhouying7780

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

timeout flag in oc adm must-gather only applies to gathering process and it does not apply to copying. In order to clarify the behavior, this PR updates the documentation accordingly.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[coderabbitai]

Walkthrough

The --timeout flag help text in the must-gather CLI command has been clarified to specify that the timeout applies only to the data gathering phase, and that copying to the local destination continues after gathering completes.

Changes

Cohort / File(s)	Change Summary
CLI help text documentation pkg/cli/admin/mustgather/mustgather.go	Updated --timeout flag description to clarify scope: timeout applies only to data gathering phase, copying continues afterward

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Help text clarification only; no functional logic changes
• Single file modified with documentation-only update

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 8642d88 and 9e2ba3c.

📒 Files selected for processing (1)

• pkg/cli/admin/mustgather/mustgather.go (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**

⚙️ CodeRabbit configuration file

-Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity.

Files:

• pkg/cli/admin/mustgather/mustgather.go

🔇 Additional comments (1)

pkg/cli/admin/mustgather/mustgather.go (1)

165-165: Documentation clarification is accurate and helpful.

The updated help text correctly reflects the implementation: the timeout via wait.PollUntilContextTimeout() at line 954 constrains only the gather completion check, while copyFilesFromPod() at line 804 executes after the timeout expires without additional time constraints. This clarification improves UX by setting correct expectations for users.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[tchap]

/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ardaguclu, tchap

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [ardaguclu]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[ardaguclu]

@tchap thanks for tagging this.
/hold
just until to see any feedback from the reporter of this issue

[ardaguclu]

/hold cancel

[ardaguclu]

/retest
/verify bypass
since this PR is only documentation update

[ardaguclu]

/verified bypass

[openshift-ci-robot]

@ardaguclu: The verified label has been added.

In response to this:

/verified bypass

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

/retest-required

Remaining retests: 0 against base HEAD 8642d88 and 2 for PR HEAD 9e2ba3c in total

[ardaguclu]

/retest

[ardaguclu]

/retest

[openshift-ci]

@ardaguclu: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[openshift-ci-robot]

@ardaguclu: Jira Issue Verification Checks: Jira Issue OCPBUGS-59774
✔️ This pull request was pre-merge verified.
✔️ All associated pull requests have merged.
✔️ All associated, merged pull requests were pre-merge verified.

Jira Issue OCPBUGS-59774 has been moved to the MODIFIED state and will move to the VERIFIED state when the change is available in an accepted nightly payload. 🕓

In response to this:

timeout flag in oc adm must-gather only applies to gathering process and it does not apply to copying. In order to clarify the behavior, this PR updates the documentation accordingly.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.