WIP doc: add Backporting section to SubmittingPatches.rst by smithfarm · Pull Request #22876 · ceph/ceph

smithfarm · 2018-07-05T13:52:07Z

SubmittingPatches.rst (general guidelines, for GitHub/master branch)
SubmittingPatches-kernel.rst (for kernel patches)
SubmittingPatches-backports.rst (for backports)

Fixes: http://tracker.ceph.com/issues/20953

liewegas · 2018-07-05T14:03:20Z

SubmittingPatches.rst

+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you want to stage the backport yourself, first find out the backport tracker
+number of the fix (see `Backport tracking`_, above) by referring to the


I don't see the part that describes how the Backport tracker item is created. (I'm unsure how these are created mysefl! Is there a script that does this?)

Yes, the script is here: https://github.com/ceph/ceph/blob/master/src/script/backport-create-issue

I did not mention it on purpose because I didn't want to encumber SubmittingPatches.rst with Too Much Information, especially seeing as new contributors typically do not have sufficient tracker permissions to run the script.

But I agree this information should be presented somewhere. Here?

theanalyst · 2018-07-05T14:05:12Z

SubmittingPatches.rst

+PR still needs to target master.
+
+.. _`Stable Releases and Backports`: http://tracker.ceph.com/projects/ceph-releases/wiki
+


worth mentioning that this wiki also describes various workflows in the backporting lifecycle

jcsp · 2018-07-05T16:24:46Z

This all looks good to me -- I wonder if now is a good time to think about breaking this up into a few different pages? The longer SubmittingPatches.rst gets, the more someone might skip reading it. I'm happy to have a go at that in a separate PR after this though.

smithfarm · 2018-07-05T16:45:02Z

@jcsp Thanks for looking. I hear you about the document getting long. It's nice to have it all in one place, though. I get the feeling that some folks only read the document after being pointed to it, and it's easy to point them to the relevant section via links. For example, if someone needs to be "convinced" to add "Signed-off-by", point them to https://github.com/ceph/ceph/blob/master/SubmittingPatches.rst#1-sign-your-work
(etc.)

joscollin · 2018-07-06T14:02:18Z

SubmittingPatches.rst

+   branches (for example, the "hammer" or "infernalis" branches), your initial
+   PR should still target the master branch. Please see the `BACKPORTING`_
+   section, below, for information on how to ensure your bugfix gets
+   backported.


@smithfarm This is the paragraph (nit) I mentioned in the chat. Dropping that colon nature of your change: would avoid the unnecessary quotation line.

smithfarm · 2018-07-13T15:40:14Z

@jcsp I'll tackle splitting the file into a number of smaller files. What kind of structure would you suggest? I'm envisioning something like this:

SubmittingPatches-sign-your-commits.rst (just the verbiage regarding signed-off-by)
SubmittingPatches-kernel-clients.rst (the rest of the verbiage copied from Linux kernel docs, plus the entire section "Patch submission via ceph-devel")
SubmittingPatches-github.rst (instructions for submitting patches targeting master)
SubmittingPatches-backporting.rst (the new backporting section)

tchaikov · 2018-07-16T07:13:43Z

@smithfarm i'd suggest have "SubmittingPatches-sign-your-commits.rst" and "SubmittingPatches-github.rst" in a single file.

also, how about creating a template for PR? see https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/

jcsp · 2018-07-16T11:48:15Z

I agree with @tchaikov that the basic signing and basic PR instructions should go together. It's a good idea to put the kernel patch info and the backporting info on separate pages as you suggest, as most new contributors don't touch them.

I would suggest making the first thing on the main page with an example commit message: this is the part that people most often miss, even if they are familiar with how to use github.

LenzGr

LGTM except for the minor nit about the capitalization of the backporting headline. Thanks!

LenzGr · 2018-07-16T13:47:57Z

SubmittingPatches.rst

 you to re-send them using MIME.

+
+BACKPORTING


I'd suggest to replace the all-caps headline with "Backporting", to be in line with other headlines in the documentation.

@LenzGr All the headlines at this level are in all-caps, actually, but (a) we're talking about breaking this up into separate documents, and (b) I agree that all-caps headlines are undesirable, so I'll keep that in mind for the next round of revisions.

smithfarm · 2018-07-18T11:21:59Z

Note to self: fix http://tracker.ceph.com/issues/20953 while we're at it.

epuertat · 2018-07-27T08:24:59Z

SubmittingPatches.rst

+    Signed-off-by: Sage Weil <sage@redhat.com>
+    (cherry picked from commit ef510e43f0ee14b49e99beed9ae8feda6db3429a)
+
+    Conflicts:


We may provide some cooked/sample prepare-commit-msg hook like this to uncomment Conflicts section.

batrick · 2018-09-25T14:23:07Z

@smithfarm status on this PR?

stale · 2018-11-24T15:06:41Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
If you are a maintainer or core committer, please follow-up on this issue to identify what steps should be taken by the author to move this proposed change forward.
If you are the author of this pull request, thank you for your proposed contribution. If you believe this change is still appropriate, please ensure that any feedback has been addressed and ask for a code review.

