opendev/gerrit
Code Issues Proposed changes
69928a6d06
gerrit/Documentation
History
Shawn Pearce 69928a6d06 Add options to refs/for/ magic branch syntax 
Git doesn't want to modify the network protocol to support passing
data from the git push client to the server. Work around this by
embedding option data into a new style of reference specification:

  refs/for/master%r=alice,cc=bob,cc=charlie,topic=options

is now parsed by the server as:

  - set topic to "options"
  - CC charlie and bob
  - add reviewer alice
  - for branch refs/heads/master

If % is used the "extra information" after the branch name is
parsed as options with args4j. Each option is delimited by ",".

Selecting publish vs. draft should be done with options draft or
publish, appearing anywhere in the refspec after the % marker:

  refs/for/master%draft
  refs/for/master%draft,r=alice
  refs/for/master%r=alice,draft
  refs/for/master%r=alice,publish

Change-Id: I895bd1218c2099b5b45cac943039bbd12565370c
2013-02-27 16:07:30 -08:00
..
images First Cut of Gerrit Walkthrough Introduction documentation. 2011-12-28 12:33:39 -07:00
.gitignore Move documentation to gerrit.googlecode.com website 2009-01-29 08:53:07 -08:00
access-control.txt Improve push tag examples in the access control documentation 2012-12-12 19:22:45 +09:00
asciidoc.conf Add executable examples for GET requests to REST API documentation 2013-01-23 21:04:46 +01:00
cmd-ban-commit.txt Add SSH command to ban commits 2012-03-30 16:12:42 +02:00
cmd-cherry-pick.txt Specify output file for curl commands in documentation 2012-07-09 11:34:59 +02:00
cmd-create-account.txt Update HTTP password from SSH commands. 2012-09-11 15:25:33 +02:00
cmd-create-group.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-create-project.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-flush-caches.txt Access control documentation: Flush caches capability 2012-03-21 17:43:29 +01:00
cmd-gsql.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
cmd-hook-commit-msg.txt Documentation: commit message hook file should be executable 2012-08-17 09:46:38 +02:00
cmd-index.txt New Admin command: ls-user-refs 2012-11-28 12:06:13 +09:00
cmd-kill.txt Access control documentation: Kill and priority capabilities 2012-03-21 17:43:29 +01:00
cmd-ls-groups.txt Support to check via REST if a group is owned by the calling user 2013-02-08 14:48:38 +01:00
cmd-ls-projects.txt ls-projects: Add option to list projects on which a certain group is used 2012-08-31 15:53:04 +02:00
cmd-ls-user-refs.txt New option for ls-user-refs: --only-refs-heads 2012-11-28 12:24:10 +09:00
cmd-plugin-enable.txt Add ssh command to enable plugins 2012-07-26 16:24:47 -05:00
cmd-plugin-install.txt Document SSH commands gerrit plugin {ls|install|remove|reload} 2012-07-17 16:07:02 +02:00
cmd-plugin-ls.txt Document SSH commands gerrit plugin {ls|install|remove|reload} 2012-07-17 16:07:02 +02:00
cmd-plugin-reload.txt Document that on reload of a plugin a new plugin configuration gets active 2012-07-18 12:48:36 +02:00
cmd-plugin-remove.txt Document SSH commands gerrit plugin {ls|install|remove|reload} 2012-07-17 16:07:02 +02:00
cmd-query.txt Allow {} to be used for quoting in query expressions 2012-12-03 09:59:14 -08:00
cmd-receive-pack.txt Add options to refs/for/ magic branch syntax 2013-02-27 16:07:30 -08:00
cmd-rename-group.txt Add new SSH command to rename groups 2011-10-27 00:28:11 +02:00
cmd-review.txt cmd-review.txt: Add clarification in documentation of --force-message 2012-07-24 13:17:47 +02:00
cmd-set-account.txt Update HTTP password from SSH commands. 2012-09-13 09:15:02 +02:00
cmd-set-project-parent.txt Support to reparent all children of a parent project 2011-11-16 09:34:26 +01:00
cmd-set-project.txt Permit booleans in project.config to be inherited 2012-10-25 11:20:47 -07:00
cmd-set-reviewers.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-show-caches.txt Fix link in show caches documentation 2012-03-26 13:23:12 +02:00
cmd-show-connections.txt Fix and complete synopsis of commands in documentation 2012-07-16 13:53:22 +02:00
cmd-show-queue.txt Access control documentation: Capability view conn. & queue 2012-03-28 17:34:33 +02:00
cmd-stream-events.txt Send event to stream and execute hook when merge fails 2012-10-17 17:34:14 +09:00
cmd-suexec.txt documentation: Clean up command line documentation, examples 2011-06-14 16:50:19 -07:00
cmd-test-submit-rule.txt Add ssh command "test-submit-rule" 2012-10-10 15:34:34 +02:00
cmd-version.txt Add missing documentation of SSH "version" command 2012-09-25 12:26:52 -04:00
config-cla.txt Minor documentation tidy-up 2013-01-07 17:30:55 +09:00
config-contact.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
config-gerrit.txt Permit ProjectCacheClock to be completely disabled 2013-02-20 12:08:15 -08:00
config-gitweb.txt Gitweb Instruction Updates 2012-08-01 16:55:37 -04:00
config-headerfooter.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
config-hooks.txt Add the ability to run a ref update hook 2012-11-27 20:02:46 -05:00
config-login-register.txt Separate the initial user setup instructions to a shared file 2012-11-28 16:54:10 +09:00
config-mail.txt Send email notification when commit message is edited 2012-12-06 09:49:13 +09:00
config-reverseproxy.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
config-sso.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
config-validation.txt Move commit message length checks to validation plugin 2013-02-22 16:02:17 +09:00
database-setup.txt Improve the instructions for PgSQL setup 2013-02-07 21:55:16 +01:00
dev-contributing.txt Add instructions on how to configure git for pushing to Gerrit's Gerrit 2013-02-08 17:50:23 +01:00
dev-design.txt Update document to add content of file comment. 2012-11-17 12:43:57 +08:00
dev-eclipse.txt Update the Maven plugin installation instructions 2012-10-30 18:19:42 +09:00
dev-plugins.txt Allow plugins to contribute InitStep to Gerrit init. 2012-10-22 10:07:31 -07:00
dev-readme.txt Update top level SUBMITTING_PATCHES 2012-02-13 23:34:50 -08:00
dev-release-deploy-config.txt Improve release documentation 2012-09-03 14:11:12 +02:00
dev-release-subproject.txt Improve release documentation 2012-09-03 14:11:12 +02:00
dev-release.txt Minor documentation tidy-up 2013-01-07 17:30:55 +09:00
error-branch-not-found.txt Adapt documentation to having 'Projects' as top level menu 2012-12-12 13:09:05 +01:00
error-change-closed.txt Add documentation of "change closed" error when using ssh review 2012-06-27 10:10:23 +02:00
error-change-does-not-belong-to-project.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-change-not-found.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-change-upload-blocked.txt Added explanation for "One or more refs/for/ ..." error 2011-02-03 08:53:46 +01:00
error-commit-already-exists.txt Add documentation of "commit already exists" error message 2012-12-11 17:54:13 +09:00
error-contains-banned-commit.txt Added explanation for "contains banned commit" error 2011-04-08 11:00:40 +02:00
error-has-duplicates.txt Added explanation for "... has duplicates" error 2011-03-10 13:17:36 +01:00
error-invalid-author.txt Correct documentation of "invalid author/committer" errors 2012-06-26 09:24:47 +02:00
error-invalid-changeid-line.txt Clarify error messages related to commit message footer content 2012-11-13 12:18:16 +09:00
error-invalid-committer.txt Correct documentation of "invalid author/committer" errors 2012-06-26 09:24:47 +02:00
error-messages.txt Fix error documentation for NoSuchProjectException 2013-02-19 08:39:18 +01:00
error-missing-changeid.txt Clarify error messages related to commit message footer content 2012-11-13 12:18:16 +09:00
error-multiple-changeid-lines.txt Clarify error messages related to commit message footer content 2012-11-13 12:18:16 +09:00
error-no-changes-made.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-no-common-ancestry.txt Added explanation for "no common ancestry" error 2011-01-25 15:33:40 +01:00
error-no-new-changes.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-non-fast-forward.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-not-a-gerrit-administrator.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-not-allowed-to-upload-merges.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-not-permitted-to-create.txt Added explanation for "Not permitted to create" error 2011-02-04 10:22:50 +01:00
error-not-signed-off-by.txt Clarify error messages related to commit message footer content 2012-11-13 12:18:16 +09:00
error-not-valid-ref.txt Added explanation for "not valid ref" error 2011-01-12 07:12:36 -08:00
error-permission-denied.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-prohibited-by-gerrit.txt Remove wrong error message if pushing a new ref fails 2013-01-23 09:59:48 +01:00
error-project-not-found.txt Fix error documentation for NoSuchProjectException 2013-02-19 08:39:18 +01:00
error-push-fails-due-to-commit-message.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-squash-commits-first.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
error-upload-denied.txt Access control documentation: Read and Submit 2012-01-23 16:46:57 +01:00
GEN-DOC-VERSION documentation: Fix version number to only consider x.y.z format 2010-02-22 14:14:53 -08:00
i18n-readme.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
index.txt Add documentation of plugin-based commit validation 2013-02-22 15:49:03 +09:00
install-j2ee.txt Fix the order of steps in the J2EE Installation document 2013-02-05 20:08:07 +01:00
install-quick.txt Separate the initial user setup instructions to a shared file 2012-11-28 16:54:10 +09:00
install.txt Separate the database setup instructions to a shared file 2012-11-28 16:54:10 +09:00
intro-quick.txt Update document to add content of file comment. 2012-11-17 12:43:57 +08:00
json.txt Add DRAFT change state to JSON documentation 2013-02-21 17:27:49 +09:00
licenses.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
Makefile Add asciidoc checks in the documentation makefile 2013-02-19 18:05:29 +09:00
pgm-daemon.txt Update pgm-daemon docs with the headless option. 2013-01-31 13:34:47 +01:00
pgm-gsql.txt Minor documentation formatting and white space errors fixed 2012-10-21 16:27:18 -07:00
pgm-index.txt Move code review notes logic to reviewnotes plugin 2013-02-01 11:05:48 +00:00
pgm-init.txt Documentation: Various corrections 2012-06-12 14:54:54 +02:00
pgm-LocalUsernamesToLowerCase.txt Enable case insensitive login to Gerrit WebUI for LDAP authentication 2011-10-26 23:01:57 +02:00
pgm-prolog-shell.txt prolog-shell: Simple command line Prolog interpreter 2011-06-21 14:15:53 -07:00
pgm-rulec.txt Fix spelling mistakes in Gerrit documentation 2011-10-27 02:24:06 +02:00
pgm-ScanTrackingIds.txt Fix spelling mistakes in Gerrit documentation 2011-10-27 02:24:06 +02:00
project-setup.txt Adapt documentation to having 'Projects' as top level menu 2012-12-12 13:09:05 +01:00
prolog-change-facts.txt Expose basic commit statistics for the prolog rule engine. 2012-10-23 10:32:25 -04:00
prolog-cookbook.txt Add submit_rule examples from Gerrit User Summit 2012. 2013-02-15 22:36:17 +01:00
rest-api-accounts.txt Document how to get the groups of a user via REST 2013-02-15 13:25:54 +01:00
rest-api-changes.txt Document how to get a reviewer of a change via REST 2013-02-22 15:48:02 +00:00
rest-api-groups.txt Do not try to list members of external groups 2013-02-22 12:19:20 -08:00
rest-api-projects.txt Improve wording of some REST endpoint descriptions 2013-02-22 09:14:30 +00:00
rest-api.txt Document the ChangeInfo JSON entity in the REST API documentation 2013-02-21 13:22:04 +01:00
user-changeid.txt Document execute permission for commit-msg in Change-Id docs 2012-10-03 19:16:05 -04:00
user-dashboards.txt Merge "Support 'foreach' in a project dashboard config" 2012-11-21 13:06:13 -08:00
user-notify.txt Add new notify type that allows watching abandoning of changes 2013-01-10 23:23:56 -08:00
user-search.txt Allow {} to be used for quoting in query expressions 2012-12-03 09:59:14 -08:00
user-signedoffby.txt documentation: Clean up references to 'Gerrit2' 2009-12-11 17:43:39 -08:00
user-submodules.txt Revert "Expand submodule subscription support" 2012-12-07 11:23:55 -08:00
user-upload.txt Add options to refs/for/ magic branch syntax 2013-02-27 16:07:30 -08:00