Update Gerrit auth manpage

Just rewords things better.

Bug: b/404613530
Change-Id: I6bd339fa4bce4fc83e5f18a5bc6e9f9a3d52dd3b
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/6374090
Commit-Queue: Allen Li <ayatane@chromium.org>
Reviewed-by: Josip Sokcevic <sokcevic@chromium.org>
changes/90/6374090/2
Allen Li 3 months ago committed by LUCI CQ
parent a2c6f107c3
commit 4b4ec94b3e

@ -757,19 +757,22 @@ depot_tools_gerrit_auth(7) Manual Page
<div class="sectionbody">
<div class="paragraph"><p>The Chromium <a href="depot_tools.html">depot_tools(7)</a> suite contains many tools which
may need to authenticate to Gerrit.</p></div>
<div class="paragraph"><p>Gerrit uses OAuth for authentication. Usually, the OAuth is handled
by git-credential-luci. You need to login once with
git-credential-luci, and then it will provide access tokens for Gerrit
authentication.</p></div>
<div class="paragraph"><p>depot_tools uses git-credential-luci to authenticate Gerrit API calls.</p></div>
<div class="paragraph"><p>Gerrit uses OAuth for authentication. For depot_tools, OAuth is
handled by <code>git-credential-luci</code>.</p></div>
<div class="paragraph"><p>Authentication is needed both for Gerrit API calls made by depot_tools
and for operations done directly by Git (e.g., <code>git push</code>, <code>git
fetch</code>).</p></div>
<div class="paragraph"><p>For Gerrit API calls, depot_tools uses <code>git-credential-luci</code> out of the
box, but for Git, you need to modify your Git configuration to use
<code>git-credential-luci</code>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_git_configuration">GIT CONFIGURATION</h2>
<div class="sectionbody">
<div class="paragraph"><p>You need to configure Git to authenticate to Gerrit. While
depot_tools can help set up the necessary configuration, you can do it
manually.</p></div>
depot_tools can help set up the necessary configuration (<code>git cl
creds-check</code>), you can also do it manually.</p></div>
<div class="paragraph"><p>You need to add the following lines to your Git config:</p></div>
<div class="listingblock">
<div class="content">
@ -777,8 +780,9 @@ manually.</p></div>
helper =
helper = luci</code></pre>
</div></div>
<div class="paragraph"><p>The empty value is needed to reset the helper list to prevent
conflicts. You should copy this for each Gerrit host you need.</p></div>
<div class="paragraph"><p>This tells Git to use <code>git-credential-luci</code>. The first empty value
line is needed to reset the helper list to prevent conflicts.</p></div>
<div class="paragraph"><p>You should copy this for each Gerrit host you use.</p></div>
<div class="paragraph"><p>For Googlers, see go/chrome-gerrit-auth.</p></div>
</div>
</div>
@ -795,7 +799,7 @@ by checking out the <a href="https://chromium.googlesource.com/chromium/tools/de
<div id="footer">
<div id="footer-text">
Last updated
2025-03-11 23:26:44 UTC
2025-03-19 21:22:42 UTC
</div>
</div>
</body>

@ -2,12 +2,12 @@
.\" Title: depot_tools_gerrit_auth
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 03/11/2025
.\" Date: 03/19/2025
.\" Manual: Chromium depot_tools Manual
.\" Source: depot_tools 39b331947
.\" Source: depot_tools 7a97e75f4
.\" Language: English
.\"
.TH "DEPOT_TOOLS_GERRIT_A" "7" "03/11/2025" "depot_tools 39b331947" "Chromium depot_tools Manual"
.TH "DEPOT_TOOLS_GERRIT_A" "7" "03/19/2025" "depot_tools 7a97e75f4" "Chromium depot_tools Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -33,12 +33,14 @@ depot_tools_gerrit_auth \- Gerrit authentication for depot_tools
.sp
The Chromium \fBdepot_tools\fR(7) suite contains many tools which may need to authenticate to Gerrit\&.
.sp
Gerrit uses OAuth for authentication\&. Usually, the OAuth is handled by git\-credential\-luci\&. You need to login once with git\-credential\-luci, and then it will provide access tokens for Gerrit authentication\&.
Gerrit uses OAuth for authentication\&. For depot_tools, OAuth is handled by \fBgit\-credential\-luci\fR\&.
.sp
depot_tools uses git\-credential\-luci to authenticate Gerrit API calls\&.
Authentication is needed both for Gerrit API calls made by depot_tools and for operations done directly by Git (e\&.g\&., \fBgit push\fR, \fBgit fetch\fR)\&.
.sp
For Gerrit API calls, depot_tools uses \fBgit\-credential\-luci\fR out of the box, but for Git, you need to modify your Git configuration to use \fBgit\-credential\-luci\fR\&.
.SH "GIT CONFIGURATION"
.sp
You need to configure Git to authenticate to Gerrit\&. While depot_tools can help set up the necessary configuration, you can do it manually\&.
You need to configure Git to authenticate to Gerrit\&. While depot_tools can help set up the necessary configuration (\fBgit cl creds\-check\fR), you can also do it manually\&.
.sp
You need to add the following lines to your Git config:
.sp
@ -55,7 +57,9 @@ helper = luci
.\}
.sp
.sp
The empty value is needed to reset the helper list to prevent conflicts\&. You should copy this for each Gerrit host you need\&.
This tells Git to use \fBgit\-credential\-luci\fR\&. The first empty value line is needed to reset the helper list to prevent conflicts\&.
.sp
You should copy this for each Gerrit host you use\&.
.sp
For Googlers, see go/chrome\-gerrit\-auth\&.
.SH "CHROMIUM DEPOT_TOOLS"

@ -11,19 +11,23 @@ DESCRIPTION
The Chromium linkgit:depot_tools[7] suite contains many tools which
may need to authenticate to Gerrit.
Gerrit uses OAuth for authentication. Usually, the OAuth is handled
by git-credential-luci. You need to login once with
git-credential-luci, and then it will provide access tokens for Gerrit
authentication.
Gerrit uses OAuth for authentication. For depot_tools, OAuth is
handled by `git-credential-luci`.
depot_tools uses git-credential-luci to authenticate Gerrit API calls.
Authentication is needed both for Gerrit API calls made by depot_tools
and for operations done directly by Git (e.g., `git push`, `git
fetch`).
For Gerrit API calls, depot_tools uses `git-credential-luci` out of the
box, but for Git, you need to modify your Git configuration to use
`git-credential-luci`.
GIT CONFIGURATION
-----------------
You need to configure Git to authenticate to Gerrit. While
depot_tools can help set up the necessary configuration, you can do it
manually.
depot_tools can help set up the necessary configuration (`git cl
creds-check`), you can also do it manually.
You need to add the following lines to your Git config:
@ -34,8 +38,10 @@ helper =
helper = luci
----
The empty value is needed to reset the helper list to prevent
conflicts. You should copy this for each Gerrit host you need.
This tells Git to use `git-credential-luci`. The first empty value
line is needed to reset the helper list to prevent conflicts.
You should copy this for each Gerrit host you use.
For Googlers, see go/chrome-gerrit-auth.

Loading…
Cancel
Save