Siddhesh Poyarekar has uploaded this change for review. ( https://gem5-review.googlesource.com/8323


Change subject: misc: Use the code format for commands and messages
......................................................................

misc: Use the code format for commands and messages

Make the style consistent across code blocks.  This also makes sure
that markdown does not try to read any of the code blocks and try to
do anything with it.

Change-Id: I8526933c8283ae02646d6273ed0cbd8e85176bd0
Signed-off-by: Siddhesh Poyarekar <siddhesh.poyare...@gmail.com>
---
M CONTRIBUTING.md
1 file changed, 30 insertions(+), 12 deletions(-)



diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index efb88c4..1513969 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -79,7 +79,9 @@
 https://gem5.googlesource.com/.

 To clone the master gem5 repository:
- > git clone https://gem5.googlesource.com/public/gem5
+```
+ git clone https://gem5.googlesource.com/public/gem5
+```

 Other gem5 repositories
 -----------------------
@@ -172,7 +174,9 @@
and resubmit. The following is a useful git command to update the most recent
 commit (HEAD).

- > git commit --amend
+```
+ git commit --amend
+```

 Posting a review
 ================
@@ -199,7 +203,9 @@
 Push change to gerrit review
 ----------------------------

- > git push origin HEAD:refs/for/master
+```
+ git push origin HEAD:refs/for/master
+```

Assuming origin is https://gem5.googlesource.com/public/gem5 and you want to push the changeset at HEAD, this will create a new review request on top of the
@@ -216,33 +222,43 @@
 --------------------------
 The first time you push a change you may get the following error:

- > remote: ERROR: [fb1366b] missing Change-Id in commit message footer
- > ...
+```
+ remote: ERROR: [fb1366b] missing Change-Id in commit message footer
+ ...
+```

Within the error message, there is a command line you should run. For every new clone of the git repo, you need to run the following command to automatically
 insert the change id in the the commit (all on one line).

- > curl -Lo $(git rev-parse --git-dir)/hooks/commit-msg
-   https://gerrit-review.googlesource.com/tools/hooks/commit-msg ; chmod +x
-   $(git rev-parse --git-dir)/hooks/commit-msg
+```
+ curl -Lo $(git rev-parse --git-dir)/hooks/commit-msg \
+       https://gerrit-review.googlesource.com/tools/hooks/commit-msg ; \
+ chmod +x $(git rev-parse --git-dir)/hooks/commit-msg
+```

 If you receive the above error, simply run this command and then amend your
 changeset.

- > git commit --amend
+```
+ git commit --amend
+```

 Push change to gerrit as a draft
 --------------------------------

- > git push origin HEAD:refs/drafts/master
+```
+ git push origin HEAD:refs/drafts/master
+```

 Push change bypassing gerrit
 -----------------------------

 Only maintainers can bypass gerrit review. This should very rarely be used.

- > git push origin HEAD:refs/heads/master
+```
+ git push origin HEAD:refs/heads/master
+```

 Other gerrit push options
 -------------------------
@@ -293,7 +309,9 @@
 can simply push the changeset again to the same Gerrit branch to update the
 review request.

- > git push origin HEAD:refs/for/master
+```
+ git push origin HEAD:refs/for/master
+```

Note: If you have posted a patch and don't receive any reviews, you may need to prod the reviewers. You can do this by adding a reply to your changeset review

--
To view, visit https://gem5-review.googlesource.com/8323
To unsubscribe, or for help writing mail filters, visit https://gem5-review.googlesource.com/settings

Gerrit-Project: public/gem5
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: I8526933c8283ae02646d6273ed0cbd8e85176bd0
Gerrit-Change-Number: 8323
Gerrit-PatchSet: 1
Gerrit-Owner: Siddhesh Poyarekar <siddhesh.poyare...@gmail.com>
_______________________________________________
gem5-dev mailing list
gem5-dev@gem5.org
http://m5sim.org/mailman/listinfo/gem5-dev

Reply via email to