Added a comment for @SuppressFBWarnings("DM_EXIT")

[sunidhi-prabhu]

Submitter checklist

• Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
• Ensure that the pull request title represents the desired changelog entry
• Please describe what you did

[MarkEWaite]

That's a reasonable approach, though I think the more common approach with SuppressFBWarnings is to place the value and the justification as arguments to the SuppressFBWarnings annotation. Refer to the Javadoc documentation for more details.

[MarkEWaite]

@sunidhi-prabhu I'll wait to merge this until you comment if you intend to update to use the more common form of justification for a spotbugs warning suppression.

[sunidhi-prabhu]

Indeed, the intention is to enhance clarity by including both the warning code and justification. However, upon reviewing the @SuppressFBWarnings documentation, it appears that there is no dedicated section for justification in the code, and only the 'value' parameter is specified. In consideration of this, I opted for a precise approach, aligning with the tool's capabilities to avoid potential confusion for future developers. The goal remains to maintain code clarity and adherence to established conventions within the tool's framework.
Your insights on this matter would be highly valuable @MarkEWaite

[MarkEWaite]

However, upon reviewing the @SuppressFBWarnings documentation, it appears that there is no dedicated section for justification in the code, and only the 'value' parameter is specified.

We use justification in many of the spotbugs suppressions in Jenkins. Here are some examples for your reference:

• Git client plugin
• Git plugin
• Jenkins core

A more exhaustive list is available with a GitHub search.

[sunidhi-prabhu]

Thanks for your feedback, I've made the changes and have included a more detailed justification for the usage of SuppressFBWarnings.

Let me know if everything looks good from your end, or if there's anything else you'd like me to address.

[MarkEWaite]

No further changes requested from me. I see from the change that you decided to stay with the atypical pattern of placing the comment rather than assigning to the justification argument as is done in the other examples in the Jenkins project. That surprises me, but it is not a blocking concern.

Merging.