add document: how to make a patch for export-diff cmd #117
+17
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Yuji Ito <[email protected]>
satoru-takeuchi
requested changes
Feb 27, 2025
| @@ -15,8 +15,7 @@ make test | |||
|
|
|||
| ## Procedure to update | |||
| ### Update ceph version | |||
|
|
|||
| Imports all of the contents from upstream git, including tags. | |||
| **In the `cybozu/ceph` repository,** imports all of the contents from upstream git, including tags. | |||
There was a problem hiding this comment.
Suggested change
| **In the `cybozu/ceph` repository,** imports all of the contents from upstream git, including tags. | |
| **In the `cybozu/ceph` repository,** sync with the contents from upstream git (`ceph/ceph`), including tags. |
| @@ -29,9 +28,24 @@ git push origin --tags | |||
| ``` | |||
|
|
|||
| ### Update the patch | |||
| TBD | |||
| **In the `cybozu/ceph` repository,** the export-diff patch is created by each target Ceph version. A branch is created for each Ceph version. If there is no branch for the target version, You can create it like the following. | |||
There was a problem hiding this comment.
Suggested change
| **In the `cybozu/ceph` repository,** the export-diff patch is created by each target Ceph version. A branch is created for each Ceph version. If there is no branch for the target version, You can create it like the following. | |
| **In the `cybozu/ceph` repository,** you checkout the target branch (`rbd-export-vx.y.z`). If it doesn't exist yet, it's necessary to create it and apply the newest patch as follows. |
| git checkout -b rbd-export-v$VERSION tags/v$VERSION | ||
| ``` | ||
|
|
||
| You commit & push to the branch in the same way as normal development, but **you do not create an RP, and do not merge to the main branch.** You simply save the changes to the branch. |
There was a problem hiding this comment.
Suggested change
| You commit & push to the branch in the same way as normal development, but **you do not create an RP, and do not merge to the main branch.** You simply save the changes to the branch. | |
| You modify code, commit the changes, and push to the branch in the same way as normal development. **You must not create a PR corresponding to this branch**. |
| git diff tags/v$VERSION > export-diff.patch | ||
| ``` | ||
|
|
||
| The patches are stored in the `ceph` directory in the `cybozu-go/mantle` repository. Please copy them manually. |
There was a problem hiding this comment.
Suggested change
| The patches are stored in the `ceph` directory in the `cybozu-go/mantle` repository. Please copy them manually. | |
| You store the up-to-date export-diff.patch as [`ceph/export-diff.patch`](https://github.com/cybozu-go/mantle/blob/main/ceph/export-diff.patch). |
| **In the `cybozu/ceph` repository,** the export-diff patch is created by each target Ceph version. A branch is created for each Ceph version. If there is no branch for the target version, You can create it like the following. | ||
|
|
||
| ```sh | ||
| # at working directory for https://github.com/ceph/ceph.git |
There was a problem hiding this comment.
Suggested change
| # at working directory for https://github.com/ceph/ceph.git | |
| # at working directory for https://github.com/cybozu/ceph.git |
| ```sh | ||
| # at working directory for https://github.com/ceph/ceph.git | ||
| VERSION=16.2.4 | ||
| git checkout -b rbd-export-v$VERSION tags/v$VERSION |
There was a problem hiding this comment.
Suggested change
| git checkout -b rbd-export-v$VERSION tags/v$VERSION | |
| git checkout -b rbd-export-v$VERSION tags/v$VERSION | |
| git apply ceph/export-diff.patch |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.