gerrit/Documentation/cmd-receive-pack.txt
Yuxuan 'fishy' Wang 61698b14e0 Use the new section title style in Asciidoctor.
We previous use the section title style like:

Section level 1
===============

Section level 2
---------------

Which have a problem in Asciidoctor that the number of "="s or "-"s must match
the number of characters in the header exactly, as a result it's easy to make
mistakes while changing the titles. Asciidoctor provides a better style like:

= Section level 1

== Section level 2

So we switched to this style.

Also fixed a bug in replace_macros.py, which will not cause any problem in the
old style.

Change-Id: I811dd7238735d98f662767c17086152cd69aea02
2013-12-20 12:55:51 -08:00

87 lines
2.3 KiB
Plaintext

= git-receive-pack
== NAME
git-receive-pack - Receive what is pushed into the repository
== SYNOPSIS
--
'git receive-pack'
[--reviewer <address> | --re <address>]
[--cc <address>]
<project>
--
== DESCRIPTION
Invoked by 'git push' and updates the project's repository with
the information fed from the 'git push' end.
End users can supply options to this command by passing them through
to 'git push', which will relay them automatically.
== OPTIONS
<project>::
The remote repository that will receive the pushed objects,
and create (or update) changes. Within Gerrit Code Review
this is the name of a project. The optional leading `/`
and or trailing `.git` suffix will be removed, if supplied.
--reviewer <address>::
--re <address>::
Automatically add <address> as a reviewer to any change.
Deprecated, use `refs/for/branch%r=address` instead.
--cc <address>::
Carbon-copy <address> on the created or updated changes.
Deprecated, use `refs/for/branch%cc=address` instead.
== ACCESS
Any user who has configured an SSH key.
== EXAMPLES
Send a review for a change on the master branch to charlie@example.com:
=====
git push ssh://review.example.com:29418/project HEAD:refs/for/master%r=charlie@example.com
=====
Send reviews, but tagging them with the topic name 'bug42':
=====
git push ssh://review.example.com:29418/project HEAD:refs/for/master%r=charlie@example.com,topic=bug42
=====
Also CC two other parties:
=====
git push ssh://review.example.com:29418/project HEAD:refs/for/master%r=charlie@example.com,cc=alice@example.com,cc=bob@example.com
=====
Configure a push macro to perform the last action:
====
git config remote.charlie.url ssh://review.example.com:29418/project
git config remote.charlie.push HEAD:refs/for/master%r=charlie@example.com,cc=alice@example.com,cc=bob@example.com
====
afterwards `.git/config` contains the following:
----
[remote "charlie"]
url = ssh://review.example.com:29418/project
push = HEAD:refs/for/master%r=charlie@example.com,cc=alice@example.com,cc=bob@example.com
----
and now sending a new change for review to charlie, CC'ing both
alice and bob is much easier:
====
git push charlie
====
== SEE ALSO
* link:user-upload.html[Uploading Changes]
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------