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

doc/rbd: document cp versus deep cp #41529

Merged
merged 1 commit into from May 27, 2021
Merged

Conversation

Yenya
Copy link
Contributor

@Yenya Yenya commented May 25, 2021

I found that the difference between "rbd cp" and "rbd deep cp",
i.e. what "deep" means in this context, is documented only in
the mailing list archive and in the Mimic reelase notes.

Let's make the difference explicit in the manpage and in rbd --help.

Signed-off-by: Jan "Yenya" Kasprzak kas@fi.muni.cz

Checklist

  • References tracker ticket
  • Updates documentation if necessary
  • Includes tests for new functionality or reproducer for bug

Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test api
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox

doc/man/8/rbd.rst Outdated Show resolved Hide resolved
src/test/cli/rbd/help.t Outdated Show resolved Hide resolved
doc/man/8/rbd.rst Outdated Show resolved Hide resolved
@github-actions
Copy link

This pull request can no longer be automatically merged: a rebase is needed and changes have to be manually resolved

@Yenya Yenya force-pushed the rbd-deep-cp-docs branch 2 times, most recently from c495166 to f2e4fe8 Compare May 27, 2021 08:28
src/test/cli/rbd/help.t Outdated Show resolved Hide resolved
Copy link
Contributor

@idryomov idryomov left a comment

Choose a reason for hiding this comment

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

There is more to deep copy than just snapshots, but it is probably the most important aspect and having it mentioned in the help output seems worthwhile.

@idryomov idryomov changed the title rbd docs: document cp versus deep cp doc/rbd: document cp versus deep cp May 27, 2021
@idryomov
Copy link
Contributor

Sorry, one more thing -- please update the commit title to match the title of the PR (I have tweaked it).

I found that the difference between "rbd cp" and "rbd deep cp",
i.e. what "deep" means in this context, is documented only in
the mailing list archive and in the Mimic reelase notes.

Let's make the difference explicit in the manpage and in rbd --help.

Signed-off-by: Jan "Yenya" Kasprzak <kas@fi.muni.cz>
@Yenya
Copy link
Contributor Author

Yenya commented May 27, 2021

Sorry, one more thing -- please update the commit title to match the title of the PR (I have tweaked it).

Done.

@idryomov idryomov merged commit 6bdda82 into ceph:master May 27, 2021
@Yenya Yenya deleted the rbd-deep-cp-docs branch May 31, 2021 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants