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
diff --git a/Documentation/rest-api-changes.txt b/Documentation/rest-api-changes.txt
index 7a7a173..619e121 100644
--- a/Documentation/rest-api-changes.txt
+++ b/Documentation/rest-api-changes.txt
@@ -1,17 +1,14 @@
-Gerrit Code Review - /changes/ REST API
-=======================================
+= Gerrit Code Review - /changes/ REST API
This page describes the change related REST endpoints.
Please also take note of the general information on the
link:rest-api.html[REST API].
[[change-endpoints]]
-Change Endpoints
-----------------
+== Change Endpoints
[[list-changes]]
-Query Changes
-~~~~~~~~~~~~~
+=== Query Changes
--
'GET /changes/'
--
@@ -368,8 +365,7 @@
----
[[get-change]]
-Get Change
-~~~~~~~~~~
+=== Get Change
--
'GET /changes/link:#change-id[\{change-id\}]'
--
@@ -418,8 +414,7 @@
----
[[get-change-detail]]
-Get Change Detail
-~~~~~~~~~~~~~~~~~
+=== Get Change Detail
--
'GET /changes/link:#change-id[\{change-id\}]/detail'
--
@@ -589,8 +584,7 @@
----
[[get-topic]]
-Get Topic
-~~~~~~~~~
+=== Get Topic
--
'GET /changes/link:#change-id[\{change-id\}]/topic'
--
@@ -615,8 +609,7 @@
If the change does not have a topic an empty string is returned.
[[set-topic]]
-Set Topic
-~~~~~~~~~
+=== Set Topic
--
'PUT /changes/link:#change-id[\{change-id\}]/topic'
--
@@ -651,8 +644,7 @@
If the topic was deleted the response is "`204 No Content`".
[[delete-topic]]
-Delete Topic
-~~~~~~~~~~~~
+=== Delete Topic
--
'DELETE /changes/link:#change-id[\{change-id\}]/topic'
--
@@ -677,8 +669,7 @@
----
[[abandon-change]]
-Abandon Change
-~~~~~~~~~~~~~~
+=== Abandon Change
--
'POST /changes/link:#change-id[\{change-id\}]/abandon'
--
@@ -738,8 +729,7 @@
----
[[restore-change]]
-Restore Change
-~~~~~~~~~~~~~~
+=== Restore Change
--
'POST /changes/link:#change-id[\{change-id\}]/restore'
--
@@ -799,8 +789,7 @@
----
[[rebase-change]]
-Rebase Change
-~~~~~~~~~~~~~
+=== Rebase Change
--
'POST /changes/link:#change-id[\{change-id\}]/rebase'
--
@@ -891,8 +880,7 @@
----
[[revert-change]]
-Revert Change
-~~~~~~~~~~~~~
+=== Revert Change
--
'POST /changes/link:#change-id[\{change-id\}]/revert'
--
@@ -952,8 +940,7 @@
----
[[submit-change]]
-Submit Change
-~~~~~~~~~~~~~
+=== Submit Change
--
'POST /changes/link:#change-id[\{change-id\}]/submit'
--
@@ -1016,8 +1003,7 @@
----
[[publish-draft-change]]
-Publish Draft Change
-~~~~~~~~~~~~~~~~~~~~
+=== Publish Draft Change
--
'POST /changes/link:#change-id[\{change-id\}]/publish'
--
@@ -1036,8 +1022,7 @@
----
[[delete-draft-change]]
-Delete Draft Change
-~~~~~~~~~~~~~~~~~~~
+=== Delete Draft Change
--
'DELETE /changes/link:#change-id[\{change-id\}]'
--
@@ -1056,8 +1041,7 @@
----
[[get-included-in]]
-Get Included In
-~~~~~~~~~~~~~~~
+=== Get Included In
--
'GET /changes/link:#change-id[\{change-id\}]/in'
--
@@ -1087,12 +1071,10 @@
----
[[reviewer-endpoints]]
-Reviewer Endpoints
-------------------
+== Reviewer Endpoints
[[list-reviewers]]
-List Reviewers
-~~~~~~~~~~~~~~
+=== List Reviewers
--
'GET /changes/link:#change-id[\{change-id\}]/reviewers/'
--
@@ -1138,8 +1120,7 @@
----
[[suggest-reviewers]]
-Suggest Reviewers
-~~~~~~~~~~~~~~~~~
+=== Suggest Reviewers
--
'GET /changes/link:#change-id[\{change-id\}]/suggest_reviewers?q=J&n=5'
--
@@ -1181,8 +1162,7 @@
----
[[get-reviewer]]
-Get Reviewer
-~~~~~~~~~~~~
+=== Get Reviewer
--
'GET /changes/link:#change-id[\{change-id\}]/reviewers/link:rest-api-accounts.html#account-id[\{account-id\}]'
--
@@ -1217,8 +1197,7 @@
----
[[add-reviewer]]
-Add Reviewer
-~~~~~~~~~~~~
+=== Add Reviewer
--
'POST /changes/link:#change-id[\{change-id\}]/reviewers'
--
@@ -1309,8 +1288,7 @@
----
[[delete-reviewer]]
-Delete Reviewer
-~~~~~~~~~~~~~~~
+=== Delete Reviewer
--
'DELETE /changes/link:#change-id[\{change-id\}]/reviewers/link:rest-api-accounts.html#account-id[\{account-id\}]'
--
@@ -1328,12 +1306,10 @@
----
[[revision-endpoints]]
-Revision Endpoints
-------------------
+== Revision Endpoints
[[get-commit]]
-Get Commit
-~~~~~~~~~~
+=== Get Commit
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/commit'
--
@@ -1382,8 +1358,7 @@
[[get-review]]
-Get Review
-~~~~~~~~~~
+=== Get Review
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/review'
--
@@ -1518,8 +1493,7 @@
----
[[set-review]]
-Set Review
-~~~~~~~~~~
+=== Set Review
--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/review'
--
@@ -1572,8 +1546,7 @@
----
[[rebase-revision]]
-Rebase Revision
-~~~~~~~~~~~~~~~
+=== Rebase Revision
--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/rebase'
--
@@ -1664,8 +1637,7 @@
----
[[submit-revision]]
-Submit Revision
-~~~~~~~~~~~~~~~
+=== Submit Revision
--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/submit'
--
@@ -1715,8 +1687,7 @@
----
[[publish-draft-revision]]
-Publish Draft Revision
-~~~~~~~~~~~~~~~~~~~~~~
+=== Publish Draft Revision
--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/publish'
--
@@ -1735,8 +1706,7 @@
----
[[delete-draft-revision]]
-Delete Draft Revision
-~~~~~~~~~~~~~~~~~~~~~
+=== Delete Draft Revision
--
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]'
--
@@ -1755,8 +1725,7 @@
----
[[get-patch]]
-Get Patch
-~~~~~~~~~
+=== Get Patch
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/patch'
--
@@ -1791,8 +1760,7 @@
for later processing by command line tools.
[[get-mergeable]]
-Get Mergeable
-~~~~~~~~~~~~~
+=== Get Mergeable
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/mergeable'
--
@@ -1819,8 +1787,7 @@
----
[[get-submit-type]]
-Get Submit Type
-~~~~~~~~~~~~~~~
+=== Get Submit Type
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/submit_type'
--
@@ -1843,8 +1810,7 @@
----
[[test-submit-type]]
-Test Submit Type
-~~~~~~~~~~~~~~~~
+=== Test Submit Type
--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/test.submit_type'
--
@@ -1875,8 +1841,7 @@
----
[[test-submit-rule]]
-Test Submit Rule
-~~~~~~~~~~~~~~~~
+=== Test Submit Rule
--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/test.submit_rule'
--
@@ -1918,8 +1883,7 @@
----
[[list-drafts]]
-List Drafts
-~~~~~~~~~~~
+=== List Drafts
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/'
--
@@ -1965,8 +1929,7 @@
----
[[create-draft]]
-Create Draft
-~~~~~~~~~~~~
+=== Create Draft
--
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts'
--
@@ -2009,8 +1972,7 @@
----
[[get-draft]]
-Get Draft
-~~~~~~~~~
+=== Get Draft
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
--
@@ -2044,8 +2006,7 @@
----
[[update-draft]]
-Update Draft
-~~~~~~~~~~~~
+=== Update Draft
--
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
--
@@ -2088,8 +2049,7 @@
----
[[delete-draft]]
-Delete Draft
-~~~~~~~~~~~~
+=== Delete Draft
--
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
--
@@ -2107,8 +2067,7 @@
----
[[list-comments]]
-List Comments
-~~~~~~~~~~~~~
+=== List Comments
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/comments/'
--
@@ -2163,8 +2122,7 @@
----
[[get-comment]]
-Get Comment
-~~~~~~~~~~~
+=== Get Comment
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/comments/link:#comment-id[\{comment-id\}]'
--
@@ -2202,8 +2160,7 @@
----
[[list-files]]
-List Files
-~~~~~~~~~~
+=== List Files
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/'
--
@@ -2261,8 +2218,7 @@
----
[[get-content]]
-Get Content
-~~~~~~~~~~~
+=== Get Content
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/content'
--
@@ -2286,8 +2242,7 @@
----
[[get-diff]]
-Get Diff
-~~~~~~~~
+=== Get Diff
--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/diff'
--
@@ -2459,8 +2414,7 @@
in the diff. Valid values are `ALL` or number of lines.
[[set-reviewed]]
-Set Reviewed
-~~~~~~~~~~~~
+=== Set Reviewed
--
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/reviewed'
--
@@ -2481,8 +2435,7 @@
response is "`200 OK`".
[[delete-reviewed]]
-Delete Reviewed
-~~~~~~~~~~~~~~~
+=== Delete Reviewed
--
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/reviewed'
--
@@ -2500,8 +2453,7 @@
----
[[cherry-pick]]
-Cherry Pick Revision
-~~~~~~~~~~~~~~~~~~~~
+=== Cherry Pick Revision
--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/cherrypick'
--
@@ -2554,8 +2506,7 @@
----
[[message]]
-Edit Commit Message
-~~~~~~~~~~~~~~~~~~~
+=== Edit Commit Message
--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/message'
--
@@ -2607,18 +2558,15 @@
----
[[ids]]
-IDs
----
+== IDs
[[account-id]]
-link:rest-api-accounts.html#account-id[\{account-id\}]
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== link:rest-api-accounts.html#account-id[\{account-id\}]
--
--
[[change-id]]
-\{change-id\}
-~~~~~~~~~~~~~
+=== \{change-id\}
Identifier that uniquely identifies one change.
This can be:
@@ -2631,13 +2579,11 @@
* a legacy numeric change ID ("4247")
[[comment-id]]
-\{comment-id\}
-~~~~~~~~~~~~~~
+=== \{comment-id\}
UUID of a published comment.
[[draft-id]]
-\{draft-id\}
-~~~~~~~~~~~~
+=== \{draft-id\}
UUID of a draft comment.
[[file-id]]
@@ -2646,8 +2592,7 @@
The path of the file.
[[revision-id]]
-\{revision-id\}
-~~~~~~~~~~~~~~~
+=== \{revision-id\}
Identifier that uniquely identifies one revision of a change.
This can be:
@@ -2659,12 +2604,10 @@
* a legacy numeric patch number ("1" for first patch set of the change)
[[json-entities]]
-JSON Entities
--------------
+== JSON Entities
[[abandon-input]]
-AbandonInput
-~~~~~~~~~~~~
+=== AbandonInput
The `AbandonInput` entity contains information for abandoning a change.
[options="header",width="50%",cols="1,^1,5"]
@@ -2676,8 +2619,7 @@
|===========================
[[action-info]]
-ActionInfo
-~~~~~~~~~~
+=== ActionInfo
The `ActionInfo` entity describes a REST API call the client can
make to manipulate a resource. These are frequently implemented by
plugins and may be discovered at runtime.
@@ -2703,8 +2645,7 @@
|====================================
[[add-reviewer-result]]
-AddReviewerResult
-~~~~~~~~~~~~~~~~~
+=== AddReviewerResult
The `AddReviewerResult` entity describes the result of adding a
reviewer to a change.
@@ -2723,8 +2664,7 @@
|===========================
[[approval-info]]
-ApprovalInfo
-~~~~~~~~~~~~
+=== ApprovalInfo
The `ApprovalInfo` entity contains information about an approval from a
user for a label on a change.
@@ -2744,8 +2684,7 @@
|===========================
[[group-base-info]]
-GroupBaseInfo
-~~~~~~~~~~~~~
+=== GroupBaseInfo
The `GroupBaseInfo` entity contains base information about the group.
[options="header",width="50%",cols="1,6"]
@@ -2756,8 +2695,7 @@
|==========================
[[change-info]]
-ChangeInfo
-~~~~~~~~~~
+=== ChangeInfo
The `ChangeInfo` entity contains information about a change.
[options="header",width="50%",cols="1,^1,5"]
@@ -2837,8 +2775,7 @@
|==================================
[[change-message-info]]
-ChangeMessageInfo
-~~~~~~~~~~~~~~~~~
+=== ChangeMessageInfo
The `ChangeMessageInfo` entity contains information about a message
attached to a change.
@@ -2858,8 +2795,7 @@
|==================================
[[cherrypick-input]]
-CherryPickInput
-~~~~~~~~~~~~~~~
+=== CherryPickInput
The `CherryPickInput` entity contains information for cherry-picking a change to a new branch.
[options="header",width="50%",cols="1,6"]
@@ -2870,8 +2806,7 @@
|===========================
[[comment-info]]
-CommentInfo
-~~~~~~~~~~~
+=== CommentInfo
The `CommentInfo` entity contains information about an inline comment.
[options="header",width="50%",cols="1,^1,5"]
@@ -2906,8 +2841,7 @@
|===========================
[[comment-input]]
-CommentInput
-~~~~~~~~~~~~
+=== CommentInput
The `CommitInput` entity contains information for creating an inline
comment.
@@ -2947,8 +2881,7 @@
|===========================
[[comment-range]]
-CommentRange
-~~~~~~~~~~~~
+=== CommentRange
The `CommentRange` entity describes the range of an inline comment.
[options="header",width="50%",cols="1,^1,5"]
@@ -2961,8 +2894,7 @@
|===========================
[[commit-info]]
-CommitInfo
-~~~~~~~~~~
+=== CommitInfo
The `CommitInfo` entity contains information about a commit.
[options="header",width="50%",cols="1,6"]
@@ -2983,8 +2915,7 @@
|==========================
[[diff-content]]
-DiffContent
-~~~~~~~~~~~
+=== DiffContent
The `DiffContent` entity contains information about the content differences
in a file.
@@ -3005,8 +2936,7 @@
|==========================
[[diff-file-meta-info]]
-DiffFileMetaInfo
-~~~~~~~~~~~~~~~~
+=== DiffFileMetaInfo
The `DiffFileMetaInfo` entity contains meta information about a file diff.
[options="header",width="50%",cols="1,6"]
@@ -3018,8 +2948,7 @@
|==========================
[[diff-info]]
-DiffInfo
-~~~~~~~~
+=== DiffInfo
The `DiffInfo` entity contains information about the diff of a file
in a revision.
@@ -3042,8 +2971,7 @@
|==========================
[[diff-intraline-info]]
-DiffIntralineInfo
-~~~~~~~~~~~~~~~~~
+=== DiffIntralineInfo
The `DiffIntralineInfo` entity contains information about intraline edits in a
file.
@@ -3057,8 +2985,7 @@
the length calculation, and thus it is possible for the edits to span newlines.
[[fetch-info]]
-FetchInfo
-~~~~~~~~~
+=== FetchInfo
The `FetchInfo` entity contains information about how to fetch a patch
set via a certain protocol.
@@ -3074,8 +3001,7 @@
|==========================
[[file-info]]
-FileInfo
-~~~~~~~~
+=== FileInfo
The `FileInfo` entity contains information about a file in a patch set.
[options="header",width="50%",cols="1,^1,5"]
@@ -3098,8 +3024,7 @@
|=============================
[[git-person-info]]
-GitPersonInfo
-~~~~~~~~~~~~~
+=== GitPersonInfo
The `GitPersonInfo` entity contains information about the
author/committer of a commit.
@@ -3115,8 +3040,7 @@
|==========================
[[label-info]]
-LabelInfo
-~~~~~~~~~
+=== LabelInfo
The `LabelInfo` entity contains information about a label on a change, always
corresponding to the current patch set.
@@ -3127,8 +3051,7 @@
* For detailed information about labels, including exact numeric votes for all
users and the allowed range of votes for the current user, use `DETAILED_LABELS`.
-Common fields
-^^^^^^^^^^^^^
+==== Common fields
[options="header",width="50%",cols="1,^1,5"]
|===========================
|Field Name ||Description
@@ -3138,8 +3061,7 @@
set.
|===========================
-Fields set by `LABELS`
-^^^^^^^^^^^^^^^^^^^^^^
+==== Fields set by `LABELS`
[options="header",width="50%",cols="1,^1,5"]
|===========================
|Field Name ||Description
@@ -3160,8 +3082,7 @@
"`+1`"/"`-1`".
|===========================
-Fields set by `DETAILED_LABELS`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Fields set by `DETAILED_LABELS`
[options="header",width="50%",cols="1,^1,5"]
|===========================
|Field Name ||Description
@@ -3174,8 +3095,7 @@
[[restore-input]]
-RestoreInput
-~~~~~~~~~~~~
+=== RestoreInput
The `RestoreInput` entity contains information for restoring a change.
[options="header",width="50%",cols="1,^1,5"]
@@ -3187,8 +3107,7 @@
|===========================
[[revert-input]]
-RevertInput
-~~~~~~~~~~~
+=== RevertInput
The `RevertInput` entity contains information for reverting a change.
[options="header",width="50%",cols="1,^1,5"]
@@ -3200,8 +3119,7 @@
|===========================
[[review-info]]
-ReviewInfo
-~~~~~~~~~~
+=== ReviewInfo
The `ReviewInfo` entity contains information about a review.
[options="header",width="50%",cols="1,6"]
@@ -3213,8 +3131,7 @@
|===========================
[[review-input]]
-ReviewInput
-~~~~~~~~~~~
+=== ReviewInput
The `ReviewInput` entity contains information for adding a review to a
revision.
@@ -3254,8 +3171,7 @@
|============================
[[reviewer-info]]
-ReviewerInfo
-~~~~~~~~~~~~
+=== ReviewerInfo
The `ReviewerInfo` entity contains information about a reviewer and its
votes on a change.
@@ -3274,8 +3190,7 @@
|==========================
[[reviewer-input]]
-ReviewerInput
-~~~~~~~~~~~~~
+=== ReviewerInput
The `ReviewerInput` entity contains information for adding a reviewer
to a change.
@@ -3296,8 +3211,7 @@
|===========================
[[revision-info]]
-RevisionInfo
-~~~~~~~~~~~~
+=== RevisionInfo
The `RevisionInfo` entity contains information about a patch set.
[options="header",width="50%",cols="1,^1,5"]
@@ -3324,8 +3238,7 @@
|===========================
[[rule-input]]
-RuleInput
-~~~~~~~~~
+=== RuleInput
The `RuleInput` entity contains information to test a Prolog rule.
[options="header",width="50%",cols="1,^1,5"]
@@ -3342,8 +3255,7 @@
|===========================
[[suggested-reviewer-info]]
-SuggestedReviewerInfo
-~~~~~~~~~~~~~~~~~~~~~
+=== SuggestedReviewerInfo
The `SuggestedReviewerInfo` entity contains information about a reviewer
that can be added to a change (an account or a group).
@@ -3353,8 +3265,7 @@
link:rest-api-changes.html#group-base-info[GroupBaseInfo] entity.
[[submit-info]]
-SubmitInfo
-~~~~~~~~~~
+=== SubmitInfo
The `SubmitInfo` entity contains information about the change status
after submitting.
@@ -3370,8 +3281,7 @@
|==========================
[[submit-input]]
-SubmitInput
-~~~~~~~~~~~
+=== SubmitInput
The `SubmitInput` entity contains information for submitting a change.
[options="header",width="50%",cols="1,^1,5"]
@@ -3385,8 +3295,7 @@
|===========================
[[submit-record]]
-SubmitRecord
-~~~~~~~~~~~~
+=== SubmitRecord
The `SubmitRecord` entity describes results from a submit_rule.
[options="header",width="50%",cols="1,^1,5"]
@@ -3421,8 +3330,7 @@
|===========================
[[topic-input]]
-TopicInput
-~~~~~~~~~~
+=== TopicInput
The `TopicInput` entity contains information for setting a topic.
[options="header",width="50%",cols="1,^1,5"]
@@ -3436,8 +3344,7 @@
|===========================
[[included-in-info]]
-IncludedInInfo
-~~~~~~~~~~~~~~
+=== IncludedInInfo
The `IncludedInInfo` entity contains information about the branches a
change was merged into and tags it was tagged with.
