diff options
author | Sven Selberg <sven.selberg@axis.com> | 2023-01-09 08:32:27 +0000 |
---|---|---|
committer | Sven Selberg <svense@axis.com> | 2023-01-10 10:12:43 +0100 |
commit | 45ca178c6cc4d68669ca0a8b096bf6bc517cabd7 (patch) | |
tree | 1356aae27a377057d0e9faca42268f892af1b32b | |
parent | 978fb771f449b3c6e477895ed09c7eb454faf987 (diff) |
Doc: Use "change number" instead of "numeric-id"
Change number is an numeric ID but it is more commonly recognized as
"change number".
Change-Id: I0fa4e1dee42ef8d4bf2c8b9f2e8d0ecd19cca539
Release-Notes: skip
-rw-r--r-- | Documentation/intro-user.txt | 4 | ||||
-rw-r--r-- | Documentation/rest-api-changes.txt | 20 | ||||
-rw-r--r-- | Documentation/rest-api-config.txt | 2 | ||||
-rw-r--r-- | Documentation/user-notify.txt | 2 | ||||
-rw-r--r-- | Documentation/user-search.txt | 16 |
5 files changed, 21 insertions, 23 deletions
diff --git a/Documentation/intro-user.txt b/Documentation/intro-user.txt index 3f23385104..1f0dfd0e39 100644 --- a/Documentation/intro-user.txt +++ b/Documentation/intro-user.txt @@ -874,8 +874,8 @@ the numbers of added and deleted lines are shown as text, e.g. - [[show-change-number]]`Show Change Number In Changes Table`: + -Whether in change lists and dashboards an `ID` column with the numeric -change IDs should be shown. +Whether in change lists and dashboards an `ID` column with the change numbers +should be shown. - [[mute-common-path-prefixes]]`Mute Common Path Prefixes In File List`: + diff --git a/Documentation/rest-api-changes.txt b/Documentation/rest-api-changes.txt index 3974428724..1a999f1050 100644 --- a/Documentation/rest-api-changes.txt +++ b/Documentation/rest-api-changes.txt @@ -6260,7 +6260,7 @@ progress, the user will still be added. [[change-id]] === \{change-id\} Identifier that uniquely identifies one change. It contains the URL-encoded -project name as well as the change number: "'$$<project>~<numericId>$$'" +project name as well as the change number: "'$$<project>~<changeNumber>$$'" ==== Alternative identifiers Gerrit also supports an array of other change identifiers. @@ -6268,14 +6268,14 @@ Gerrit also supports an array of other change identifiers. [NOTE] Using these identifiers comes with a performance penalty as they require additional lookups to be translated to the -"'$$<project>~<numericId>$$'" identifier. +"'$$<project>~<changeNumber>$$'" identifier. * an ID of the change in the format "'$$<project>~<branch>~<Change-Id>$$'", where for the branch the `refs/heads/` prefix can be omitted ("$$myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940$$") * a Change-Id if it uniquely identifies one change ("I8473b95934b5732ac55d26311a706c9c2bde9940") -* a numeric change ID if it uniquely identifies one change ("4247") +* a change number if it uniquely identifies one change ("4247") [[change-message-id]] === \{change-message-id\} @@ -6579,8 +6579,8 @@ change index doesn't have the data. Number of unresolved inline comment threads across all patch sets. Not set if the current change index doesn't have the data. |`_number` || -The numeric ID of the change. (The underscore is just a relict of a prior -attempt to deprecate the numeric ID.) +The change number. (The underscore is just a relict of a prior +attempt to deprecate the change number.) |`owner` || The owner of the change as an link:rest-api-accounts.html#account-info[ AccountInfo] entity. @@ -6666,15 +6666,15 @@ When present, change is marked as Work In Progress. |`has_review_started` |optional, not set if `false`| When present, change has been marked Ready at some point in time. |`revert_of` |optional| -The numeric Change-Id of the change that this change reverts. +The change number of the change that this change reverts. |`submission_id` |optional| ID of the submission of this change. Only set if the status is `MERGED`. -This ID is equal to the numeric ID of the change that triggered the submission. -If the change that triggered the submission also has a topic, it will be -"<id>-<topic>" of the change that triggered the submission. +This ID is equal to the change number of the change that triggered the +submission. If the change that triggered the submission also has a topic, +it will be "<id>-<topic>" of the change that triggered the submission. The callers must not rely on the format of the submission ID. |`cherry_pick_of_change` |optional| -The numeric Change-Id of the change that this change was cherry-picked from. +The change number of the change that this change was cherry-picked from. Only set if the cherry-pick has been done through the Gerrit REST API (and not if a cherry-picked commit was pushed). |`cherry_pick_of_patch_set`|optional| diff --git a/Documentation/rest-api-config.txt b/Documentation/rest-api-config.txt index bd93b8bbe0..405681696e 100644 --- a/Documentation/rest-api-config.txt +++ b/Documentation/rest-api-config.txt @@ -1869,7 +1869,7 @@ Only set for disk caches. [[index-changes-input]] === IndexChangesInput -The `IndexChangesInput` contains a list of numerical changes IDs to index. +The `IndexChangesInput` contains a list of change numbers of changes to index. [options="header",cols="1,^2,4"] |================================ diff --git a/Documentation/user-notify.txt b/Documentation/user-notify.txt index 128bae65f4..0e658c7ae2 100644 --- a/Documentation/user-notify.txt +++ b/Documentation/user-notify.txt @@ -190,7 +190,7 @@ The change ID footer states the ID of the change, such as [[Gerrit-Change-Number]]Gerrit-Change-Number:: -The change number footer states the numeric ID of the change, for +The change number footer states the change number of the change, for example `92191`. [[Gerrit-PatchSet]]Gerrit-PatchSet:: diff --git a/Documentation/user-search.txt b/Documentation/user-search.txt index f07a5042f5..ccc83ebf6c 100644 --- a/Documentation/user-search.txt +++ b/Documentation/user-search.txt @@ -28,13 +28,13 @@ text and let Gerrit figure out the meaning: [options="header"] |============================================================= |Description | Examples -|Legacy numerical id | 15183 +|Change Id | 15183 |Full or abbreviated Change-Id | Ic0ff33 |Full or abbreviated commit SHA-1 | d81b32ef |Email address | user@example.com |============================================================= -For change searches (i.e. those using a numerical id, Change-Id, or commit +For change searches (i.e. those using a change number, Change-Id, or commit SHA-1), if the search results in a single change that change will be presented instead of a list. @@ -107,15 +107,13 @@ with `after:'TIME'`. [[change]] change:'ID':: + -Either a legacy numerical 'ID' such as 15183, or a newer style -Change-Id that was scraped out of the commit message. +Either a change number such as 15183, or a Change-Id from the Change-Id footer. [[conflicts]] conflicts:'ID':: + Changes that conflict with change 'ID'. Change 'ID' can be specified -as a legacy numerical 'ID' such as 15183, or a newer style Change-Id -that was scraped out of the commit message. +as a change number such as 15183, or a Change-Id from the Change-Id footer. [[destination]] destination:'[name=]NAME[,user=USER]':: @@ -173,7 +171,7 @@ will find changes where the caller has been CC'ed. [[revertof]] revertof:'ID':: + -Changes that revert the change specified by the numeric 'ID'. +Changes that revert the change specified by the change number. [[submissionid]] submissionid:'ID':: @@ -206,8 +204,8 @@ Changes occurring in projects starting with 'PREFIX'. [[parentof]] parentof:'ID':: Changes which are parent to the change specified by 'ID'. Change 'ID' can be -specified as a legacy numerical 'ID' such as 15183, or a Change-Id that can be -picked from the commit message. This operator will return immediate parents +specified as a change number such as 15183, or a Change-Id from the 'Change-Id' +footer of the commit message. This operator will return immediate parents and will not return grand parents or higher level ancestors of the given change. [[parentproject]] |