| Message ID | 20241118172357.475281-3-pierrick.bouvier@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | Enhance documentation for new developers | expand |
W dniu 18.11.2024 o 18:23, Pierrick Bouvier pisze: > Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org> > --- > docs/devel/submitting-a-patch.rst | 14 ++++++++++++++ > 1 file changed, 14 insertions(+) > > diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst > index 349c32ee3a9..953682f20cb 100644 > --- a/docs/devel/submitting-a-patch.rst > +++ b/docs/devel/submitting-a-patch.rst > @@ -237,6 +237,20 @@ attachments can be used as a last resort on a first-time submission. > > .. _if_you_cannot_send_patch_emails: > > +Use git-publish > +~~~~~~~~~~~~~~~ > + > +If you already configured git send-email, you can simply use `git-publish > +<https://github.com/stefanha/git-publish>`__ to send series. > + > +:: > + > + $ git checkout master -b my-feature > + $ # work on new commits, add your 'Signed-off-by' lines to each > + $ git publish > + $ ... more work, rebase on master, ... > + $ git publish # will send a v2 You recommend 'b4 shazam' in 3/7 patch so why not here? Both 'b4' and 'git-publish' seem to do same stuff - handle patch series and send them upstream. b4 allows to keep To/Cc emails inside of cover letter which makes it easy to not miss anyone needed.
On Mon, Nov 18, 2024 at 09:23:52AM -0800, Pierrick Bouvier wrote: > Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org> > --- > docs/devel/submitting-a-patch.rst | 14 ++++++++++++++ > 1 file changed, 14 insertions(+) > > diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst > index 349c32ee3a9..953682f20cb 100644 > --- a/docs/devel/submitting-a-patch.rst > +++ b/docs/devel/submitting-a-patch.rst > @@ -237,6 +237,20 @@ attachments can be used as a last resort on a first-time submission. > > .. _if_you_cannot_send_patch_emails: This needs to remain associated with the heading that is *after* your new block of text, while here you need to add a new anchor .. _use_git_publish: > > +Use git-publish > +~~~~~~~~~~~~~~~ > + > +If you already configured git send-email, you can simply use `git-publish > +<https://github.com/stefanha/git-publish>`__ to send series. > + > +:: > + > + $ git checkout master -b my-feature > + $ # work on new commits, add your 'Signed-off-by' lines to each > + $ git publish > + $ ... more work, rebase on master, ... > + $ git publish # will send a v2 Also add a note "Each time you post a series, git-publish will create a local tag with the format ``<branchname>-v<version>`` to record the patch series." > + > If you cannot send patch emails > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > -- > 2.39.5 > With regards, Daniel
On Tue, Nov 19, 2024 at 09:41:40AM +0100, Marcin Juszkiewicz wrote: > W dniu 18.11.2024 o 18:23, Pierrick Bouvier pisze: > > Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org> > > --- > > docs/devel/submitting-a-patch.rst | 14 ++++++++++++++ > > 1 file changed, 14 insertions(+) > > > > diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst > > index 349c32ee3a9..953682f20cb 100644 > > --- a/docs/devel/submitting-a-patch.rst > > +++ b/docs/devel/submitting-a-patch.rst > > @@ -237,6 +237,20 @@ attachments can be used as a last resort on a first-time submission. > > .. _if_you_cannot_send_patch_emails: > > +Use git-publish > > +~~~~~~~~~~~~~~~ > > + > > +If you already configured git send-email, you can simply use `git-publish > > +<https://github.com/stefanha/git-publish>`__ to send series. > > + > > +:: > > + > > + $ git checkout master -b my-feature > > + $ # work on new commits, add your 'Signed-off-by' lines to each > > + $ git publish > > + $ ... more work, rebase on master, ... > > + $ git publish # will send a v2 > > You recommend 'b4 shazam' in 3/7 patch so why not here? Both 'b4' and > 'git-publish' seem to do same stuff - handle patch series and send them > upstream. git-publish is what we already recommended to people both elsewhere in this file, and more prominently in the README.rst file, so maintaining that practice is correct. > b4 allows to keep To/Cc emails inside of cover letter which makes it easy to > not miss anyone needed. git-publish automatically CC's people by correlating the files touched in the commits against our MAINTAINERS file, so it "does the right thing" in the majority of cases. We recommend it because it makes it much harder for novice users to mess up patch series submission. With regards, Daniel
diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst index 349c32ee3a9..953682f20cb 100644 --- a/docs/devel/submitting-a-patch.rst +++ b/docs/devel/submitting-a-patch.rst @@ -237,6 +237,20 @@ attachments can be used as a last resort on a first-time submission. .. _if_you_cannot_send_patch_emails: +Use git-publish +~~~~~~~~~~~~~~~ + +If you already configured git send-email, you can simply use `git-publish +<https://github.com/stefanha/git-publish>`__ to send series. + +:: + + $ git checkout master -b my-feature + $ # work on new commits, add your 'Signed-off-by' lines to each + $ git publish + $ ... more work, rebase on master, ... + $ git publish # will send a v2 + If you cannot send patch emails ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org> --- docs/devel/submitting-a-patch.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+)