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: reformat SubmittingPatches with more rst syntax #11570

Merged
merged 3 commits into from Oct 26, 2016

Conversation

tchaikov
Copy link
Contributor

  • group some paragraphs into sections, so we can link to them via its
    html anchor.
  • remove unrelated contents.
  • add cross-refs.

Signed-off-by: Kefu Chai kchai@redhat.com

* group some paragraphs into sections, so we can link to them via its
  html anchor.
* remove unrelated contents.
* add cross-refs.

Signed-off-by: Kefu Chai <kchai@redhat.com>
otherwise the content will be rendered as block quotation.

Signed-off-by: Kefu Chai <kchai@redhat.com>
@tchaikov
Copy link
Contributor Author

@smithfarm do you mind taking a look?

@smithfarm
Copy link
Contributor

@tchaikov In general, I think SubmittingPatches.rst could be clearer about which patches can be submitted via email and which should (must?) be submitted via GitHub PR.

The "PREPARING AND SENDING PATCHES" heading could be changed to "PREPARING AND SUBMITTING PATCHES".

The structure of this section is odd:

  1. Github pull request
  2. Patch submission via ceph-devel@vger.kernel.org
  3. Describe your changes. <- please drop the "." at the end
  4. Separate your changes. <- please drop the "." at the end
  5. Style check your changes. <- please drop the "." at the end
  6. No MIME, no links, no compression, no attachments. Just plain text.

This last section ("6. No MIME, no links, no compression, no attachments. Just plain text.") applies to kernel patches only and should be integrated into section 2. Patch submission via ceph-devel@vger.kernel.org - do you agree?

Also, perhaps we could reverse the order of sections 1. and 2. and rename them slightly:

  1. Patch submission via ceph-devel@vger.kernel.org (for kernel patches only)
  2. Github pull request (all other patches)

@tchaikov
Copy link
Contributor Author

@smithfarm thanks for your review. the intention of this PR is mainly enabling us to link the related sections from PR reviews. i will update it tmr to address your comments.

@tchaikov tchaikov self-assigned this Oct 25, 2016
@smithfarm
Copy link
Contributor

@tchaikov Sounds good. I can make another PR for the changes you didn't intend to make in this one :-)

Signed-off-by: Kefu Chai <kchai@redhat.com>
@tchaikov
Copy link
Contributor Author

@smithfarm i just added a commit to remove the ending period. will leave other changes to you =)

@tchaikov
Copy link
Contributor Author

https://www.kernel.org/doc/Documentation/SubmittingPatches is the "Documentation/SubmittingPatches from the Linux kernel".

Copy link
Member

@theanalyst theanalyst left a comment

Choose a reason for hiding this comment

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

lgtm

@tchaikov tchaikov merged commit bdf174f into ceph:master Oct 26, 2016
@tchaikov tchaikov deleted the wip-revise-SubmittingPatches branch October 26, 2016 14:37
@tchaikov tchaikov assigned theanalyst and unassigned tchaikov Oct 26, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants