Fix formatting issues in error documentation
Most of the bulleted and numbered list in the error documentation
were incorrectly formatted.
Change-Id: Ib3ef44427c97dd8ed68b28414d477df372330a54
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
diff --git a/Documentation/error-branch-not-found.txt b/Documentation/error-branch-not-found.txt
index b19bf92..43d3546 100644
--- a/Documentation/error-branch-not-found.txt
+++ b/Documentation/error-branch-not-found.txt
@@ -11,6 +11,7 @@
the push is failing with the error message 'branch ... not found'.
To fix this problem verify
+
* that the branch name in the push specification is typed correctly
(case sensitive) and
* that the branch really exists for this project (in the Gerrit WebUI
@@ -18,10 +19,12 @@
'Branches' to see all existing branches).
If it was your intention to create a new branch you can either
+
* bypass code review on push as explained link:user-upload.html#bypass_review[here] or
* create the new branch in the Gerrit WebUI before pushing (go to
'Admin' -> 'Projects' and browse your project, in the 'Branches'
tab you can then create a new branch).
+
Please note that you need the access right '+2 Create Branch' in the
link:access-control.html#category_pHD['Push Branch'] category to create new branches.
diff --git a/Documentation/error-messages.txt b/Documentation/error-messages.txt
index 86b0eb6..7e16504 100644
--- a/Documentation/error-messages.txt
+++ b/Documentation/error-messages.txt
@@ -31,7 +31,7 @@
* link:error-permission-denied.html[Permission denied (publickey)]
* link:error-prohibited-by-gerrit.html[prohibited by Gerrit]
* link:error-squash-commits-first.html[squash commits first]
-* link:error-upload-denied.html[Upload denied for project '...']
+* link:error-upload-denied.html[Upload denied for project \'...']
* link:error-not-allowed-to-upload-merges.html[you are not allowed to upload merges]
* link:error-you-are-not-author.html[you are not author ...]
* link:error-you-are-not-committer.html[you are not committer ...]
diff --git a/Documentation/error-missing-changeid.txt b/Documentation/error-missing-changeid.txt
index 5af5f7a..daa1d46 100644
--- a/Documentation/error-missing-changeid.txt
+++ b/Documentation/error-missing-changeid.txt
@@ -7,9 +7,10 @@
a Change-Id.
This error may happen for two reasons:
-1. missing Change-Id in the commit message
-2. Change-Id is contained in the commit message but not in the last
- paragraph
+
+. missing Change-Id in the commit message
+. Change-Id is contained in the commit message but not in the last
+ paragraph
You can see the commit messages for existing commits in the history
by doing a link:http://www.kernel.org/pub/software/scm/git/docs/git-log.html[git log].
diff --git a/Documentation/error-no-changes-made.txt b/Documentation/error-no-changes-made.txt
index aabfea9..7ef7082 100644
--- a/Documentation/error-no-changes-made.txt
+++ b/Documentation/error-no-changes-made.txt
@@ -7,10 +7,12 @@
A pushed commit is considered to be identical with the current patch
set if
+
- the files in the commit,
- the commit message,
- the author of the commit and
- the parents of the commit
+
are all identical.
diff --git a/Documentation/error-no-new-changes.txt b/Documentation/error-no-new-changes.txt
index 4000f72..347c080 100644
--- a/Documentation/error-no-new-changes.txt
+++ b/Documentation/error-no-new-changes.txt
@@ -10,10 +10,11 @@
pushed. Still this error message may sometimes come as a surprise if
you expected a new commit to be pushed. In this case you should
verify that:
-1. your changes were successfully committed locally (otherwise there
- is no new commit which can be pushed)
-2. you are pushing the correct commit (e.g. if you are pushing HEAD
- make sure you have locally checked out the correct branch)
+
+. your changes were successfully committed locally (otherwise there
+ is no new commit which can be pushed)
+. you are pushing the correct commit (e.g. if you are pushing HEAD
+ make sure you have locally checked out the correct branch)
If you are sure you are pushing the correct commit and you are still
getting the "no new changes" error unexpectedly you can take the
@@ -23,17 +24,18 @@
Please note that each commit can really be pushed only once. This
means:
-1. you cannot push a commit again even if the change for which the
- commit was pushed before was abandoned (but you may restore the
- abandoned change)
-2. you cannot reset a change to an old patch set by pushing the old
- commit for this change again
-3. if a commit was pushed to one branch you cannot push this commit
- to another branch
-4. if a commit was pushed directly to a branch (without going through
- code review) you cannot push this commit once again for code
- review (please note that in this case searching by the commit ID
- in the Gerrit WebUI will not find any change)
+
+. you cannot push a commit again even if the change for which the
+ commit was pushed before was abandoned (but you may restore the
+ abandoned change)
+. you cannot reset a change to an old patch set by pushing the old
+ commit for this change again
+. if a commit was pushed to one branch you cannot push this commit
+ to another branch
+. if a commit was pushed directly to a branch (without going through
+ code review) you cannot push this commit once again for code
+ review (please note that in this case searching by the commit ID
+ in the Gerrit WebUI will not find any change)
If you need to re-push a commit you may rewrite this commit by
link:http://www.kernel.org/pub/software/scm/git/docs/git-commit.html[amending] it or doing an interactive link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[git rebase]. By rewriting the
diff --git a/Documentation/error-non-fast-forward.txt b/Documentation/error-non-fast-forward.txt
index 453cd3d..7dba51b 100644
--- a/Documentation/error-non-fast-forward.txt
+++ b/Documentation/error-non-fast-forward.txt
@@ -15,8 +15,9 @@
link:user-upload.html#bypass_review[code review is bypassed].
There are different reasons why this error can occur:
-1. the remote branch has evolved since you started your development
-2. you are pushing the commit to the wrong project
+
+. the remote branch has evolved since you started your development
+. you are pushing the commit to the wrong project
the remote branch has evolved since you started your development
@@ -28,8 +29,10 @@
remote branch evolves. If you are now pushing your commit, with
bypassing code review, your push will be rejected with the error
message 'non-fast forward'. To solve the problem you have to either
-1. link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[rebase] your commit on the new tip of the remote branch or
-2. link:http://www.kernel.org/pub/software/scm/git/docs/git-merge.html[merge] your commit with the new tip of the remote branch.
+
+. link:http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html[rebase] your commit on the new tip of the remote branch or
+. link:http://www.kernel.org/pub/software/scm/git/docs/git-merge.html[merge] your commit with the new tip of the remote branch.
+
Afterwards the push should be successful.
diff --git a/Documentation/error-not-a-gerrit-project.txt b/Documentation/error-not-a-gerrit-project.txt
index 1b529a7..f6e90fa 100644
--- a/Documentation/error-not-a-gerrit-project.txt
+++ b/Documentation/error-not-a-gerrit-project.txt
@@ -10,15 +10,16 @@
its git repository (excluding the '.git' extension).
If you are facing this problem, do the following:
-1. Verify that the project name specified as git repository in the
- push command is typed correctly (case sensitive).
-2. Verify that you are pushing to the correct Gerrit server.
-3. Go in the Gerrit WebUI to 'Admin' -> 'Projects' and check that the
- project is listed. If the project is not listed the project either
- does not exist or you don't have read access ('+1 Read Access' in
- the link:access-control.html#category_READ['Read Access'] category) for it. This means if you certain that
- the project name is right you should contact the Gerrit
- Administrator or project owner to request access to the project.
+
+. Verify that the project name specified as git repository in the
+ push command is typed correctly (case sensitive).
+. Verify that you are pushing to the correct Gerrit server.
+. Go in the Gerrit WebUI to 'Admin' -> 'Projects' and check that the
+ project is listed. If the project is not listed the project either
+ does not exist or you don't have read access ('+1 Read Access' in
+ the link:access-control.html#category_READ['Read Access'] category) for it. This means if you certain that
+ the project name is right you should contact the Gerrit
+ Administrator or project owner to request access to the project.
This error message might be misleading if the project actually exists
but the push is failing because the pushing user has no read access
diff --git a/Documentation/error-not-signed-off-by.txt b/Documentation/error-not-signed-off-by.txt
index 726caa4..4f88774 100644
--- a/Documentation/error-not-signed-off-by.txt
+++ b/Documentation/error-not-signed-off-by.txt
@@ -12,11 +12,12 @@
This error may happen for different reasons if you do not have the
access right to forge the committer identity:
-1. missing Signed-off-by in the commit message
-2. Signed-off-by is contained in the commit message but it's neither
- from the author, committer nor uploader
-3. Signed-off-by from the author, committer or uploader is contained
- in the commit message but not in the last paragraph
+
+. missing Signed-off-by in the commit message
+. Signed-off-by is contained in the commit message but it's neither
+ from the author, committer nor uploader
+. Signed-off-by from the author, committer or uploader is contained
+ in the commit message but not in the last paragraph
To be able to push your commits you have to update the commit
messages as explained link:error-push-fails-due-to-commit-message.html[here] so that they contain a Signed-off-by from
diff --git a/Documentation/error-permission-denied.txt b/Documentation/error-permission-denied.txt
index 75c4528..1cb5708 100644
--- a/Documentation/error-permission-denied.txt
+++ b/Documentation/error-permission-denied.txt
@@ -9,17 +9,18 @@
SSH key and the corresponding public SSH key must be known to Gerrit.
If you are facing this problem, do the following:
-1. Verify that you are using the correct username for the SSH command
- and that it is typed correctly (case sensitive). You can look up
- your username in the Gerrit WebUI under 'Settings' -> 'Profile'.
-2. Verify that you have uploaded your public SSH key for your Gerrit
- account. To do this go in the Gerrit WebUI to 'Settings' ->
- 'SSH Public Keys' and check that your public SSH key is there. If
- your public SSH key is not there you have to upload it.
-3. Verify that you are using the correct private SSH key. To find out
- which private SSH key is used test the SSH authentication as
- described below. From the trace you should see which private SSH
- key is used.
+
+. Verify that you are using the correct username for the SSH command
+ and that it is typed correctly (case sensitive). You can look up
+ your username in the Gerrit WebUI under 'Settings' -> 'Profile'.
+. Verify that you have uploaded your public SSH key for your Gerrit
+ account. To do this go in the Gerrit WebUI to 'Settings' ->
+ 'SSH Public Keys' and check that your public SSH key is there. If
+ your public SSH key is not there you have to upload it.
+. Verify that you are using the correct private SSH key. To find out
+ which private SSH key is used test the SSH authentication as
+ described below. From the trace you should see which private SSH
+ key is used.
Test SSH authentication
diff --git a/Documentation/error-prohibited-by-gerrit.txt b/Documentation/error-prohibited-by-gerrit.txt
index 3f8e4d8..90c937e 100644
--- a/Documentation/error-prohibited-by-gerrit.txt
+++ b/Documentation/error-prohibited-by-gerrit.txt
@@ -6,6 +6,7 @@
privileges.
In particular this error occurs:
+
1. if you push a commit for code review to a branch for which you
don't have upload permissions (access right '+2 Upload permission'
in the link:access-control.html#category_READ['Read Access'] category)
diff --git a/Documentation/error-upload-denied.txt b/Documentation/error-upload-denied.txt
index 0d8fb99..947280f 100644
--- a/Documentation/error-upload-denied.txt
+++ b/Documentation/error-upload-denied.txt
@@ -1,16 +1,17 @@
-Upload denied for project '...'
-===============================
+Upload denied for project \'...'
+=================================
With this error message Gerrit rejects to push a commit if the
pushing user has no upload permissions for the project to which the
push was done.
There are two possibilities how to continue in this situation:
-1. contact one of the project owners and request upload permissions
- for the project (access right '+2 Upload permission' in the
- link:access-control.html#category_READ['Read Access'] category)
-2. export your commit as a patch using the link:http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html[git format-patch] command
- and provide the patch file to one of the project owners
+
+. contact one of the project owners and request upload permissions
+ for the project (access right '+2 Upload permission' in the
+ link:access-control.html#category_READ['Read Access'] category)
+. export your commit as a patch using the link:http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html[git format-patch] command
+ and provide the patch file to one of the project owners
GERRIT
diff --git a/Documentation/error-you-are-not-committer.txt b/Documentation/error-you-are-not-committer.txt
index 0c51fff..26e0cae 100644
--- a/Documentation/error-you-are-not-committer.txt
+++ b/Documentation/error-you-are-not-committer.txt
@@ -9,10 +9,11 @@
Identity' in the link:access-control.html#category_FORG['Forge Identity'] category.
This error may happen for two reasons:
-1. incorrect configuration of the e-mail address on client or server
- side
-2. missing privileges to push commits that were committed by other
- users
+
+. incorrect configuration of the e-mail address on client or server
+ side
+. missing privileges to push commits that were committed by other
+ users
Incorrect configuration of the e-mail address on client or server side