smithfarm · 2018-11-24T21:09:00Z

Putting this on my to-do list for this coming week.

stale · 2019-01-24T02:58:56Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
If you are a maintainer or core committer, please follow-up on this issue to identify what steps should be taken by the author to move this proposed change forward.
If you are the author of this pull request, thank you for your proposed contribution. If you believe this change is still appropriate, please ensure that any feedback has been addressed and ask for a code review.

stale · 2019-03-29T16:36:21Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
If you are a maintainer or core committer, please follow-up on this issue to identify what steps should be taken by the author to move this proposed change forward.
If you are the author of this pull request, thank you for your proposed contribution. If you believe this change is still appropriate, please ensure that any feedback has been addressed and ask for a code review.

batrick · 2019-04-05T17:44:11Z

ping @smithfarm

stale · 2019-06-04T18:41:22Z

This pull request has been automatically marked as stale because it has not had any activity for 60 days. It will be closed if no further activity occurs for another 30 days.
If you are a maintainer or core committer, please follow-up on this pull request to identify what steps should be taken by the author to move this proposed change forward.
If you are the author of this pull request, thank you for your proposed contribution. If you believe this change is still appropriate, please ensure that any feedback has been addressed and ask for a code review.

stale · 2019-09-02T19:26:46Z

This pull request has been automatically closed because there has been no activity for 90 days. Please feel free to reopen this pull request (or open a new one) if the proposed change is still appropriate. Thank you for your contribution!

Signed-off-by: Nathan Cutler <ncutler@suse.com>

smithfarm · 2019-10-03T13:12:47Z

closing in favor of #30705

smithfarm added documentation backport labels Jul 5, 2018

smithfarm requested review from LenzGr, batrick, jcsp, joscollin, liewegas, tchaikov and theanalyst July 5, 2018 13:52

theanalyst approved these changes Jul 5, 2018

View reviewed changes

liewegas reviewed Jul 5, 2018

View reviewed changes

smithfarm mentioned this pull request Jul 5, 2018

[mimic] doc/cephfs: remove lingering "experimental" note about multimds #22854

Merged

theanalyst reviewed Jul 5, 2018

View reviewed changes

joscollin reviewed Jul 6, 2018

View reviewed changes

smithfarm force-pushed the wip-sp-backporting branch from 88ec258 to 5cd9d81 Compare July 13, 2018 15:24

LenzGr approved these changes Jul 16, 2018

View reviewed changes

smithfarm changed the title ~~doc: add Backporting section to SubmittingPatches.rst~~ WIP doc: add Backporting section to SubmittingPatches.rst Jul 20, 2018

smithfarm added the DNM label Jul 20, 2018

smithfarm mentioned this pull request Jul 26, 2018

luminous: mgr: add units to performance counters #23266

Merged

smithfarm requested a review from epuertat July 26, 2018 17:58

epuertat approved these changes Jul 27, 2018

View reviewed changes

stale bot added the stale label Nov 24, 2018

stale bot removed the stale label Nov 24, 2018

stale bot added the stale label Jan 24, 2019

LenzGr removed the backport label Mar 29, 2019

stale bot removed the stale label Mar 29, 2019

stale bot added the stale label Mar 29, 2019

stale bot removed the stale label Apr 5, 2019

stale bot added the stale label Jun 4, 2019

stale bot closed this Sep 2, 2019

smithfarm reopened this Sep 3, 2019

stale bot removed the stale label Sep 3, 2019

doc: split up SubmittingPatches.rst

6d04384

Signed-off-by: Nathan Cutler <ncutler@suse.com>

smithfarm force-pushed the wip-sp-backporting branch from 3db174f to 6d04384 Compare October 3, 2019 12:58

smithfarm mentioned this pull request Oct 3, 2019

doc: split up SubmittingPatches.rst #30705

Merged

2 tasks

smithfarm closed this Oct 3, 2019

smithfarm deleted the wip-sp-backporting branch October 3, 2019 13:33

		PR still needs to target master.

		.. _`Stable Releases and Backports`: http://tracker.ceph.com/projects/ceph-releases/wiki

Conversation

smithfarm commented Jul 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jcsp commented Jul 5, 2018

Uh oh!

smithfarm commented Jul 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

smithfarm commented Jul 13, 2018

Uh oh!

tchaikov commented Jul 16, 2018

Uh oh!

jcsp commented Jul 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LenzGr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

smithfarm commented Jul 18, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

batrick commented Sep 25, 2018

Uh oh!

stale bot commented Nov 24, 2018

Uh oh!

smithfarm commented Nov 24, 2018

Uh oh!

stale bot commented Jan 24, 2019

Uh oh!

stale bot commented Mar 29, 2019

Uh oh!

batrick commented Apr 5, 2019

Uh oh!

stale bot commented Jun 4, 2019

Uh oh!

stale bot commented Sep 2, 2019

Uh oh!

smithfarm commented Oct 3, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

smithfarm commented Jul 5, 2018 •

edited

Loading

smithfarm commented Jul 5, 2018 •

edited

Loading

jcsp commented Jul 16, 2018 •

edited

Loading