git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/3] SubmittingPatches: a few unrelated minor fixes
@ 2021-05-12  8:44 Ævar Arnfjörð Bjarmason
  2021-05-12  8:45 ` [PATCH 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
                   ` (3 more replies)
  0 siblings, 4 replies; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-05-12  8:44 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh,
	Ævar Arnfjörð Bjarmason

A few minor updates to SubmittingPatches spotted while paging through
it the other day.

I remembered these when reading
http://lore.kernel.org/git/20210512031821.6498-2-dwh@linuxprogrammer.org

Ævar Arnfjörð Bjarmason (3):
  SubmittingPatches: move discussion of Signed-off-by above "send"
  SubmittingPatches: replace discussion of Travis with GitHub Actions
  SubmittingPatches: remove pine-specific hints from MUA hints

 Documentation/SubmittingPatches | 258 ++++++++++++--------------------
 1 file changed, 95 insertions(+), 163 deletions(-)

-- 
2.31.1.909.g789bb6d90e


^ permalink raw reply	[flat|nested] 28+ messages in thread

* [PATCH 1/3] SubmittingPatches: move discussion of Signed-off-by above "send"
  2021-05-12  8:44 [PATCH 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
@ 2021-05-12  8:45 ` Ævar Arnfjörð Bjarmason
  2021-05-12  9:29   ` Felipe Contreras
  2021-05-12  8:45 ` [PATCH 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
                   ` (2 subsequent siblings)
  3 siblings, 1 reply; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-05-12  8:45 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh,
	Ævar Arnfjörð Bjarmason

Move the section discussing the addition of a SOB trailer above the
section that discusses generating the patch itself. This makes sense
as we don't want someone to go through the process of "git
format-patch", only to realize late that they should have used "git
commit -s" or equivalent.

This is a move-only change, no lines here are are being altered, only
moved around.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/SubmittingPatches | 160 ++++++++++++++++----------------
 1 file changed, 80 insertions(+), 80 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 55287d72e0..2643062624 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -167,6 +167,86 @@ or, on an older version of Git without support for --pretty=reference:
 	git show -s --date=short --pretty='format:%h (%s, %ad)' <commit>
 ....
 
+[[sign-off]]
+=== Certify your work by adding your `Signed-off-by` trailer
+
+To improve tracking of who did what, we ask you to certify that you
+wrote the patch or have the right to pass it on under the same license
+as ours, by "signing off" your patch.  Without sign-off, we cannot
+accept your patches.
+
+If (and only if) you certify the below D-C-O:
+
+[[dco]]
+.Developer's Certificate of Origin 1.1
+____
+By making a contribution to this project, I certify that:
+
+a. The contribution was created in whole or in part by me and I
+   have the right to submit it under the open source license
+   indicated in the file; or
+
+b. The contribution is based upon previous work that, to the best
+   of my knowledge, is covered under an appropriate open source
+   license and I have the right under that license to submit that
+   work with modifications, whether created in whole or in part
+   by me, under the same open source license (unless I am
+   permitted to submit under a different license), as indicated
+   in the file; or
+
+c. The contribution was provided directly to me by some other
+   person who certified (a), (b) or (c) and I have not modified
+   it.
+
+d. I understand and agree that this project and the contribution
+   are public and that a record of the contribution (including all
+   personal information I submit with it, including my sign-off) is
+   maintained indefinitely and may be redistributed consistent with
+   this project or the open source license(s) involved.
+____
+
+you add a "Signed-off-by" trailer to your commit, that looks like
+this:
+
+....
+	Signed-off-by: Random J Developer <random@developer.example.org>
+....
+
+This line can be added by Git if you run the git-commit command with
+the -s option.
+
+Notice that you can place your own `Signed-off-by` trailer when
+forwarding somebody else's patch with the above rules for
+D-C-O.  Indeed you are encouraged to do so.  Do not forget to
+place an in-body "From: " line at the beginning to properly attribute
+the change to its true author (see (2) above).
+
+This procedure originally came from the Linux kernel project, so our
+rule is quite similar to theirs, but what exactly it means to sign-off
+your patch differs from project to project, so it may be different
+from that of the project you are accustomed to.
+
+[[real-name]]
+Also notice that a real name is used in the `Signed-off-by` trailer. Please
+don't hide your real name.
+
+[[commit-trailers]]
+If you like, you can put extra tags at the end:
+
+. `Reported-by:` is used to credit someone who found the bug that
+  the patch attempts to fix.
+. `Acked-by:` says that the person who is more familiar with the area
+  the patch attempts to modify liked the patch.
+. `Reviewed-by:`, unlike the other tags, can only be offered by the
+  reviewer and means that she is completely satisfied that the patch
+  is ready for application.  It is usually offered only after a
+  detailed review.
+. `Tested-by:` is used to indicate that the person applied the patch
+  and found it to have the desired effect.
+
+You can also create your own tag or use one that's in common usage
+such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
+
 [[git-tools]]
 === Generate your patch using Git tools out of your commits.
 
@@ -302,86 +382,6 @@ Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and
 `Tested-by:` lines as necessary to credit people who helped your
 patch, and "cc:" them when sending such a final version for inclusion.
 
-[[sign-off]]
-=== Certify your work by adding your `Signed-off-by` trailer
-
-To improve tracking of who did what, we ask you to certify that you
-wrote the patch or have the right to pass it on under the same license
-as ours, by "signing off" your patch.  Without sign-off, we cannot
-accept your patches.
-
-If (and only if) you certify the below D-C-O:
-
-[[dco]]
-.Developer's Certificate of Origin 1.1
-____
-By making a contribution to this project, I certify that:
-
-a. The contribution was created in whole or in part by me and I
-   have the right to submit it under the open source license
-   indicated in the file; or
-
-b. The contribution is based upon previous work that, to the best
-   of my knowledge, is covered under an appropriate open source
-   license and I have the right under that license to submit that
-   work with modifications, whether created in whole or in part
-   by me, under the same open source license (unless I am
-   permitted to submit under a different license), as indicated
-   in the file; or
-
-c. The contribution was provided directly to me by some other
-   person who certified (a), (b) or (c) and I have not modified
-   it.
-
-d. I understand and agree that this project and the contribution
-   are public and that a record of the contribution (including all
-   personal information I submit with it, including my sign-off) is
-   maintained indefinitely and may be redistributed consistent with
-   this project or the open source license(s) involved.
-____
-
-you add a "Signed-off-by" trailer to your commit, that looks like
-this:
-
-....
-	Signed-off-by: Random J Developer <random@developer.example.org>
-....
-
-This line can be added by Git if you run the git-commit command with
-the -s option.
-
-Notice that you can place your own `Signed-off-by` trailer when
-forwarding somebody else's patch with the above rules for
-D-C-O.  Indeed you are encouraged to do so.  Do not forget to
-place an in-body "From: " line at the beginning to properly attribute
-the change to its true author (see (2) above).
-
-This procedure originally came from the Linux kernel project, so our
-rule is quite similar to theirs, but what exactly it means to sign-off
-your patch differs from project to project, so it may be different
-from that of the project you are accustomed to.
-
-[[real-name]]
-Also notice that a real name is used in the `Signed-off-by` trailer. Please
-don't hide your real name.
-
-[[commit-trailers]]
-If you like, you can put extra tags at the end:
-
-. `Reported-by:` is used to credit someone who found the bug that
-  the patch attempts to fix.
-. `Acked-by:` says that the person who is more familiar with the area
-  the patch attempts to modify liked the patch.
-. `Reviewed-by:`, unlike the other tags, can only be offered by the
-  reviewer and means that she is completely satisfied that the patch
-  is ready for application.  It is usually offered only after a
-  detailed review.
-. `Tested-by:` is used to indicate that the person applied the patch
-  and found it to have the desired effect.
-
-You can also create your own tag or use one that's in common usage
-such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
-
 == Subsystems with dedicated maintainers
 
 Some parts of the system have dedicated maintainers with their own
-- 
2.31.1.909.g789bb6d90e


^ permalink raw reply	[flat|nested] 28+ messages in thread

* [PATCH 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions
  2021-05-12  8:44 [PATCH 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
  2021-05-12  8:45 ` [PATCH 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
@ 2021-05-12  8:45 ` Ævar Arnfjörð Bjarmason
  2021-05-12 12:24   ` Đoàn Trần Công Danh
  2021-05-12 22:40   ` Junio C Hamano
  2021-05-12  8:45 ` [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints Ævar Arnfjörð Bjarmason
  2021-06-07 11:03 ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
  3 siblings, 2 replies; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-05-12  8:45 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh,
	Ævar Arnfjörð Bjarmason

Replace the discussion of Travis CI added in
0e5d028a7a0 (Documentation: add setup instructions for Travis CI,
2016-05-02) with something that covers the GitHub Actions added in
889cacb6897 (ci: configure GitHub Actions for CI/PR, 2020-04-11).

The setup is trivial compared to using Travis, and it even works on
Windows (that "hopefully soon" comment was probably out-of-date on
Travis as well).

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/SubmittingPatches | 44 ++++++++++++---------------------
 1 file changed, 16 insertions(+), 28 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 2643062624..2aa217da9c 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -74,10 +74,9 @@ the feature triggers the new behavior when it should, and to show the
 feature does not trigger when it shouldn't.  After any code change, make
 sure that the entire test suite passes.
 
-If you have an account at GitHub (and you can get one for free to work
-on open source projects), you can use their Travis CI integration to
-test your changes on Linux, Mac (and hopefully soon Windows).  See
-GitHub-Travis CI hints section for details.
+If you have an account at GitHub pushing to a fork of
+https://github.com/git/git will use their CI integration to test your
+changes on Linux, Mac and Windows. See the GitHub CI section for details.
 
 Do not forget to update the documentation to describe the updated
 behavior and make sure that the resulting documentation set formats
@@ -451,12 +450,12 @@ their trees themselves.
   the status of various proposed changes.
 
 [[travis]]
-== GitHub-Travis CI hints
+== GitHub CI
 
-With an account at GitHub (you can get one for free to work on open
-source projects), you can use Travis CI to test your changes on Linux,
-Mac (and hopefully soon Windows).  You can find a successful example
-test build here: https://travis-ci.org/git/git/builds/120473209
+With an account at GitHub you can use GitHub CI to test your changes
+on Linux, Mac and Windows. See
+https://github.com/git/git/actions/workflows/main.yml for examples of
+recent CI runs.
 
 Follow these steps for the initial setup:
 
@@ -464,31 +463,20 @@ Follow these steps for the initial setup:
   You can find detailed instructions how to fork here:
   https://help.github.com/articles/fork-a-repo/
 
-. Open the Travis CI website: https://travis-ci.org
-
-. Press the "Sign in with GitHub" button.
-
-. Grant Travis CI permissions to access your GitHub account.
-  You can find more information about the required permissions here:
-  https://docs.travis-ci.com/user/github-oauth-scopes
-
-. Open your Travis CI profile page: https://travis-ci.org/profile
-
 . Enable Travis CI builds for your Git fork.
 
 After the initial setup, Travis CI will run whenever you push new changes
 to your fork of Git on GitHub.  You can monitor the test state of all your
-branches here: https://travis-ci.org/__<Your GitHub handle>__/git/branches
+branches here: https://github.com/<Your GitHub handle>/git/actions/workflows/main.yml
 
 If a branch did not pass all test cases then it is marked with a red
-cross.  In that case you can click on the failing Travis CI job and
-scroll all the way down in the log.  Find the line "<-- Click here to see
-detailed test output!" and click on the triangle next to the log line
-number to expand the detailed test output.  Here is such a failing
-example: https://travis-ci.org/git/git/jobs/122676187
-
-Fix the problem and push your fix to your Git fork.  This will trigger
-a new Travis CI build to ensure all tests pass.
+cross. In that case you can click on the failing job and navigate to
+"ci/run-build-and-tests.sh" and/or "ci/print-test-failures.sh". You
+can also download "Artifacts" which are tarred (or zipped) archives
+with test data relevant for debugging.
+
+Then fix the problem and push your fix to your Github fork. This will
+trigger a new CI build to ensure all tests pass.
 
 [[mua]]
 == MUA specific hints
-- 
2.31.1.909.g789bb6d90e


^ permalink raw reply	[flat|nested] 28+ messages in thread

* [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints
  2021-05-12  8:44 [PATCH 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
  2021-05-12  8:45 ` [PATCH 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
  2021-05-12  8:45 ` [PATCH 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
@ 2021-05-12  8:45 ` Ævar Arnfjörð Bjarmason
  2021-05-12 23:51   ` Dave Huseby
  2021-06-07 11:03 ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
  3 siblings, 1 reply; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-05-12  8:45 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh,
	Ævar Arnfjörð Bjarmason

Remove the whole section about configuring pine with
no-strip-whitespace-before-send.

There hasn't been a release of Pine since late 2005, in Alpine the
no-strip-whitespace-before-send switch is already the default.

This documentation was initially added in 9740d289ee7 (Update
SubmittingPatches to add MUA specific notes., 2005-08-26), at this
point it's safe to say that it's not useful to anyone anymore, let's
remove it.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/SubmittingPatches | 56 ---------------------------------
 1 file changed, 56 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 2aa217da9c..e616d20556 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -498,62 +498,6 @@ first patch.\n", if you really want to put in the patch e-mail,
 should come after the three-dash line that signals the end of the
 commit message.
 
-
-=== Pine
-
-(Johannes Schindelin)
-
-....
-I don't know how many people still use pine, but for those poor
-souls it may be good to mention that the quell-flowed-text is
-needed for recent versions.
-
-... the "no-strip-whitespace-before-send" option, too. AFAIK it
-was introduced in 4.60.
-....
-
-(Linus Torvalds)
-
-....
-And 4.58 needs at least this.
-
-diff-tree 8326dd8350be64ac7fc805f6563a1d61ad10d32c (from e886a61f76edf5410573e92e38ce22974f9c40f1)
-Author: Linus Torvalds <torvalds@g5.osdl.org>
-Date:   Mon Aug 15 17:23:51 2005 -0700
-
-    Fix pine whitespace-corruption bug
-
-    There's no excuse for unconditionally removing whitespace from
-    the pico buffers on close.
-
-diff --git a/pico/pico.c b/pico/pico.c
---- a/pico/pico.c
-+++ b/pico/pico.c
-@@ -219,7 +219,9 @@ PICO *pm;
-	    switch(pico_all_done){	/* prepare for/handle final events */
-	      case COMP_EXIT :		/* already confirmed */
-		packheader();
-+#if 0
-		stripwhitespace();
-+#endif
-		c |= COMP_EXIT;
-		break;
-....
-
-(Daniel Barkalow)
-
-....
-> A patch to SubmittingPatches, MUA specific help section for
-> users of Pine 4.63 would be very much appreciated.
-
-Ah, it looks like a recent version changed the default behavior to do the
-right thing, and inverted the sense of the configuration option. (Either
-that or Gentoo did it.) So you need to set the
-"no-strip-whitespace-before-send" option, unless the option you have is
-"strip-whitespace-before-send", in which case you should avoid checking
-it.
-....
-
 === Thunderbird, KMail, GMail
 
 See the MUA-SPECIFIC HINTS section of linkgit:git-format-patch[1].
-- 
2.31.1.909.g789bb6d90e


^ permalink raw reply	[flat|nested] 28+ messages in thread

* RE: [PATCH 1/3] SubmittingPatches: move discussion of Signed-off-by above "send"
  2021-05-12  8:45 ` [PATCH 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
@ 2021-05-12  9:29   ` Felipe Contreras
  2021-06-07 11:02     ` Ævar Arnfjörð Bjarmason
  0 siblings, 1 reply; 28+ messages in thread
From: Felipe Contreras @ 2021-05-12  9:29 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason, git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh,
	Ævar Arnfjörð Bjarmason

Ævar Arnfjörð Bjarmason wrote:
> +=== Certify your work by adding your `Signed-off-by` trailer
> +
> +To improve tracking of who did what, we ask you to certify that you
> +wrote the patch or have the right to pass it on under the same license
> +as ours, by "signing off" your patch.  Without sign-off, we cannot
> +accept your patches.

This may be me, but I would expect the phrase to make sense without the
comma:

> we ask you to certify that you wrote the patch ... by "signing off"
> your patch.

Whatever you put inside the ... is additional information that doesn't
negate the origina sentence.

So:

> To improve tracking of who did what, we ask you to certify that you
> wrote the patch--or have the right to pass it on under the same
> license as ours--by "signing off" your patch.

Cheers.

-- 
Felipe Contreras

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions
  2021-05-12  8:45 ` [PATCH 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
@ 2021-05-12 12:24   ` Đoàn Trần Công Danh
  2021-05-12 22:40   ` Junio C Hamano
  1 sibling, 0 replies; 28+ messages in thread
From: Đoàn Trần Công Danh @ 2021-05-12 12:24 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason
  Cc: git, Junio C Hamano, Dave Huseby, Lars Schneider

On 2021-05-12 10:45:01+0200, Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
>  If a branch did not pass all test cases then it is marked with a red
> -cross.  In that case you can click on the failing Travis CI job and
> -scroll all the way down in the log.  Find the line "<-- Click here to see
> -detailed test output!" and click on the triangle next to the log line
> -number to expand the detailed test output.  Here is such a failing
> -example: https://travis-ci.org/git/git/jobs/122676187
> -
> -Fix the problem and push your fix to your Git fork.  This will trigger
> -a new Travis CI build to ensure all tests pass.
> +cross. In that case you can click on the failing job and navigate to
> +"ci/run-build-and-tests.sh" and/or "ci/print-test-failures.sh". You
> +can also download "Artifacts" which are tarred (or zipped) archives
> +with test data relevant for debugging.
> +
> +Then fix the problem and push your fix to your Github fork. This will

Nit: s/Github/GitHub/

It's the brand.

-- 
Danh

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions
  2021-05-12  8:45 ` [PATCH 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
  2021-05-12 12:24   ` Đoàn Trần Công Danh
@ 2021-05-12 22:40   ` Junio C Hamano
  1 sibling, 0 replies; 28+ messages in thread
From: Junio C Hamano @ 2021-05-12 22:40 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason
  Cc: git, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh

Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:

> -If you have an account at GitHub (and you can get one for free to work
> -on open source projects), you can use their Travis CI integration to
> -test your changes on Linux, Mac (and hopefully soon Windows).  See
> -GitHub-Travis CI hints section for details.
> +If you have an account at GitHub pushing to a fork of
> +https://github.com/git/git will use their CI integration to test your
> +changes on Linux, Mac and Windows. See the GitHub CI section for details.

s/If you have an account at GitHub pushing/Pushing/

Whether pushing to a fork is possible is not even need to be said
with "If you have an account" here, as you begin the "GitHub CI"
section with "With an account at GitHub".

    Side note: I initially started to point out the lack of comma
    before "pushing", but after re-reading the paragraph, realized
    that the part before that missing comma is better left out.

> @@ -451,12 +450,12 @@ their trees themselves.
>    the status of various proposed changes.
>  
>  [[travis]]
> -== GitHub-Travis CI hints
> +== GitHub CI
>  
> -With an account at GitHub (you can get one for free to work on open
> -source projects), you can use Travis CI to test your changes on Linux,
> -Mac (and hopefully soon Windows).  You can find a successful example
> -test build here: https://travis-ci.org/git/git/builds/120473209
> +With an account at GitHub you can use GitHub CI to test your changes

Here, insert comma before "you can use".

> +on Linux, Mac and Windows. See
> +https://github.com/git/git/actions/workflows/main.yml for examples of
> +recent CI runs.

Thanks.

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints
  2021-05-12  8:45 ` [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints Ævar Arnfjörð Bjarmason
@ 2021-05-12 23:51   ` Dave Huseby
  2021-05-13  6:38     ` Felipe Contreras
  2021-05-13  7:50     ` Ævar Arnfjörð Bjarmason
  0 siblings, 2 replies; 28+ messages in thread
From: Dave Huseby @ 2021-05-12 23:51 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason
  Cc: git, Junio C Hamano, Lars Schneider,
	Đoàn Trần Công Danh

On 12.05.2021 10:45, Ævar Arnfjörð Bjarmason wrote:
>There hasn't been a release of Pine since late 2005, in Alpine the
>no-strip-whitespace-before-send switch is already the default.
>
>This documentation was initially added in 9740d289ee7 (Update
>SubmittingPatches to add MUA specific notes., 2005-08-26), at this
>point it's safe to say that it's not useful to anyone anymore, let's
>remove it.

What is wrong with keeping it in there? My latest version of the
etiquette patch moves my Mutt MUA config notes to this section on MUAs.
It could eventually become a somewhat exhaustive reference of MUA
tweaks. Old tools may not be popular but they sometime have niche uses
and/or userbases. My recent switch to Mutt has been mixed at best and I
went back to take a look at mh/nmh to see if I liked it better and I may
give it a go for a while to kick the tires, likely making me the only
developer that uses nmh.

Keeping these notes on old tools--at the bottom of documentation no
less--seems to have little to no "cruft cost" with the potential of
helping somebody someday, even if nostalgia is the only reason.

Cheers!
Dave

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints
  2021-05-12 23:51   ` Dave Huseby
@ 2021-05-13  6:38     ` Felipe Contreras
  2021-05-13 14:45       ` Dave Huseby
  2021-05-13  7:50     ` Ævar Arnfjörð Bjarmason
  1 sibling, 1 reply; 28+ messages in thread
From: Felipe Contreras @ 2021-05-13  6:38 UTC (permalink / raw)
  To: Dave Huseby, Ævar Arnfjörð Bjarmason
  Cc: git, Junio C Hamano, Lars Schneider,
	Đoàn Trần Công Danh

Dave Huseby wrote:
> On 12.05.2021 10:45, Ævar Arnfjörð Bjarmason wrote:
> >There hasn't been a release of Pine since late 2005, in Alpine the
> >no-strip-whitespace-before-send switch is already the default.
> >
> >This documentation was initially added in 9740d289ee7 (Update
> >SubmittingPatches to add MUA specific notes., 2005-08-26), at this
> >point it's safe to say that it's not useful to anyone anymore, let's
> >remove it.
> 
> What is wrong with keeping it in there? My latest version of the
> etiquette patch moves my Mutt MUA config notes to this section on MUAs.
> It could eventually become a somewhat exhaustive reference of MUA
> tweaks. Old tools may not be popular but they sometime have niche uses
> and/or userbases. My recent switch to Mutt has been mixed at best and I
> went back to take a look at mh/nmh to see if I liked it better and I may
> give it a go for a while to kick the tires, likely making me the only
> developer that uses nmh.

Have you tried notmuch? There's multiple clients.

-- 
Felipe Contreras

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints
  2021-05-12 23:51   ` Dave Huseby
  2021-05-13  6:38     ` Felipe Contreras
@ 2021-05-13  7:50     ` Ævar Arnfjörð Bjarmason
  2021-05-13 14:42       ` Dave Huseby
  1 sibling, 1 reply; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-05-13  7:50 UTC (permalink / raw)
  To: Dave Huseby
  Cc: git, Junio C Hamano, Lars Schneider,
	Đoàn Trần Công Danh


On Wed, May 12 2021, Dave Huseby wrote:

> On 12.05.2021 10:45, Ævar Arnfjörð Bjarmason wrote:
>>There hasn't been a release of Pine since late 2005, in Alpine the
>>no-strip-whitespace-before-send switch is already the default.
>>
>>This documentation was initially added in 9740d289ee7 (Update
>>SubmittingPatches to add MUA specific notes., 2005-08-26), at this
>>point it's safe to say that it's not useful to anyone anymore, let's
>>remove it.
>
> What is wrong with keeping it in there? My latest version of the
> etiquette patch moves my Mutt MUA config notes to this section on MUAs.
> It could eventually become a somewhat exhaustive reference of MUA
> tweaks. Old tools may not be popular but they sometime have niche uses
> and/or userbases. My recent switch to Mutt has been mixed at best and I
> went back to take a look at mh/nmh to see if I liked it better and I may
> give it a go for a while to kick the tires, likely making me the only
> developer that uses nmh.
>
> Keeping these notes on old tools--at the bottom of documentation no
> less--seems to have little to no "cruft cost" with the potential of
> helping somebody someday, even if nostalgia is the only reason.

I think there's an inherent value in keeping guides like these short and
to the point, and only including those things relevant to most readers.

So I do think that if we're including such a niche guide we're better
off splitting it into another file and linking to it, same with the
whole guide in SubmittingPatches now teaching people to manually craft a
patch without using git-format-patch, another obscure edge case we give
too much space / causes distraction.

In this case though I think saying anything about pine crosses the line
from niche to obscure archaeology. We're inlining a patch for abandoned
software that has a replacement. If we're going to say anything about
Pine in such a list I think it should be:

    Pine: abandoned and has known flowed text bugs, use its successor
    alpine or another MUA instead.

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints
  2021-05-13  7:50     ` Ævar Arnfjörð Bjarmason
@ 2021-05-13 14:42       ` Dave Huseby
  0 siblings, 0 replies; 28+ messages in thread
From: Dave Huseby @ 2021-05-13 14:42 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason
  Cc: git, Junio C Hamano, Lars Schneider,
	Đoàn Trần Công Danh

On 13.05.2021 09:50, Ævar Arnfjörð Bjarmason wrote:
>So I do think that if we're including such a niche guide we're better
>off splitting it into another file and linking to it, same with the
>whole guide in SubmittingPatches now teaching people to manually craft a
>patch without using git-format-patch, another obscure edge case we give
>too much space / causes distraction.

I agree with you on this approach. There's one other subtle distinction
that I realized last night and that is the distinction between best
practices for using email for working *with* Git and using email for
working *on* Git. I think Junio pointed it out in the thread on writing
down the mailing list etiquette that the Git project itself has its own
etiquette that is likely different than the etiquette of other projects
that use Git and email. Maybe we should make that distinction clearer.

SubmittingPatches and MyFirstContribution.txt are clearly about using
email and Git to work *on* Git. So is the MailingListEtiquette.txt file
I'm proposing in the other thread. Some of the tips that would go into
MUA-specific files would only apply to using email and Git to work *on*
Git while others are likely to be about using email and Git to work
*with* Git. It is subtle but important.

IMO, I think we should have a Documentation/WorkingOnGit subfolder where
all of the documentation for the Git project resides just to clarify the
distinction.

>In this case though I think saying anything about pine crosses the line
>from niche to obscure archaeology. We're inlining a patch for abandoned
>software that has a replacement. If we're going to say anything about
>Pine in such a list I think it should be:
>
>    Pine: abandoned and has known flowed text bugs, use its successor
>    alpine or another MUA instead.

I'm good with this. I suppose the old docs are always in Git history.

Cheers!
Dave

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints
  2021-05-13  6:38     ` Felipe Contreras
@ 2021-05-13 14:45       ` Dave Huseby
  2021-05-13 20:08         ` Felipe Contreras
  0 siblings, 1 reply; 28+ messages in thread
From: Dave Huseby @ 2021-05-13 14:45 UTC (permalink / raw)
  To: Felipe Contreras
  Cc: Ævar Arnfjörð Bjarmason, git, Junio C Hamano,
	Lars Schneider, Đoàn Trần Công Danh

On 13.05.2021 01:38, Felipe Contreras wrote:
>Have you tried notmuch? There's multiple clients.

I haven't. Is that popular for mailing list style Git work? When I was
part of the Tor Project back in the day, a couple of the main developers
used nmh and custom python scripts to great effect. I was always
impressed with the CLI-fu they had.

I decided to try Mutt after decades of using Alpine and Pine before
that. I'm open to something that is more congruent with the way I prefer
to work. Where do you recomment I start with notmuch? Tutorials?
Favorite client?

Cheers!
Dave

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints
  2021-05-13 14:45       ` Dave Huseby
@ 2021-05-13 20:08         ` Felipe Contreras
  2021-05-17 19:05           ` Dave Huseby
  0 siblings, 1 reply; 28+ messages in thread
From: Felipe Contreras @ 2021-05-13 20:08 UTC (permalink / raw)
  To: Dave Huseby, Felipe Contreras
  Cc: Ævar Arnfjörð Bjarmason, git, Junio C Hamano,
	Lars Schneider, Đoàn Trần Công Danh

Dave Huseby wrote:
> On 13.05.2021 01:38, Felipe Contreras wrote:
> >Have you tried notmuch? There's multiple clients.
> 
> I haven't. Is that popular for mailing list style Git work? When I was
> part of the Tor Project back in the day, a couple of the main developers
> used nmh and custom python scripts to great effect. I was always
> impressed with the CLI-fu they had.

The notmuch cli-fu is superior to anything else, by far (IMO).

> Where do you recomment I start with notmuch? Tutorials?

The getting started guide [1], of course.

> Favorite client?

The one I wrote ;) notmuch-vim [2] [3]

Cheers.

[1] https://notmuchmail.org/getting-started/
[2] https://github.com/felipec/notmuch-vim
[3] https://www.youtube.com/watch?v=JGD7IbZmnIs

-- 
Felipe Contreras

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints
  2021-05-13 20:08         ` Felipe Contreras
@ 2021-05-17 19:05           ` Dave Huseby
  0 siblings, 0 replies; 28+ messages in thread
From: Dave Huseby @ 2021-05-17 19:05 UTC (permalink / raw)
  To: Felipe Contreras
  Cc: Ævar Arnfjörð Bjarmason, git, Junio C Hamano,
	Lars Schneider, Đoàn Trần Công Danh

On 13.05.2021 15:08, Felipe Contreras wrote:
>Cheers.
>
>[1] https://notmuchmail.org/getting-started/
>[2] https://github.com/felipec/notmuch-vim
>[3] https://www.youtube.com/watch?v=JGD7IbZmnIs

Oh wow. As a fellow vim user this looks amazing. I had no idea this
existed. Thank you for sharing.

Cheers!
Dave

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH 1/3] SubmittingPatches: move discussion of Signed-off-by above "send"
  2021-05-12  9:29   ` Felipe Contreras
@ 2021-06-07 11:02     ` Ævar Arnfjörð Bjarmason
  2021-06-07 16:16       ` Felipe Contreras
  0 siblings, 1 reply; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-06-07 11:02 UTC (permalink / raw)
  To: Felipe Contreras
  Cc: git, Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh


On Wed, May 12 2021, Felipe Contreras wrote:

> Ævar Arnfjörð Bjarmason wrote:
>> +=== Certify your work by adding your `Signed-off-by` trailer
>> +
>> +To improve tracking of who did what, we ask you to certify that you
>> +wrote the patch or have the right to pass it on under the same license
>> +as ours, by "signing off" your patch.  Without sign-off, we cannot
>> +accept your patches.
>
> This may be me, but I would expect the phrase to make sense without the
> comma:
>
>> we ask you to certify that you wrote the patch ... by "signing off"
>> your patch.
>
> Whatever you put inside the ... is additional information that doesn't
> negate the origina sentence.
>
> So:
>
>> To improve tracking of who did what, we ask you to certify that you
>> wrote the patch--or have the right to pass it on under the same
>> license as ours--by "signing off" your patch.
>
> Cheers.

I think these are good notes, but in this commit I'm merely moving
existing lines around in the file so that 2/3 and 3/3 make sense, so
I've left any change to the existing text out of v2 of this series.

I welcome an effort to improve the existing wording, but I think it's
better if you submit your own patch-on-top for that, I'd rather not get
bogged down in that any more than I already am :)

^ permalink raw reply	[flat|nested] 28+ messages in thread

* [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes
  2021-05-12  8:44 [PATCH 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
                   ` (2 preceding siblings ...)
  2021-05-12  8:45 ` [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints Ævar Arnfjörð Bjarmason
@ 2021-06-07 11:03 ` Ævar Arnfjörð Bjarmason
  2021-06-07 11:03   ` [PATCH v2 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
                     ` (4 more replies)
  3 siblings, 5 replies; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-06-07 11:03 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh, Felipe Contreras,
	Ævar Arnfjörð Bjarmason

A few minor updates to SubmittingPatches spotted while paging through
it the other day (or other month, given the delay until v2).

See
https://lore.kernel.org/git/cover-0.3-0000000000-20210512T084137Z-avarab@gmail.com/
for the v1 discussion. This hopefully addresses all the outstanding
comments with it.

Ævar Arnfjörð Bjarmason (3):
  SubmittingPatches: move discussion of Signed-off-by above "send"
  SubmittingPatches: replace discussion of Travis with GitHub Actions
  SubmittingPatches: remove pine-specific hints from MUA hints

 Documentation/SubmittingPatches | 256 ++++++++++++--------------------
 1 file changed, 97 insertions(+), 159 deletions(-)

Range-diff against v1:
1:  d18a3caa07 = 1:  9fa5437bb5 SubmittingPatches: move discussion of Signed-off-by above "send"
2:  7add00cc87 ! 2:  7d5d2854e3 SubmittingPatches: replace discussion of Travis with GitHub Actions
    @@ Documentation/SubmittingPatches: the feature triggers the new behavior when it s
     -on open source projects), you can use their Travis CI integration to
     -test your changes on Linux, Mac (and hopefully soon Windows).  See
     -GitHub-Travis CI hints section for details.
    -+If you have an account at GitHub pushing to a fork of
    -+https://github.com/git/git will use their CI integration to test your
    -+changes on Linux, Mac and Windows. See the GitHub CI section for details.
    ++Pushing to a fork of https://github.com/git/git will use their CI
    ++integration to test your changes on Linux, Mac and Windows. See the
    ++GitHub CI section for details.
      
      Do not forget to update the documentation to describe the updated
      behavior and make sure that the resulting documentation set formats
    @@ Documentation/SubmittingPatches: their trees themselves.
     -source projects), you can use Travis CI to test your changes on Linux,
     -Mac (and hopefully soon Windows).  You can find a successful example
     -test build here: https://travis-ci.org/git/git/builds/120473209
    -+With an account at GitHub you can use GitHub CI to test your changes
    ++With an account at GitHub, you can use GitHub CI to test your changes
     +on Linux, Mac and Windows. See
     +https://github.com/git/git/actions/workflows/main.yml for examples of
     +recent CI runs.
    @@ Documentation/SubmittingPatches: Follow these steps for the initial setup:
     +can also download "Artifacts" which are tarred (or zipped) archives
     +with test data relevant for debugging.
     +
    -+Then fix the problem and push your fix to your Github fork. This will
    ++Then fix the problem and push your fix to your GitHub fork. This will
     +trigger a new CI build to ensure all tests pass.
      
      [[mua]]
3:  9da5bc4a0c ! 3:  a61885a198 SubmittingPatches: remove pine-specific hints from MUA hints
    @@ Metadata
      ## Commit message ##
         SubmittingPatches: remove pine-specific hints from MUA hints
     
    -    Remove the whole section about configuring pine with
    -    no-strip-whitespace-before-send.
    +    Replace the whole section about configuring pine with
    +    no-strip-whitespace-before-send with a note that users should use
    +    another MUA instead.
     
         There hasn't been a release of Pine since late 2005, in Alpine the
         no-strip-whitespace-before-send switch is already the default.
     
         This documentation was initially added in 9740d289ee7 (Update
    -    SubmittingPatches to add MUA specific notes., 2005-08-26), at this
    +    SubmittingPatches to add MUA specific notes., 2005-08-26). At this
         point it's safe to say that it's not useful to anyone anymore, let's
         remove it.
     
         Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
     
      ## Documentation/SubmittingPatches ##
    -@@ Documentation/SubmittingPatches: first patch.\n", if you really want to put in the patch e-mail,
    - should come after the three-dash line that signals the end of the
    - commit message.
    +@@ Documentation/SubmittingPatches: commit message.
    + 
    + === Pine
      
    --
    --=== Pine
    --
     -(Johannes Schindelin)
     -
     -....
    @@ -219,7 +219,9 @@ PICO *pm;
     -"strip-whitespace-before-send", in which case you should avoid checking
     -it.
     -....
    --
    ++Abandoned by its uptsream and has known flowed text bugs, use its
    ++successor alpine or another MUA instead.
    + 
      === Thunderbird, KMail, GMail
      
    - See the MUA-SPECIFIC HINTS section of linkgit:git-format-patch[1].
-- 
2.32.0.rc3.434.gd8aed1f08a7


^ permalink raw reply	[flat|nested] 28+ messages in thread

* [PATCH v2 1/3] SubmittingPatches: move discussion of Signed-off-by above "send"
  2021-06-07 11:03 ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
@ 2021-06-07 11:03   ` Ævar Arnfjörð Bjarmason
  2021-06-07 15:58     ` Đoàn Trần Công Danh
  2021-06-07 11:03   ` [PATCH v2 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
                     ` (3 subsequent siblings)
  4 siblings, 1 reply; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-06-07 11:03 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh, Felipe Contreras,
	Ævar Arnfjörð Bjarmason

Move the section discussing the addition of a SOB trailer above the
section that discusses generating the patch itself. This makes sense
as we don't want someone to go through the process of "git
format-patch", only to realize late that they should have used "git
commit -s" or equivalent.

This is a move-only change, no lines here are are being altered, only
moved around.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/SubmittingPatches | 160 ++++++++++++++++----------------
 1 file changed, 80 insertions(+), 80 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 55287d72e0..2643062624 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -167,6 +167,86 @@ or, on an older version of Git without support for --pretty=reference:
 	git show -s --date=short --pretty='format:%h (%s, %ad)' <commit>
 ....
 
+[[sign-off]]
+=== Certify your work by adding your `Signed-off-by` trailer
+
+To improve tracking of who did what, we ask you to certify that you
+wrote the patch or have the right to pass it on under the same license
+as ours, by "signing off" your patch.  Without sign-off, we cannot
+accept your patches.
+
+If (and only if) you certify the below D-C-O:
+
+[[dco]]
+.Developer's Certificate of Origin 1.1
+____
+By making a contribution to this project, I certify that:
+
+a. The contribution was created in whole or in part by me and I
+   have the right to submit it under the open source license
+   indicated in the file; or
+
+b. The contribution is based upon previous work that, to the best
+   of my knowledge, is covered under an appropriate open source
+   license and I have the right under that license to submit that
+   work with modifications, whether created in whole or in part
+   by me, under the same open source license (unless I am
+   permitted to submit under a different license), as indicated
+   in the file; or
+
+c. The contribution was provided directly to me by some other
+   person who certified (a), (b) or (c) and I have not modified
+   it.
+
+d. I understand and agree that this project and the contribution
+   are public and that a record of the contribution (including all
+   personal information I submit with it, including my sign-off) is
+   maintained indefinitely and may be redistributed consistent with
+   this project or the open source license(s) involved.
+____
+
+you add a "Signed-off-by" trailer to your commit, that looks like
+this:
+
+....
+	Signed-off-by: Random J Developer <random@developer.example.org>
+....
+
+This line can be added by Git if you run the git-commit command with
+the -s option.
+
+Notice that you can place your own `Signed-off-by` trailer when
+forwarding somebody else's patch with the above rules for
+D-C-O.  Indeed you are encouraged to do so.  Do not forget to
+place an in-body "From: " line at the beginning to properly attribute
+the change to its true author (see (2) above).
+
+This procedure originally came from the Linux kernel project, so our
+rule is quite similar to theirs, but what exactly it means to sign-off
+your patch differs from project to project, so it may be different
+from that of the project you are accustomed to.
+
+[[real-name]]
+Also notice that a real name is used in the `Signed-off-by` trailer. Please
+don't hide your real name.
+
+[[commit-trailers]]
+If you like, you can put extra tags at the end:
+
+. `Reported-by:` is used to credit someone who found the bug that
+  the patch attempts to fix.
+. `Acked-by:` says that the person who is more familiar with the area
+  the patch attempts to modify liked the patch.
+. `Reviewed-by:`, unlike the other tags, can only be offered by the
+  reviewer and means that she is completely satisfied that the patch
+  is ready for application.  It is usually offered only after a
+  detailed review.
+. `Tested-by:` is used to indicate that the person applied the patch
+  and found it to have the desired effect.
+
+You can also create your own tag or use one that's in common usage
+such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
+
 [[git-tools]]
 === Generate your patch using Git tools out of your commits.
 
@@ -302,86 +382,6 @@ Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and
 `Tested-by:` lines as necessary to credit people who helped your
 patch, and "cc:" them when sending such a final version for inclusion.
 
-[[sign-off]]
-=== Certify your work by adding your `Signed-off-by` trailer
-
-To improve tracking of who did what, we ask you to certify that you
-wrote the patch or have the right to pass it on under the same license
-as ours, by "signing off" your patch.  Without sign-off, we cannot
-accept your patches.
-
-If (and only if) you certify the below D-C-O:
-
-[[dco]]
-.Developer's Certificate of Origin 1.1
-____
-By making a contribution to this project, I certify that:
-
-a. The contribution was created in whole or in part by me and I
-   have the right to submit it under the open source license
-   indicated in the file; or
-
-b. The contribution is based upon previous work that, to the best
-   of my knowledge, is covered under an appropriate open source
-   license and I have the right under that license to submit that
-   work with modifications, whether created in whole or in part
-   by me, under the same open source license (unless I am
-   permitted to submit under a different license), as indicated
-   in the file; or
-
-c. The contribution was provided directly to me by some other
-   person who certified (a), (b) or (c) and I have not modified
-   it.
-
-d. I understand and agree that this project and the contribution
-   are public and that a record of the contribution (including all
-   personal information I submit with it, including my sign-off) is
-   maintained indefinitely and may be redistributed consistent with
-   this project or the open source license(s) involved.
-____
-
-you add a "Signed-off-by" trailer to your commit, that looks like
-this:
-
-....
-	Signed-off-by: Random J Developer <random@developer.example.org>
-....
-
-This line can be added by Git if you run the git-commit command with
-the -s option.
-
-Notice that you can place your own `Signed-off-by` trailer when
-forwarding somebody else's patch with the above rules for
-D-C-O.  Indeed you are encouraged to do so.  Do not forget to
-place an in-body "From: " line at the beginning to properly attribute
-the change to its true author (see (2) above).
-
-This procedure originally came from the Linux kernel project, so our
-rule is quite similar to theirs, but what exactly it means to sign-off
-your patch differs from project to project, so it may be different
-from that of the project you are accustomed to.
-
-[[real-name]]
-Also notice that a real name is used in the `Signed-off-by` trailer. Please
-don't hide your real name.
-
-[[commit-trailers]]
-If you like, you can put extra tags at the end:
-
-. `Reported-by:` is used to credit someone who found the bug that
-  the patch attempts to fix.
-. `Acked-by:` says that the person who is more familiar with the area
-  the patch attempts to modify liked the patch.
-. `Reviewed-by:`, unlike the other tags, can only be offered by the
-  reviewer and means that she is completely satisfied that the patch
-  is ready for application.  It is usually offered only after a
-  detailed review.
-. `Tested-by:` is used to indicate that the person applied the patch
-  and found it to have the desired effect.
-
-You can also create your own tag or use one that's in common usage
-such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
-
 == Subsystems with dedicated maintainers
 
 Some parts of the system have dedicated maintainers with their own
-- 
2.32.0.rc3.434.gd8aed1f08a7


^ permalink raw reply	[flat|nested] 28+ messages in thread

* [PATCH v2 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions
  2021-06-07 11:03 ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
  2021-06-07 11:03   ` [PATCH v2 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
@ 2021-06-07 11:03   ` Ævar Arnfjörð Bjarmason
  2021-06-07 17:25     ` SZEDER Gábor
  2021-06-07 11:03   ` [PATCH v2 3/3] SubmittingPatches: remove pine-specific hints from MUA hints Ævar Arnfjörð Bjarmason
                     ` (2 subsequent siblings)
  4 siblings, 1 reply; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-06-07 11:03 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh, Felipe Contreras,
	Ævar Arnfjörð Bjarmason

Replace the discussion of Travis CI added in
0e5d028a7a0 (Documentation: add setup instructions for Travis CI,
2016-05-02) with something that covers the GitHub Actions added in
889cacb6897 (ci: configure GitHub Actions for CI/PR, 2020-04-11).

The setup is trivial compared to using Travis, and it even works on
Windows (that "hopefully soon" comment was probably out-of-date on
Travis as well).

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/SubmittingPatches | 44 ++++++++++++---------------------
 1 file changed, 16 insertions(+), 28 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 2643062624..e372d17673 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -74,10 +74,9 @@ the feature triggers the new behavior when it should, and to show the
 feature does not trigger when it shouldn't.  After any code change, make
 sure that the entire test suite passes.
 
-If you have an account at GitHub (and you can get one for free to work
-on open source projects), you can use their Travis CI integration to
-test your changes on Linux, Mac (and hopefully soon Windows).  See
-GitHub-Travis CI hints section for details.
+Pushing to a fork of https://github.com/git/git will use their CI
+integration to test your changes on Linux, Mac and Windows. See the
+GitHub CI section for details.
 
 Do not forget to update the documentation to describe the updated
 behavior and make sure that the resulting documentation set formats
@@ -451,12 +450,12 @@ their trees themselves.
   the status of various proposed changes.
 
 [[travis]]
-== GitHub-Travis CI hints
+== GitHub CI
 
-With an account at GitHub (you can get one for free to work on open
-source projects), you can use Travis CI to test your changes on Linux,
-Mac (and hopefully soon Windows).  You can find a successful example
-test build here: https://travis-ci.org/git/git/builds/120473209
+With an account at GitHub, you can use GitHub CI to test your changes
+on Linux, Mac and Windows. See
+https://github.com/git/git/actions/workflows/main.yml for examples of
+recent CI runs.
 
 Follow these steps for the initial setup:
 
@@ -464,31 +463,20 @@ Follow these steps for the initial setup:
   You can find detailed instructions how to fork here:
   https://help.github.com/articles/fork-a-repo/
 
-. Open the Travis CI website: https://travis-ci.org
-
-. Press the "Sign in with GitHub" button.
-
-. Grant Travis CI permissions to access your GitHub account.
-  You can find more information about the required permissions here:
-  https://docs.travis-ci.com/user/github-oauth-scopes
-
-. Open your Travis CI profile page: https://travis-ci.org/profile
-
 . Enable Travis CI builds for your Git fork.
 
 After the initial setup, Travis CI will run whenever you push new changes
 to your fork of Git on GitHub.  You can monitor the test state of all your
-branches here: https://travis-ci.org/__<Your GitHub handle>__/git/branches
+branches here: https://github.com/<Your GitHub handle>/git/actions/workflows/main.yml
 
 If a branch did not pass all test cases then it is marked with a red
-cross.  In that case you can click on the failing Travis CI job and
-scroll all the way down in the log.  Find the line "<-- Click here to see
-detailed test output!" and click on the triangle next to the log line
-number to expand the detailed test output.  Here is such a failing
-example: https://travis-ci.org/git/git/jobs/122676187
-
-Fix the problem and push your fix to your Git fork.  This will trigger
-a new Travis CI build to ensure all tests pass.
+cross. In that case you can click on the failing job and navigate to
+"ci/run-build-and-tests.sh" and/or "ci/print-test-failures.sh". You
+can also download "Artifacts" which are tarred (or zipped) archives
+with test data relevant for debugging.
+
+Then fix the problem and push your fix to your GitHub fork. This will
+trigger a new CI build to ensure all tests pass.
 
 [[mua]]
 == MUA specific hints
-- 
2.32.0.rc3.434.gd8aed1f08a7


^ permalink raw reply	[flat|nested] 28+ messages in thread

* [PATCH v2 3/3] SubmittingPatches: remove pine-specific hints from MUA hints
  2021-06-07 11:03 ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
  2021-06-07 11:03   ` [PATCH v2 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
  2021-06-07 11:03   ` [PATCH v2 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
@ 2021-06-07 11:03   ` Ævar Arnfjörð Bjarmason
  2021-06-07 21:49     ` Johannes Schindelin
  2021-06-08  3:50   ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Junio C Hamano
  2021-07-22 12:11   ` [PATCH v3 0/2] SubmittingPatches: talk about GitHub CI, not Travis + move-only Ævar Arnfjörð Bjarmason
  4 siblings, 1 reply; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-06-07 11:03 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh, Felipe Contreras,
	Ævar Arnfjörð Bjarmason

Replace the whole section about configuring pine with
no-strip-whitespace-before-send with a note that users should use
another MUA instead.

There hasn't been a release of Pine since late 2005, in Alpine the
no-strip-whitespace-before-send switch is already the default.

This documentation was initially added in 9740d289ee7 (Update
SubmittingPatches to add MUA specific notes., 2005-08-26). At this
point it's safe to say that it's not useful to anyone anymore, let's
remove it.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/SubmittingPatches | 54 ++-------------------------------
 1 file changed, 2 insertions(+), 52 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index e372d17673..9c859dcfef 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -501,58 +501,8 @@ commit message.
 
 === Pine
 
-(Johannes Schindelin)
-
-....
-I don't know how many people still use pine, but for those poor
-souls it may be good to mention that the quell-flowed-text is
-needed for recent versions.
-
-... the "no-strip-whitespace-before-send" option, too. AFAIK it
-was introduced in 4.60.
-....
-
-(Linus Torvalds)
-
-....
-And 4.58 needs at least this.
-
-diff-tree 8326dd8350be64ac7fc805f6563a1d61ad10d32c (from e886a61f76edf5410573e92e38ce22974f9c40f1)
-Author: Linus Torvalds <torvalds@g5.osdl.org>
-Date:   Mon Aug 15 17:23:51 2005 -0700
-
-    Fix pine whitespace-corruption bug
-
-    There's no excuse for unconditionally removing whitespace from
-    the pico buffers on close.
-
-diff --git a/pico/pico.c b/pico/pico.c
---- a/pico/pico.c
-+++ b/pico/pico.c
-@@ -219,7 +219,9 @@ PICO *pm;
-	    switch(pico_all_done){	/* prepare for/handle final events */
-	      case COMP_EXIT :		/* already confirmed */
-		packheader();
-+#if 0
-		stripwhitespace();
-+#endif
-		c |= COMP_EXIT;
-		break;
-....
-
-(Daniel Barkalow)
-
-....
-> A patch to SubmittingPatches, MUA specific help section for
-> users of Pine 4.63 would be very much appreciated.
-
-Ah, it looks like a recent version changed the default behavior to do the
-right thing, and inverted the sense of the configuration option. (Either
-that or Gentoo did it.) So you need to set the
-"no-strip-whitespace-before-send" option, unless the option you have is
-"strip-whitespace-before-send", in which case you should avoid checking
-it.
-....
+Abandoned by its uptsream and has known flowed text bugs, use its
+successor alpine or another MUA instead.
 
 === Thunderbird, KMail, GMail
 
-- 
2.32.0.rc3.434.gd8aed1f08a7


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH v2 1/3] SubmittingPatches: move discussion of Signed-off-by above "send"
  2021-06-07 11:03   ` [PATCH v2 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
@ 2021-06-07 15:58     ` Đoàn Trần Công Danh
  0 siblings, 0 replies; 28+ messages in thread
From: Đoàn Trần Công Danh @ 2021-06-07 15:58 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason
  Cc: git, Junio C Hamano, Dave Huseby, Lars Schneider, Felipe Contreras

[-- Attachment #1: Type: text/plain, Size: 8569 bytes --]

On 2021-06-07 13:03:41+0200, Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
> Move the section discussing the addition of a SOB trailer above the
> section that discusses generating the patch itself. This makes sense
> as we don't want someone to go through the process of "git
> format-patch", only to realize late that they should have used "git
> commit -s" or equivalent.
> 
> This is a move-only change, no lines here are are being altered, only

Nitpick: s/are are/are/;

Otherwise, the move makes sense to me.

> moved around.
> 
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
> ---
>  Documentation/SubmittingPatches | 160 ++++++++++++++++----------------
>  1 file changed, 80 insertions(+), 80 deletions(-)
> 
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> index 55287d72e0..2643062624 100644
> --- a/Documentation/SubmittingPatches
> +++ b/Documentation/SubmittingPatches
> @@ -167,6 +167,86 @@ or, on an older version of Git without support for --pretty=reference:
>  	git show -s --date=short --pretty='format:%h (%s, %ad)' <commit>
>  ....
>  
> +[[sign-off]]
> +=== Certify your work by adding your `Signed-off-by` trailer
> +
> +To improve tracking of who did what, we ask you to certify that you
> +wrote the patch or have the right to pass it on under the same license
> +as ours, by "signing off" your patch.  Without sign-off, we cannot
> +accept your patches.
> +
> +If (and only if) you certify the below D-C-O:
> +
> +[[dco]]
> +.Developer's Certificate of Origin 1.1
> +____
> +By making a contribution to this project, I certify that:
> +
> +a. The contribution was created in whole or in part by me and I
> +   have the right to submit it under the open source license
> +   indicated in the file; or
> +
> +b. The contribution is based upon previous work that, to the best
> +   of my knowledge, is covered under an appropriate open source
> +   license and I have the right under that license to submit that
> +   work with modifications, whether created in whole or in part
> +   by me, under the same open source license (unless I am
> +   permitted to submit under a different license), as indicated
> +   in the file; or
> +
> +c. The contribution was provided directly to me by some other
> +   person who certified (a), (b) or (c) and I have not modified
> +   it.
> +
> +d. I understand and agree that this project and the contribution
> +   are public and that a record of the contribution (including all
> +   personal information I submit with it, including my sign-off) is
> +   maintained indefinitely and may be redistributed consistent with
> +   this project or the open source license(s) involved.
> +____
> +
> +you add a "Signed-off-by" trailer to your commit, that looks like
> +this:
> +
> +....
> +	Signed-off-by: Random J Developer <random@developer.example.org>
> +....
> +
> +This line can be added by Git if you run the git-commit command with
> +the -s option.
> +
> +Notice that you can place your own `Signed-off-by` trailer when
> +forwarding somebody else's patch with the above rules for
> +D-C-O.  Indeed you are encouraged to do so.  Do not forget to
> +place an in-body "From: " line at the beginning to properly attribute
> +the change to its true author (see (2) above).
> +
> +This procedure originally came from the Linux kernel project, so our
> +rule is quite similar to theirs, but what exactly it means to sign-off
> +your patch differs from project to project, so it may be different
> +from that of the project you are accustomed to.
> +
> +[[real-name]]
> +Also notice that a real name is used in the `Signed-off-by` trailer. Please
> +don't hide your real name.
> +
> +[[commit-trailers]]
> +If you like, you can put extra tags at the end:
> +
> +. `Reported-by:` is used to credit someone who found the bug that
> +  the patch attempts to fix.
> +. `Acked-by:` says that the person who is more familiar with the area
> +  the patch attempts to modify liked the patch.
> +. `Reviewed-by:`, unlike the other tags, can only be offered by the
> +  reviewer and means that she is completely satisfied that the patch
> +  is ready for application.  It is usually offered only after a
> +  detailed review.
> +. `Tested-by:` is used to indicate that the person applied the patch
> +  and found it to have the desired effect.
> +
> +You can also create your own tag or use one that's in common usage
> +such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
> +
>  [[git-tools]]
>  === Generate your patch using Git tools out of your commits.
>  
> @@ -302,86 +382,6 @@ Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and
>  `Tested-by:` lines as necessary to credit people who helped your
>  patch, and "cc:" them when sending such a final version for inclusion.
>  
> -[[sign-off]]
> -=== Certify your work by adding your `Signed-off-by` trailer
> -
> -To improve tracking of who did what, we ask you to certify that you
> -wrote the patch or have the right to pass it on under the same license
> -as ours, by "signing off" your patch.  Without sign-off, we cannot
> -accept your patches.
> -
> -If (and only if) you certify the below D-C-O:
> -
> -[[dco]]
> -.Developer's Certificate of Origin 1.1
> -____
> -By making a contribution to this project, I certify that:
> -
> -a. The contribution was created in whole or in part by me and I
> -   have the right to submit it under the open source license
> -   indicated in the file; or
> -
> -b. The contribution is based upon previous work that, to the best
> -   of my knowledge, is covered under an appropriate open source
> -   license and I have the right under that license to submit that
> -   work with modifications, whether created in whole or in part
> -   by me, under the same open source license (unless I am
> -   permitted to submit under a different license), as indicated
> -   in the file; or
> -
> -c. The contribution was provided directly to me by some other
> -   person who certified (a), (b) or (c) and I have not modified
> -   it.
> -
> -d. I understand and agree that this project and the contribution
> -   are public and that a record of the contribution (including all
> -   personal information I submit with it, including my sign-off) is
> -   maintained indefinitely and may be redistributed consistent with
> -   this project or the open source license(s) involved.
> -____
> -
> -you add a "Signed-off-by" trailer to your commit, that looks like
> -this:
> -
> -....
> -	Signed-off-by: Random J Developer <random@developer.example.org>
> -....
> -
> -This line can be added by Git if you run the git-commit command with
> -the -s option.
> -
> -Notice that you can place your own `Signed-off-by` trailer when
> -forwarding somebody else's patch with the above rules for
> -D-C-O.  Indeed you are encouraged to do so.  Do not forget to
> -place an in-body "From: " line at the beginning to properly attribute
> -the change to its true author (see (2) above).
> -
> -This procedure originally came from the Linux kernel project, so our
> -rule is quite similar to theirs, but what exactly it means to sign-off
> -your patch differs from project to project, so it may be different
> -from that of the project you are accustomed to.
> -
> -[[real-name]]
> -Also notice that a real name is used in the `Signed-off-by` trailer. Please
> -don't hide your real name.
> -
> -[[commit-trailers]]
> -If you like, you can put extra tags at the end:
> -
> -. `Reported-by:` is used to credit someone who found the bug that
> -  the patch attempts to fix.
> -. `Acked-by:` says that the person who is more familiar with the area
> -  the patch attempts to modify liked the patch.
> -. `Reviewed-by:`, unlike the other tags, can only be offered by the
> -  reviewer and means that she is completely satisfied that the patch
> -  is ready for application.  It is usually offered only after a
> -  detailed review.
> -. `Tested-by:` is used to indicate that the person applied the patch
> -  and found it to have the desired effect.
> -
> -You can also create your own tag or use one that's in common usage
> -such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
> -
>  == Subsystems with dedicated maintainers
>  
>  Some parts of the system have dedicated maintainers with their own
> -- 
> 2.32.0.rc3.434.gd8aed1f08a7
> 

-- 
Danh

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH 1/3] SubmittingPatches: move discussion of Signed-off-by above "send"
  2021-06-07 11:02     ` Ævar Arnfjörð Bjarmason
@ 2021-06-07 16:16       ` Felipe Contreras
  0 siblings, 0 replies; 28+ messages in thread
From: Felipe Contreras @ 2021-06-07 16:16 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason, Felipe Contreras
  Cc: git, Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh

Ævar Arnfjörð Bjarmason wrote:
> On Wed, May 12 2021, Felipe Contreras wrote:
> 
> > So:
> >
> >> To improve tracking of who did what, we ask you to certify that you
> >> wrote the patch--or have the right to pass it on under the same
> >> license as ours--by "signing off" your patch.
> >
> > Cheers.
> 
> I think these are good notes, but in this commit I'm merely moving
> existing lines around in the file so that 2/3 and 3/3 make sense, so
> I've left any change to the existing text out of v2 of this series.
> 
> I welcome an effort to improve the existing wording, but I think it's
> better if you submit your own patch-on-top for that, I'd rather not get
> bogged down in that any more than I already am :)

All right. Fair enough.

-- 
Felipe Contreras

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH v2 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions
  2021-06-07 11:03   ` [PATCH v2 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
@ 2021-06-07 17:25     ` SZEDER Gábor
  0 siblings, 0 replies; 28+ messages in thread
From: SZEDER Gábor @ 2021-06-07 17:25 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason
  Cc: git, Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh, Felipe Contreras

On Mon, Jun 07, 2021 at 01:03:42PM +0200, Ævar Arnfjörð Bjarmason wrote:
> Replace the discussion of Travis CI added in
> 0e5d028a7a0 (Documentation: add setup instructions for Travis CI,
> 2016-05-02) with something that covers the GitHub Actions added in
> 889cacb6897 (ci: configure GitHub Actions for CI/PR, 2020-04-11).
> 
> The setup is trivial compared to using Travis, and it even works on
> Windows (that "hopefully soon" comment was probably out-of-date on
> Travis as well).
> 
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
> ---
>  Documentation/SubmittingPatches | 44 ++++++++++++---------------------
>  1 file changed, 16 insertions(+), 28 deletions(-)
> 
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> index 2643062624..e372d17673 100644
> --- a/Documentation/SubmittingPatches
> +++ b/Documentation/SubmittingPatches
> @@ -74,10 +74,9 @@ the feature triggers the new behavior when it should, and to show the
>  feature does not trigger when it shouldn't.  After any code change, make
>  sure that the entire test suite passes.
>  
> -If you have an account at GitHub (and you can get one for free to work
> -on open source projects), you can use their Travis CI integration to
> -test your changes on Linux, Mac (and hopefully soon Windows).  See
> -GitHub-Travis CI hints section for details.
> +Pushing to a fork of https://github.com/git/git will use their CI
> +integration to test your changes on Linux, Mac and Windows. See the
> +GitHub CI section for details.
>  
>  Do not forget to update the documentation to describe the updated
>  behavior and make sure that the resulting documentation set formats
> @@ -451,12 +450,12 @@ their trees themselves.
>    the status of various proposed changes.
>  
>  [[travis]]

What about this occurence of "travis"?

> -== GitHub-Travis CI hints
> +== GitHub CI
>  
> -With an account at GitHub (you can get one for free to work on open
> -source projects), you can use Travis CI to test your changes on Linux,
> -Mac (and hopefully soon Windows).  You can find a successful example
> -test build here: https://travis-ci.org/git/git/builds/120473209
> +With an account at GitHub, you can use GitHub CI to test your changes
> +on Linux, Mac and Windows. See
> +https://github.com/git/git/actions/workflows/main.yml for examples of
> +recent CI runs.
>  
>  Follow these steps for the initial setup:
>  
> @@ -464,31 +463,20 @@ Follow these steps for the initial setup:
>    You can find detailed instructions how to fork here:
>    https://help.github.com/articles/fork-a-repo/
>  
> -. Open the Travis CI website: https://travis-ci.org
> -
> -. Press the "Sign in with GitHub" button.
> -
> -. Grant Travis CI permissions to access your GitHub account.
> -  You can find more information about the required permissions here:
> -  https://docs.travis-ci.com/user/github-oauth-scopes
> -
> -. Open your Travis CI profile page: https://travis-ci.org/profile
> -
>  . Enable Travis CI builds for your Git fork.
>  
>  After the initial setup, Travis CI will run whenever you push new changes

And what about these two mentions of Travis CI in the context?

>  to your fork of Git on GitHub.  You can monitor the test state of all your
> -branches here: https://travis-ci.org/__<Your GitHub handle>__/git/branches
> +branches here: https://github.com/<Your GitHub handle>/git/actions/workflows/main.yml

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH v2 3/3] SubmittingPatches: remove pine-specific hints from MUA hints
  2021-06-07 11:03   ` [PATCH v2 3/3] SubmittingPatches: remove pine-specific hints from MUA hints Ævar Arnfjörð Bjarmason
@ 2021-06-07 21:49     ` Johannes Schindelin
  0 siblings, 0 replies; 28+ messages in thread
From: Johannes Schindelin @ 2021-06-07 21:49 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason
  Cc: git, Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh, Felipe Contreras

[-- Attachment #1: Type: text/plain, Size: 553 bytes --]

Hi Ævar,

On Mon, 7 Jun 2021, Ævar Arnfjörð Bjarmason wrote:

> This documentation was initially added in 9740d289ee7 (Update
> SubmittingPatches to add MUA specific notes., 2005-08-26). At this
> point it's safe to say that it's not useful to anyone anymore, let's
> remove it.

I am using Alpine, with a config that is based on the documentation you
remove and that you say is safe to assume to be not useful.

If you replaced the information about Pine with information about Alpine,
I would be in favor, though.

Ciao,
Johannes

^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes
  2021-06-07 11:03 ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
                     ` (2 preceding siblings ...)
  2021-06-07 11:03   ` [PATCH v2 3/3] SubmittingPatches: remove pine-specific hints from MUA hints Ævar Arnfjörð Bjarmason
@ 2021-06-08  3:50   ` Junio C Hamano
  2021-07-22 12:11   ` [PATCH v3 0/2] SubmittingPatches: talk about GitHub CI, not Travis + move-only Ævar Arnfjörð Bjarmason
  4 siblings, 0 replies; 28+ messages in thread
From: Junio C Hamano @ 2021-06-08  3:50 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason
  Cc: git, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh, Felipe Contreras

Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:

> A few minor updates to SubmittingPatches spotted while paging through
> it the other day (or other month, given the delay until v2).
>
> See
> https://lore.kernel.org/git/cover-0.3-0000000000-20210512T084137Z-avarab@gmail.com/
> for the v1 discussion. This hopefully addresses all the outstanding
> comments with it.
>
> Ævar Arnfjörð Bjarmason (3):
>   SubmittingPatches: move discussion of Signed-off-by above "send"
>   SubmittingPatches: replace discussion of Travis with GitHub Actions
>   SubmittingPatches: remove pine-specific hints from MUA hints

Will replace but it seems 2&3/3 have a bit more work to do.

Thanks.

^ permalink raw reply	[flat|nested] 28+ messages in thread

* [PATCH v3 0/2] SubmittingPatches: talk about GitHub CI, not Travis + move-only
  2021-06-07 11:03 ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
                     ` (3 preceding siblings ...)
  2021-06-08  3:50   ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Junio C Hamano
@ 2021-07-22 12:11   ` Ævar Arnfjörð Bjarmason
  2021-07-22 12:11     ` [PATCH v3 1/2] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
  2021-07-22 12:11     ` [PATCH v3 2/2] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
  4 siblings, 2 replies; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-07-22 12:11 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh, Felipe Contreras,
	SZEDER Gábor, Ævar Arnfjörð Bjarmason

This is a late-re-roll of this v2:
https://lore.kernel.org/git/cover-0.3-0000000000-20210607T110044Z-avarab@gmail.com/

I fixed the problems Đoàn Trần Công Danh and SZEDER Gábor pointed out
in v2.

I ejected the removal of the inline patch for Pine from this
verison. Johannes suggest another approach in
https://lore.kernel.org/git/nycvar.QRO.7.76.6.2106072346560.55@tvgsbejvaqbjf.bet/

I think we're spending way too much reader time on [Al]pine still, but
I don't want to write something that's accurate advice for an E-Mail
client I've never used, so I'm dropping it. Perhaps someone else will
pick that cleanup up...

Ævar Arnfjörð Bjarmason (2):
  SubmittingPatches: move discussion of Signed-off-by above "send"
  SubmittingPatches: replace discussion of Travis with GitHub Actions

 Documentation/SubmittingPatches | 207 +++++++++++++++-----------------
 1 file changed, 96 insertions(+), 111 deletions(-)

Range-diff against v2:
1:  6e2749d307 = 1:  4283f000c5 SubmittingPatches: move discussion of Signed-off-by above "send"
2:  788b198520 ! 2:  ecb9924a6a SubmittingPatches: replace discussion of Travis with GitHub Actions
    @@ Documentation/SubmittingPatches: the feature triggers the new behavior when it s
     -GitHub-Travis CI hints section for details.
     +Pushing to a fork of https://github.com/git/git will use their CI
     +integration to test your changes on Linux, Mac and Windows. See the
    -+GitHub CI section for details.
    ++<<GHCI,GitHub CI>> section for details.
      
      Do not forget to update the documentation to describe the updated
      behavior and make sure that the resulting documentation set formats
     @@ Documentation/SubmittingPatches: their trees themselves.
    +   entitled "What's cooking in git.git" and "What's in git.git" giving
        the status of various proposed changes.
      
    - [[travis]]
    +-[[travis]]
     -== GitHub-Travis CI hints
    -+== GitHub CI
    ++== GitHub CI[[GHCI]]]
      
     -With an account at GitHub (you can get one for free to work on open
     -source projects), you can use Travis CI to test your changes on Linux,
    @@ Documentation/SubmittingPatches: Follow these steps for the initial setup:
     -
     -. Open your Travis CI profile page: https://travis-ci.org/profile
     -
    - . Enable Travis CI builds for your Git fork.
    - 
    - After the initial setup, Travis CI will run whenever you push new changes
    +-. Enable Travis CI builds for your Git fork.
    +-
    +-After the initial setup, Travis CI will run whenever you push new changes
    ++After the initial setup, CI will run whenever you push new changes
      to your fork of Git on GitHub.  You can monitor the test state of all your
     -branches here: https://travis-ci.org/__<Your GitHub handle>__/git/branches
     +branches here: https://github.com/<Your GitHub handle>/git/actions/workflows/main.yml
3:  fecc3459f1 < -:  ---------- SubmittingPatches: remove pine-specific hints from MUA hints
-- 
2.32.0.957.gd9e39d72fe6


^ permalink raw reply	[flat|nested] 28+ messages in thread

* [PATCH v3 1/2] SubmittingPatches: move discussion of Signed-off-by above "send"
  2021-07-22 12:11   ` [PATCH v3 0/2] SubmittingPatches: talk about GitHub CI, not Travis + move-only Ævar Arnfjörð Bjarmason
@ 2021-07-22 12:11     ` Ævar Arnfjörð Bjarmason
  2021-07-23  6:36       ` Bagas Sanjaya
  2021-07-22 12:11     ` [PATCH v3 2/2] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
  1 sibling, 1 reply; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-07-22 12:11 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh, Felipe Contreras,
	SZEDER Gábor, Ævar Arnfjörð Bjarmason

Move the section discussing the addition of a SOB trailer above the
section that discusses generating the patch itself. This makes sense
as we don't want someone to go through the process of "git
format-patch", only to realize late that they should have used "git
commit -s" or equivalent.

This is a move-only change, no lines here are being altered, only
moved around.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/SubmittingPatches | 158 ++++++++++++++++----------------
 1 file changed, 79 insertions(+), 79 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 3e215f4d80..07e2073155 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -167,6 +167,85 @@ or, on an older version of Git without support for --pretty=reference:
 	git show -s --date=short --pretty='format:%h (%s, %ad)' <commit>
 ....
 
+[[sign-off]]
+=== Certify your work by adding your `Signed-off-by` trailer
+
+To improve tracking of who did what, we ask you to certify that you
+wrote the patch or have the right to pass it on under the same license
+as ours, by "signing off" your patch.  Without sign-off, we cannot
+accept your patches.
+
+If (and only if) you certify the below D-C-O:
+
+[[dco]]
+.Developer's Certificate of Origin 1.1
+____
+By making a contribution to this project, I certify that:
+
+a. The contribution was created in whole or in part by me and I
+   have the right to submit it under the open source license
+   indicated in the file; or
+
+b. The contribution is based upon previous work that, to the best
+   of my knowledge, is covered under an appropriate open source
+   license and I have the right under that license to submit that
+   work with modifications, whether created in whole or in part
+   by me, under the same open source license (unless I am
+   permitted to submit under a different license), as indicated
+   in the file; or
+
+c. The contribution was provided directly to me by some other
+   person who certified (a), (b) or (c) and I have not modified
+   it.
+
+d. I understand and agree that this project and the contribution
+   are public and that a record of the contribution (including all
+   personal information I submit with it, including my sign-off) is
+   maintained indefinitely and may be redistributed consistent with
+   this project or the open source license(s) involved.
+____
+
+you add a "Signed-off-by" trailer to your commit, that looks like
+this:
+
+....
+	Signed-off-by: Random J Developer <random@developer.example.org>
+....
+
+This line can be added by Git if you run the git-commit command with
+the -s option.
+
+Notice that you can place your own `Signed-off-by` trailer when
+forwarding somebody else's patch with the above rules for
+D-C-O.  Indeed you are encouraged to do so.  Do not forget to
+place an in-body "From: " line at the beginning to properly attribute
+the change to its true author (see (2) above).
+
+This procedure originally came from the Linux kernel project, so our
+rule is quite similar to theirs, but what exactly it means to sign-off
+your patch differs from project to project, so it may be different
+from that of the project you are accustomed to.
+
+[[real-name]]
+Also notice that a real name is used in the `Signed-off-by` trailer. Please
+don't hide your real name.
+
+[[commit-trailers]]
+If you like, you can put extra tags at the end:
+
+. `Reported-by:` is used to credit someone who found the bug that
+  the patch attempts to fix.
+. `Acked-by:` says that the person who is more familiar with the area
+  the patch attempts to modify liked the patch.
+. `Reviewed-by:`, unlike the other tags, can only be offered by the
+  reviewers themselves when they are completely satisfied with the
+  patch after a detailed analysis.
+. `Tested-by:` is used to indicate that the person applied the patch
+  and found it to have the desired effect.
+
+You can also create your own tag or use one that's in common usage
+such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
+
 [[git-tools]]
 === Generate your patch using Git tools out of your commits.
 
@@ -302,85 +381,6 @@ Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and
 `Tested-by:` lines as necessary to credit people who helped your
 patch, and "cc:" them when sending such a final version for inclusion.
 
-[[sign-off]]
-=== Certify your work by adding your `Signed-off-by` trailer
-
-To improve tracking of who did what, we ask you to certify that you
-wrote the patch or have the right to pass it on under the same license
-as ours, by "signing off" your patch.  Without sign-off, we cannot
-accept your patches.
-
-If (and only if) you certify the below D-C-O:
-
-[[dco]]
-.Developer's Certificate of Origin 1.1
-____
-By making a contribution to this project, I certify that:
-
-a. The contribution was created in whole or in part by me and I
-   have the right to submit it under the open source license
-   indicated in the file; or
-
-b. The contribution is based upon previous work that, to the best
-   of my knowledge, is covered under an appropriate open source
-   license and I have the right under that license to submit that
-   work with modifications, whether created in whole or in part
-   by me, under the same open source license (unless I am
-   permitted to submit under a different license), as indicated
-   in the file; or
-
-c. The contribution was provided directly to me by some other
-   person who certified (a), (b) or (c) and I have not modified
-   it.
-
-d. I understand and agree that this project and the contribution
-   are public and that a record of the contribution (including all
-   personal information I submit with it, including my sign-off) is
-   maintained indefinitely and may be redistributed consistent with
-   this project or the open source license(s) involved.
-____
-
-you add a "Signed-off-by" trailer to your commit, that looks like
-this:
-
-....
-	Signed-off-by: Random J Developer <random@developer.example.org>
-....
-
-This line can be added by Git if you run the git-commit command with
-the -s option.
-
-Notice that you can place your own `Signed-off-by` trailer when
-forwarding somebody else's patch with the above rules for
-D-C-O.  Indeed you are encouraged to do so.  Do not forget to
-place an in-body "From: " line at the beginning to properly attribute
-the change to its true author (see (2) above).
-
-This procedure originally came from the Linux kernel project, so our
-rule is quite similar to theirs, but what exactly it means to sign-off
-your patch differs from project to project, so it may be different
-from that of the project you are accustomed to.
-
-[[real-name]]
-Also notice that a real name is used in the `Signed-off-by` trailer. Please
-don't hide your real name.
-
-[[commit-trailers]]
-If you like, you can put extra tags at the end:
-
-. `Reported-by:` is used to credit someone who found the bug that
-  the patch attempts to fix.
-. `Acked-by:` says that the person who is more familiar with the area
-  the patch attempts to modify liked the patch.
-. `Reviewed-by:`, unlike the other tags, can only be offered by the
-  reviewers themselves when they are completely satisfied with the
-  patch after a detailed analysis.
-. `Tested-by:` is used to indicate that the person applied the patch
-  and found it to have the desired effect.
-
-You can also create your own tag or use one that's in common usage
-such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
-
 == Subsystems with dedicated maintainers
 
 Some parts of the system have dedicated maintainers with their own
-- 
2.32.0.957.gd9e39d72fe6


^ permalink raw reply	[flat|nested] 28+ messages in thread

* [PATCH v3 2/2] SubmittingPatches: replace discussion of Travis with GitHub Actions
  2021-07-22 12:11   ` [PATCH v3 0/2] SubmittingPatches: talk about GitHub CI, not Travis + move-only Ævar Arnfjörð Bjarmason
  2021-07-22 12:11     ` [PATCH v3 1/2] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
@ 2021-07-22 12:11     ` Ævar Arnfjörð Bjarmason
  1 sibling, 0 replies; 28+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2021-07-22 12:11 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh, Felipe Contreras,
	SZEDER Gábor, Ævar Arnfjörð Bjarmason

Replace the discussion of Travis CI added in
0e5d028a7a0 (Documentation: add setup instructions for Travis CI,
2016-05-02) with something that covers the GitHub Actions added in
889cacb6897 (ci: configure GitHub Actions for CI/PR, 2020-04-11).

The setup is trivial compared to using Travis, and it even works on
Windows (that "hopefully soon" comment was probably out-of-date on
Travis as well).

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/SubmittingPatches | 49 ++++++++++++---------------------
 1 file changed, 17 insertions(+), 32 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 07e2073155..e409022d93 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -74,10 +74,9 @@ the feature triggers the new behavior when it should, and to show the
 feature does not trigger when it shouldn't.  After any code change, make
 sure that the entire test suite passes.
 
-If you have an account at GitHub (and you can get one for free to work
-on open source projects), you can use their Travis CI integration to
-test your changes on Linux, Mac (and hopefully soon Windows).  See
-GitHub-Travis CI hints section for details.
+Pushing to a fork of https://github.com/git/git will use their CI
+integration to test your changes on Linux, Mac and Windows. See the
+<<GHCI,GitHub CI>> section for details.
 
 Do not forget to update the documentation to describe the updated
 behavior and make sure that the resulting documentation set formats
@@ -449,13 +448,12 @@ their trees themselves.
   entitled "What's cooking in git.git" and "What's in git.git" giving
   the status of various proposed changes.
 
-[[travis]]
-== GitHub-Travis CI hints
+== GitHub CI[[GHCI]]]
 
-With an account at GitHub (you can get one for free to work on open
-source projects), you can use Travis CI to test your changes on Linux,
-Mac (and hopefully soon Windows).  You can find a successful example
-test build here: https://travis-ci.org/git/git/builds/120473209
+With an account at GitHub, you can use GitHub CI to test your changes
+on Linux, Mac and Windows. See
+https://github.com/git/git/actions/workflows/main.yml for examples of
+recent CI runs.
 
 Follow these steps for the initial setup:
 
@@ -463,31 +461,18 @@ Follow these steps for the initial setup:
   You can find detailed instructions how to fork here:
   https://help.github.com/articles/fork-a-repo/
 
-. Open the Travis CI website: https://travis-ci.org
-
-. Press the "Sign in with GitHub" button.
-
-. Grant Travis CI permissions to access your GitHub account.
-  You can find more information about the required permissions here:
-  https://docs.travis-ci.com/user/github-oauth-scopes
-
-. Open your Travis CI profile page: https://travis-ci.org/profile
-
-. Enable Travis CI builds for your Git fork.
-
-After the initial setup, Travis CI will run whenever you push new changes
+After the initial setup, CI will run whenever you push new changes
 to your fork of Git on GitHub.  You can monitor the test state of all your
-branches here: https://travis-ci.org/__<Your GitHub handle>__/git/branches
+branches here: https://github.com/<Your GitHub handle>/git/actions/workflows/main.yml
 
 If a branch did not pass all test cases then it is marked with a red
-cross.  In that case you can click on the failing Travis CI job and
-scroll all the way down in the log.  Find the line "<-- Click here to see
-detailed test output!" and click on the triangle next to the log line
-number to expand the detailed test output.  Here is such a failing
-example: https://travis-ci.org/git/git/jobs/122676187
-
-Fix the problem and push your fix to your Git fork.  This will trigger
-a new Travis CI build to ensure all tests pass.
+cross. In that case you can click on the failing job and navigate to
+"ci/run-build-and-tests.sh" and/or "ci/print-test-failures.sh". You
+can also download "Artifacts" which are tarred (or zipped) archives
+with test data relevant for debugging.
+
+Then fix the problem and push your fix to your GitHub fork. This will
+trigger a new CI build to ensure all tests pass.
 
 [[mua]]
 == MUA specific hints
-- 
2.32.0.957.gd9e39d72fe6


^ permalink raw reply	[flat|nested] 28+ messages in thread

* Re: [PATCH v3 1/2] SubmittingPatches: move discussion of Signed-off-by above "send"
  2021-07-22 12:11     ` [PATCH v3 1/2] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
@ 2021-07-23  6:36       ` Bagas Sanjaya
  0 siblings, 0 replies; 28+ messages in thread
From: Bagas Sanjaya @ 2021-07-23  6:36 UTC (permalink / raw)
  To: Ævar Arnfjörð Bjarmason, git
  Cc: Junio C Hamano, Dave Huseby, Lars Schneider,
	Đoàn Trần Công Danh, Felipe Contreras,
	SZEDER Gábor

On 22/07/21 19.11, Ævar Arnfjörð Bjarmason wrote:
> Move the section discussing the addition of a SOB trailer above the
> section that discusses generating the patch itself. This makes sense
> as we don't want someone to go through the process of "git
> format-patch", only to realize late that they should have used "git
> commit -s" or equivalent.

Did you mean someone forget to sign-off commit?

-- 
An old man doll... just what I always wanted! - Clara

^ permalink raw reply	[flat|nested] 28+ messages in thread

end of thread, other threads:[~2021-07-23  6:36 UTC | newest]

Thread overview: 28+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-12  8:44 [PATCH 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
2021-05-12  8:45 ` [PATCH 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
2021-05-12  9:29   ` Felipe Contreras
2021-06-07 11:02     ` Ævar Arnfjörð Bjarmason
2021-06-07 16:16       ` Felipe Contreras
2021-05-12  8:45 ` [PATCH 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
2021-05-12 12:24   ` Đoàn Trần Công Danh
2021-05-12 22:40   ` Junio C Hamano
2021-05-12  8:45 ` [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints Ævar Arnfjörð Bjarmason
2021-05-12 23:51   ` Dave Huseby
2021-05-13  6:38     ` Felipe Contreras
2021-05-13 14:45       ` Dave Huseby
2021-05-13 20:08         ` Felipe Contreras
2021-05-17 19:05           ` Dave Huseby
2021-05-13  7:50     ` Ævar Arnfjörð Bjarmason
2021-05-13 14:42       ` Dave Huseby
2021-06-07 11:03 ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
2021-06-07 11:03   ` [PATCH v2 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
2021-06-07 15:58     ` Đoàn Trần Công Danh
2021-06-07 11:03   ` [PATCH v2 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
2021-06-07 17:25     ` SZEDER Gábor
2021-06-07 11:03   ` [PATCH v2 3/3] SubmittingPatches: remove pine-specific hints from MUA hints Ævar Arnfjörð Bjarmason
2021-06-07 21:49     ` Johannes Schindelin
2021-06-08  3:50   ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Junio C Hamano
2021-07-22 12:11   ` [PATCH v3 0/2] SubmittingPatches: talk about GitHub CI, not Travis + move-only Ævar Arnfjörð Bjarmason
2021-07-22 12:11     ` [PATCH v3 1/2] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
2021-07-23  6:36       ` Bagas Sanjaya
2021-07-22 12:11     ` [PATCH v3 2/2] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).