Autogenerated HTML docs for v2.33.0-rc0-52-ge5a14d

1 files changed, 117 insertions, 146 deletions

diff --git a/SubmittingPatches.html b/SubmittingPatches.html
index c61259e62..8cebb5645 100644
--- a/SubmittingPatches.html
+++ b/SubmittingPatches.html
@@ -818,10 +818,9 @@ to have.</p></div>
 the feature triggers the new behavior when it should, and to show the

 feature does not trigger when it shouldn&#8217;t.  After any code change, make

 sure that the entire test suite passes.</p></div>

-<div class="paragraph"><p>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.</p></div>

+<div class="paragraph"><p>Pushing to a fork of <a href="https://github.com/git/git">https://github.com/git/git</a> will use their CI

+integration to test your changes on Linux, Mac and Windows. See the

+<a href="#GHCI">GitHub CI</a> section for details.</p></div>

 <div class="paragraph"><p>Do not forget to update the documentation to describe the updated

 behavior and make sure that the resulting documentation set formats

 well (try the Documentation/doc-diff script).</p></div>

@@ -916,6 +915,106 @@ invocation of <code>git show</code>:</p></div>
 </div></div>

 </div>

 <div class="sect2">

+<h3 id="sign-off">Certify your work by adding your <code>Signed-off-by</code> trailer</h3>

+<div class="paragraph"><p>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.</p></div>

+<div class="paragraph"><p>If (and only if) you certify the below D-C-O:</p></div>

+<div class="quoteblock" id="dco">

+<div class="title">Developer&#8217;s Certificate of Origin 1.1</div>

+<div class="content">

+<div class="paragraph"><p>By making a contribution to this project, I certify that:</p></div>

+<div class="olist loweralpha"><ol class="loweralpha">

+<li>

+<p>

+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

+</p>

+</li>

+<li>

+<p>

+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

+</p>

+</li>

+<li>

+<p>

+The contribution was provided directly to me by some other

+   person who certified (a), (b) or (c) and I have not modified

+   it.

+</p>

+</li>

+<li>

+<p>

+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.

+</p>

+</li>

+</ol></div>

+</div>

+<div class="attribution">

+</div></div>

+<div class="paragraph"><p>you add a "Signed-off-by" trailer to your commit, that looks like

+this:</p></div>

+<div class="literalblock">

+<div class="content">

+<pre><code>        Signed-off-by: Random J Developer &lt;random@developer.example.org&gt;</code></pre>

+</div></div>

+<div class="paragraph"><p>This line can be added by Git if you run the git-commit command with

+the -s option.</p></div>

+<div class="paragraph"><p>Notice that you can place your own <code>Signed-off-by</code> trailer when

+forwarding somebody else&#8217;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).</p></div>

+<div class="paragraph"><p>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.</p></div>

+<div class="paragraph" id="real-name"><p>Also notice that a real name is used in the <code>Signed-off-by</code> trailer. Please

+don&#8217;t hide your real name.</p></div>

+<div class="paragraph" id="commit-trailers"><p>If you like, you can put extra tags at the end:</p></div>

+<div class="olist arabic"><ol class="arabic">

+<li>

+<p>

+<code>Reported-by:</code> is used to credit someone who found the bug that

+  the patch attempts to fix.

+</p>

+</li>

+<li>

+<p>

+<code>Acked-by:</code> says that the person who is more familiar with the area

+  the patch attempts to modify liked the patch.

+</p>

+</li>

+<li>

+<p>

+<code>Reviewed-by:</code>, unlike the other tags, can only be offered by the

+  reviewers themselves when they are completely satisfied with the

+  patch after a detailed analysis.

+</p>

+</li>

+<li>

+<p>

+<code>Tested-by:</code> is used to indicate that the person applied the patch

+  and found it to have the desired effect.

+</p>

+</li>

+</ol></div>

+<div class="paragraph"><p>You can also create your own tag or use one that&#8217;s in common usage

+such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".</p></div>

+</div>

+<div class="sect2">

 <h3 id="git-tools">Generate your patch using Git tools out of your commits.</h3>

 <div class="paragraph"><p>Git based diff tools generate unidiff which is the preferred format.</p></div>

 <div class="paragraph"><p>You do not have to be afraid to use <code>-M</code> option to <code>git diff</code> or

@@ -1027,106 +1126,6 @@ instead left the review to trusted others.</p></div>
 <code>Tested-by:</code> lines as necessary to credit people who helped your

 patch, and "cc:" them when sending such a final version for inclusion.</p></div>

 </div>

-<div class="sect2">

-<h3 id="sign-off">Certify your work by adding your <code>Signed-off-by</code> trailer</h3>

-<div class="paragraph"><p>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.</p></div>

-<div class="paragraph"><p>If (and only if) you certify the below D-C-O:</p></div>

-<div class="quoteblock" id="dco">

-<div class="title">Developer&#8217;s Certificate of Origin 1.1</div>

-<div class="content">

-<div class="paragraph"><p>By making a contribution to this project, I certify that:</p></div>

-<div class="olist loweralpha"><ol class="loweralpha">

-<li>

-<p>

-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

-</p>

-</li>

-<li>

-<p>

-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

-</p>

-</li>

-<li>

-<p>

-The contribution was provided directly to me by some other

-   person who certified (a), (b) or (c) and I have not modified

-   it.

-</p>

-</li>

