opendev/gerrit
Code Issues Proposed changes

Document magic files

Browse Source 
Change-Id: Ie42c1aa48798efeace7d275a99478a92b35b0c93
Signed-off-by: Edwin Kempin <ekempin@google.com>
This commit is contained in:
Edwin Kempin
2016-12-05 16:39:03 +01:00
parent c89244818e
commit 8fd96b9978
2 changed files with 36 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
Documentation/rest-api-changes.txt
View File

@@ -246,17 +246,17 @@ default. Optional fields are:
[[current-files]]
--
* `CURRENT_FILES`: list files modified by the commit, including
basic line counts inserted/deleted per file. Only valid when
the `CURRENT_REVISION` or `ALL_REVISIONS` option is selected.
* `CURRENT_FILES`: list files modified by the commit and magic files,
including basic line counts inserted/deleted per file. Only valid
when the `CURRENT_REVISION` or `ALL_REVISIONS` option is selected.
--
[[all-files]]
--
* `ALL_FILES`: list files modified by the commit, including
basic line counts inserted/deleted per file. If only the
`CURRENT_REVISION` was requested then only that commit's
modified files will be output.
* `ALL_FILES`: list files modified by the commit and magic files,
including basic line counts inserted/deleted per file. If only the
`CURRENT_REVISION` was requested then only that commit's modified
files will be output.
--
[[detailed-accounts]]
@@ -4133,6 +4133,18 @@ returned that describes the robot comment.
Lists the files that were modified, added or deleted in a revision.
In addition the following magic files are included:
* `/COMMIT_MSG`:
+
The commit message and headers with the parent commit(s), the author
information and the committer information.
* `/MERGE_LIST` (for merge commits only):
+
The list of commits that are being integrated into the destination
branch by submitting the merge commit.
.Request
----
GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/files/ HTTP/1.0

17
Documentation/user-review-ui.txt
View File

@@ -297,6 +297,23 @@ patch set.
image::images/user-review-ui-change-screen-file-list.png[width=800, link="images/user-review-ui-change-screen-file-list.png"]
[[magic-files]]
In addition to the modified files the file list contains magic files
that are generated by Gerrit and which don't exist in the repository.
The magic files contain additional commit data that should be
reviewable and allow users to comment on this data. The magic files are
always listed first. The following magic files exist:
* `Commit Message`:
+
The commit message and headers with the parent commit(s), the author
information and the committer information.
* `Merge List` (for merge commits only):
+
The list of commits that are being integrated into the destination
branch by submitting the merge commit.
[[change-screen-mark-reviewed]]
The checkboxes in front of the file names allow files to be marked as reviewed.