diff options
Diffstat (limited to 'docs/07_How_To_Contribute')
4 files changed, 18 insertions, 18 deletions
diff --git a/docs/07_How_To_Contribute/03_Working_with_Gerrit.md b/docs/07_How_To_Contribute/03_Working_with_Gerrit.md index ccd9133..3b083d4 100644 --- a/docs/07_How_To_Contribute/03_Working_with_Gerrit.md +++ b/docs/07_How_To_Contribute/03_Working_with_Gerrit.md @@ -103,7 +103,7 @@ repeat the ``git review`` command. ```sh $ cd documentation # Working Repository $ git remote -v update # Updating wrt remote - $ git checkout -b mytopicbranch origin/master # Creating new branch + $ git checkout -b mytopicbranch origin/octopus # Creating new branch ### CODE the CHANGES $ git add <file> # Track the changed files $ git commit -s # Signed Commit Message @@ -119,7 +119,7 @@ repeat the ``git review`` command. $ git add <file> # Track the changed files $ git commit -s # Signed Commit Message $ git review # Submit Changes to review - $ git checkout master # Return to master branch + $ git checkout octopus # Return to octopus branch ``` ## Reviewing Using Gerrit diff --git a/docs/07_How_To_Contribute/06_Gerrit_Recommended_Practices.md b/docs/07_How_To_Contribute/06_Gerrit_Recommended_Practices.md index 671c685..ef02acb 100644 --- a/docs/07_How_To_Contribute/06_Gerrit_Recommended_Practices.md +++ b/docs/07_How_To_Contribute/06_Gerrit_Recommended_Practices.md @@ -61,20 +61,20 @@ and help others ramp up. Topic branches are temporary branches that you push to commit a set of logically-grouped dependent commits: -To push changes from ``REMOTE/master`` tree to Gerrit for being reviewed as a +To push changes from ``REMOTE/octopus`` tree to Gerrit for being reviewed as a topic in **TopicName** use the following command as an example: ```sh -$ git push REMOTE HEAD:refs/for/master/TopicName +$ git push REMOTE HEAD:refs/for/octopus/TopicName ``` The topic will show up in the review ``UI`` and in the ``Open Changes List``. -Topic branches will disappear from the master tree when its content is merged. +Topic branches will disappear from the octopus tree when its content is merged. ## Finding Available Topics ```sh -$ ssh -p 29418 <LFID>@gerrit.automotivelinux.org gerrit query \ status:open branch:master| grep topic: | sort -u +$ ssh -p 29418 <LFID>@gerrit.automotivelinux.org gerrit query \ status:open branch:octopus| grep topic: | sort -u ``` - [gerrit.automotivelinux.org](https://gerrit.automotivelinux.org) is the @@ -159,13 +159,13 @@ list of commits, **c0...c7**, which were submitted as a topic branch: ```sh -$ git log REMOTE/master..master +$ git log REMOTE/octopus..octopus c0 ... c7 -$ git push REMOTE HEAD:refs/for/master/SOMETOPIC +$ git push REMOTE HEAD:refs/for/octopus/SOMETOPIC ``` After you get reviewers' feedback, there are changes in **c3** and **c4** that @@ -175,7 +175,7 @@ for more information. However, you must keep the same Change-Id and push the changes again: ```sh -$ git push REMOTE HEAD:refs/for/master/SOMETOPIC +$ git push REMOTE HEAD:refs/for/octopus/SOMETOPIC ``` This new push creates a patches revision, your local history is then cleared. @@ -193,18 +193,18 @@ you to make the necessary *Change-Ids*. The *Change-Ids* must be kept the same. - **reword:** changes the commit message. - **edit:** changes the commit content. - **reorder:** allows you to interchange the order of the commits. -- **rebase:** stacks the commits on top of the master. +- **rebase:** stacks the commits on top of the octopus. ## Rebasing During a Pull -Before pushing a rebase to your master, ensure that the history has a +Before pushing a rebase to your octopus, ensure that the history has a consecutive order. -For example, your ``REMOTE/master`` has the list of commits from **a0** to +For example, your ``REMOTE/octopus`` has the list of commits from **a0** to **a4**; Then, your changes **c0...c7** are on top of **a4**; thus: ```sh -$ git log --oneline REMOTE/master..master +$ git log --oneline REMOTE/octopus..octopus a0 a1 @@ -217,17 +217,17 @@ $ git log --oneline REMOTE/master..master c7 ``` -If ``REMOTE/master`` receives commits **a5**, **a6** and **a7**. Pull with a +If ``REMOTE/octopus`` receives commits **a5**, **a6** and **a7**. Pull with a rebase as follows: ```sh -$ git pull --rebase REMOTE master +$ git pull --rebase REMOTE octopus ``` This pulls **a5-a7** and re-apply **c0-c7** on top of them: ```sh -$ git log --oneline REMOTE/master..master +$ git log --oneline REMOTE/octopus..octopus a0 ... a7 diff --git a/docs/07_How_To_Contribute/08_Adding_Documentation.md b/docs/07_How_To_Contribute/08_Adding_Documentation.md index b879cc0..963a129 100644 --- a/docs/07_How_To_Contribute/08_Adding_Documentation.md +++ b/docs/07_How_To_Contribute/08_Adding_Documentation.md @@ -100,7 +100,7 @@ $ blc http://localhost:8000 -ro For testing hyperlinks of live website do: ```sh -$ blc https://docs.automotivelinux.org/en/master/ -ro +$ blc https://docs.automotivelinux.org/en/octopus/ -ro ``` The ```Broken Link Checker``` output will display the broken link and there location in diff --git a/docs/07_How_To_Contribute/09_Contribution_Checklist.md b/docs/07_How_To_Contribute/09_Contribution_Checklist.md index 89052e8..8de8f01 100644 --- a/docs/07_How_To_Contribute/09_Contribution_Checklist.md +++ b/docs/07_How_To_Contribute/09_Contribution_Checklist.md @@ -42,7 +42,7 @@ title: Contribution Checklist - [ ] Must have: a .gitreview file. - [ ] Option: Can have a .gitignore file. - [ ] Option: Can have a .editorconfig file. - - [ ] All code needs to build against master. + - [ ] All code needs to build against octopus. - [ ] Is a backport to a release branch required ? - [ ] Code contributions submitted need to have a Sign-off-by! (Follow [**DCO**](https://developercertificate.org/).) |