Skip to content
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.

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

lvol: fix the force parameter's description #9660

Merged

Conversation

cavcrosby
Copy link
Contributor

SUMMARY

The second sentence to the force parameter's description needed some wordsmithing.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/modules/lvol.py

@ansibullbot
Copy link
Collaborator

@ansibullbot ansibullbot added docs docs_only module module plugins plugin (any type) small_patch Hopefully easy to review labels Feb 1, 2025
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch labels Feb 1, 2025
Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

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

Thanks for improving the docs!

@felixfontein felixfontein added the backport-8 Automatically create a backport for the stable-8 branch label Feb 1, 2025
@felixfontein felixfontein merged commit 5f157aa into ansible-collections:main Feb 1, 2025
138 checks passed
Copy link

patchback bot commented Feb 1, 2025

Backport to stable-8: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 5f157aa on top of patchback/backports/stable-8/5f157aac1505a2210710ae1c9df1b2841ad70d5a/pr-9660

Backporting merged PR #9660 into main

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible-collections/community.general.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-8/5f157aac1505a2210710ae1c9df1b2841ad70d5a/pr-9660 upstream/stable-8
  4. Now, cherry-pick PR lvol: fix the force parameter's description #9660 contents into that branch:
    $ git cherry-pick -x 5f157aac1505a2210710ae1c9df1b2841ad70d5a
    If it'll yell at you with something like fatal: Commit 5f157aac1505a2210710ae1c9df1b2841ad70d5a is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 5f157aac1505a2210710ae1c9df1b2841ad70d5a
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR lvol: fix the force parameter's description #9660 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-8/5f157aac1505a2210710ae1c9df1b2841ad70d5a/pr-9660
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Copy link

patchback bot commented Feb 1, 2025

Backport to stable-9: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 5f157aa on top of patchback/backports/stable-9/5f157aac1505a2210710ae1c9df1b2841ad70d5a/pr-9660

Backporting merged PR #9660 into main

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible-collections/community.general.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-9/5f157aac1505a2210710ae1c9df1b2841ad70d5a/pr-9660 upstream/stable-9
  4. Now, cherry-pick PR lvol: fix the force parameter's description #9660 contents into that branch:
    $ git cherry-pick -x 5f157aac1505a2210710ae1c9df1b2841ad70d5a
    If it'll yell at you with something like fatal: Commit 5f157aac1505a2210710ae1c9df1b2841ad70d5a is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 5f157aac1505a2210710ae1c9df1b2841ad70d5a
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR lvol: fix the force parameter's description #9660 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-9/5f157aac1505a2210710ae1c9df1b2841ad70d5a/pr-9660
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Copy link

patchback bot commented Feb 1, 2025

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/5f157aac1505a2210710ae1c9df1b2841ad70d5a/pr-9660

Backported as #9661

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Feb 1, 2025
patchback bot pushed a commit that referenced this pull request Feb 1, 2025
felixfontein pushed a commit that referenced this pull request Feb 1, 2025
…'s description (#9661)

lvol: fix the force parameter's description (#9660)

(cherry picked from commit 5f157aa)

Co-authored-by: Conner Crosby <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8 Automatically create a backport for the stable-8 branch backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch docs_only docs module module plugins plugin (any type) small_patch Hopefully easy to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants