ChangeScreen2: Update the documentation with recently made changes
Change-Id: I939710ed7c8c96c51dabb0c013093c9c0fda7bd6
diff --git a/Documentation/intro-change-screen.txt b/Documentation/intro-change-screen.txt
index 80ac974..60988d2 100644
--- a/Documentation/intro-change-screen.txt
+++ b/Documentation/intro-change-screen.txt
@@ -54,6 +54,16 @@
The download commands are moved to the 'Download' drop down box. Patch files
can be downloaded as base64 encoded or zipped versions.
+[[included-in]]
+Included in
+-----------
+
+To see the branches a specific change was merged into and the list of the tags
+a change was tagged with, use the 'Included In' drop down on the change header,
+to the left of the 'Revisions' drop down.
+
+Note that this list is only visible on merged changes.
+
[[quick-approve]]
Quick approve
-------------
@@ -86,7 +96,6 @@
Key bindings: "a" to open the drop down. "ESC" to close it.
-
[[edit-commit-message]]
Edit commit message
-------------------
@@ -96,6 +105,20 @@
Key bindings: "e" to open the drop down. "ESC" to close it.
+[[star-change]]
+
+Star change icon allows to star the change, so that "starredby:self" query can
+retrieve the ctarred changes later. If the change is aleady starred, then
+clicking the icon again unstars the change.
+
+Key bindings: "s" to star/unstar the change.
+
+[[permalink-change]]
+
+Right to the star change icon is "Change <change link>" control that serves
+for two purposes: reload the change and permalink the change. To permalink,
+Right mouse click -> Copy Link Address.
+
[[edit-change-topic]]
Edit change topic
-----------------
@@ -170,12 +193,14 @@
The default delay is 30 seconds. It can be configured with the
link:config-gerrit.html[change.updateDelay] setting.
-[[depends-on-needed-by]]
-"Depends on" and "Needed by"
-----------------------------
+[[related-changes]]
+"Related changes"
+-----------------
-Dependencies and dependent changes are listed in the 'Related Changes' drop
-down.
+A tab control on the third column shows the related changes:
+Dependencies and dependent changes are listed on the 'Related Changes' tab.
+Changes that are conflicting with the current change are listed on the
+'Conflicts With' tab.
Key bindings: "J" & "K" to navigate between the related changes. "O" to
open the currently selected related change.
@@ -190,15 +215,24 @@
Key bindings: "j" & "k" to navigate in the file table, and "r" to toggle the
'reviewed' flag.
-[[included-in]]
-Included in
------------
+[[diff-against]]
+Diff against
+------------
-To see the branches a specific change was merged into and the list of the tags
-a change was tagged with, use the 'Included In' drop down on the change header,
-to the left of the 'Revisions' drop down.
+In the 'Diff against' dropdown, base reference version can be selected. On
+selecting an entry the file table list is reloaded and shows only the files
+that were changed compared to this reference version. The selected revision
+is passed to the side by side view, so that code mirror windows "remember"
+the base reference version choice made on the change screen.
-Note that this list is only visible on merged changes.
+[[history]]
+History
+-------
+
+The history table shows change messages and inline file comments. Expand All and
+Collapse All buttons show/hide the messages.
+
+Key bindings: "x" expands all messages, "z" collapses them again.
[[missing-features]]
Missing features
@@ -206,9 +240,7 @@
Several features have not been implemented yet:
-* Permalink a change
* Allow to see if a reviewer can't vote on a label
-* Allow to select a reference version as base for the comparison
* Change diff view preferences
GERRIT