-<li>

-<p>

-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.

-</p>

-</li>

-</ol></div>

-</div>

-<div class="attribution">

-</div></div>

-<div class="paragraph"><p>you add a "Signed-off-by" trailer to your commit, that looks like

-this:</p></div>

-<div class="literalblock">

-<div class="content">

-<pre><code>        Signed-off-by: Random J Developer &lt;random@developer.example.org&gt;</code></pre>

-</div></div>

-<div class="paragraph"><p>This line can be added by Git if you run the git-commit command with

-the -s option.</p></div>

-<div class="paragraph"><p>Notice that you can place your own <code>Signed-off-by</code> trailer when

-forwarding somebody else&#8217;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).</p></div>

-<div class="paragraph"><p>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.</p></div>

-<div class="paragraph" id="real-name"><p>Also notice that a real name is used in the <code>Signed-off-by</code> trailer. Please

-don&#8217;t hide your real name.</p></div>

-<div class="paragraph" id="commit-trailers"><p>If you like, you can put extra tags at the end:</p></div>

-<div class="olist arabic"><ol class="arabic">

-<li>

-<p>

-<code>Reported-by:</code> is used to credit someone who found the bug that

-  the patch attempts to fix.

-</p>

-</li>

-<li>

-<p>

-<code>Acked-by:</code> says that the person who is more familiar with the area

-  the patch attempts to modify liked the patch.

-</p>

-</li>

-<li>

-<p>

-<code>Reviewed-by:</code>, unlike the other tags, can only be offered by the

-  reviewers themselves when they are completely satisfied with the

-  patch after a detailed analysis.

-</p>

-</li>

-<li>

-<p>

-<code>Tested-by:</code> is used to indicate that the person applied the patch

-  and found it to have the desired effect.

-</p>

-</li>

-</ol></div>

-<div class="paragraph"><p>You can also create your own tag or use one that&#8217;s in common usage

-such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".</p></div>

-</div>

 </div>

 </div>

 <div class="sect1">

@@ -1245,12 +1244,12 @@ Read the Git mailing list, the maintainer regularly posts messages
 </div>

 </div>

 <div class="sect1">

-<h2 id="travis">GitHub-Travis CI hints</h2>

+<h2 id="_github_ci_a_id_ghci_a">GitHub CI<a id="GHCI"></a>]</h2>

 <div class="sectionbody">

-<div class="paragraph"><p>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: <a href="https://travis-ci.org/git/git/builds/120473209">https://travis-ci.org/git/git/builds/120473209</a></p></div>

+<div class="paragraph"><p>With an account at GitHub, you can use GitHub CI to test your changes

+on Linux, Mac and Windows. See

+<a href="https://github.com/git/git/actions/workflows/main.yml">https://github.com/git/git/actions/workflows/main.yml</a> for examples of

+recent CI runs.</p></div>

 <div class="paragraph"><p>Follow these steps for the initial setup:</p></div>

 <div class="olist arabic"><ol class="arabic">

 <li>

@@ -1260,45 +1259,17 @@ Fork <a href="https://github.com/git/git">https://github.com/git/git</a> to your
   <a href="https://help.github.com/articles/fork-a-repo/">https://help.github.com/articles/fork-a-repo/</a>

 </p>

 </li>

-<li>

-<p>

-Open the Travis CI website: <a href="https://travis-ci.org">https://travis-ci.org</a>

-</p>

-</li>

-<li>

-<p>

-Press the "Sign in with GitHub" button.

-</p>

-</li>

-<li>

-<p>

-Grant Travis CI permissions to access your GitHub account.

-  You can find more information about the required permissions here:

-  <a href="https://docs.travis-ci.com/user/github-oauth-scopes">https://docs.travis-ci.com/user/github-oauth-scopes</a>

-</p>

-</li>

-<li>

-<p>

-Open your Travis CI profile page: <a href="https://travis-ci.org/profile">https://travis-ci.org/profile</a>

-</p>

-</li>

-<li>

-<p>

-Enable Travis CI builds for your Git fork.

-</p>

-</li>

 </ol></div>

-<div class="paragraph"><p>After the initial setup, Travis CI will run whenever you push new changes

+<div class="paragraph"><p>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: <a href="https://travis-ci.org/">https://travis-ci.org/</a><em>&lt;Your GitHub handle&gt;</em>/git/branches</p></div>

+branches here: <a href="https://github.com/&lt;Your">https://github.com/&lt;Your</a> GitHub handle&gt;/git/actions/workflows/main.yml</p></div>

 <div class="paragraph"><p>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 "&#8592;- 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: <a href="https://travis-ci.org/git/git/jobs/122676187">https://travis-ci.org/git/git/jobs/122676187</a></p></div>

-<div class="paragraph"><p>Fix the problem and push your fix to your Git fork.  This will trigger

-a new Travis CI build to ensure all tests pass.</p></div>

+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.</p></div>

+<div class="paragraph"><p>Then fix the problem and push your fix to your GitHub fork. This will

+trigger a new CI build to ensure all tests pass.</p></div>

 </div>

 </div>

 <div class="sect1">

@@ -1395,7 +1366,7 @@ this problem around.</p></div>
 <div id="footer">

 <div id="footer-text">

 Last updated

- 2021-08-02 15:42:09 PDT

+ 2021-08-04 14:38:24 PDT

 </div>

 </div>

 </body>