Git How-To - Revision history

Athrasher7 at 01:50, 6 February 2020

2020-02-06T01:50:22Z

Joldenburg6: Text replacement - "Category:How-To Guides" to "Category:How to Guides"

2018-07-19T01:15:38Z

Text replacement - "Category:How-To Guides" to "Category:How to Guides"

Joldenburg6: Categorize

2018-06-14T03:02:52Z

Categorize

Joldenburg6: Joldenburg6 moved page GIT HOWTO to Git How-To without leaving a redirect

2018-06-14T03:02:39Z

Joldenburg6 moved page GIT HOWTO to Git How-To without leaving a redirect

Mbarulic: /* Public Key */

2013-12-02T02:51:49Z

‎Public Key

Mbarulic at 02:45, 2 December 2013

2013-12-02T02:45:09Z

Mbarulic: /* Changing Remote to the Server */

2013-12-02T02:36:25Z

‎Changing Remote to the Server

Mbarulic: /* Branching */

2013-10-07T17:03:04Z

‎Branching

Mbarulic at 17:00, 7 October 2013

2013-10-07T17:00:15Z

Mbarulic: /* Getting Code from the Server */

2013-09-13T16:38:48Z

‎Getting Code from the Server

← Older revision		Revision as of 01:50, 6 February 2020
Line 89:		Line 89:
	The branch you are currently on will be marked with an asterisk(*).		The branch you are currently on will be marked with an asterisk(*).

−	[[Category:How to Guides]]	+	[[Category:How to Guides: Technical]]

← Older revision		Revision as of 01:15, 19 July 2018
Line 89:		Line 89:
	The branch you are currently on will be marked with an asterisk(*).		The branch you are currently on will be marked with an asterisk(*).

−	[[Category:How~~-To~~ Guides]]	+	[[Category:How to Guides]]

← Older revision		Revision as of 03:02, 14 June 2018
Line 89:		Line 89:
	The branch you are currently on will be marked with an asterisk(*).		The branch you are currently on will be marked with an asterisk(*).

−	[[Category:How to Guides~~\|How_to_Guides~~]]	+	[[Category:How-To Guides]]

@@ Line 7: / Line 7: @@
 Before using Git, you have to get access to our repos. The software we use to manage Git access requires your "public key."
-To get access, follow the instructions in this link to generate the public key for your computer. [https://help.ubuntu.com/community/SSH/OpenSSH/Keys#Generating_RSA_Keys Generating A Public Key]
+To generate your public key:
-This process will produce a public key file (~/.ssh/id_rsa.pub) You should send or copy this email to the IGVC project manager, who will add it to the Git system and grant you appropriate permissions.
+#Create the .ssh directory
 == Getting Code from the Server ==

@@ Line 1: / Line 1: @@
-==Public Key==
+==Windows Users==
 Before using Git, you have to get access to our repos. The software we use to manage Git access requires your "public key."
-To get access, follow the instructions in this link to generate the public key for your computer.
+To get access, follow the instructions in this link to generate the public key for your computer. [https://help.ubuntu.com/community/SSH/OpenSSH/Keys#Generating_RSA_Keys Generating A Public Key]
-This process will produce a public key file (~/.ssh/id_rsa.pub)
+This process will produce a public key file (~/.ssh/id_rsa.pub) You should send or copy this email to the IGVC project manager, who will add it to the Git system and grant you appropriate permissions.
-==Getting Code from the Server==
+== Getting Code from the Server ==
-: Software
+Our code, electronics designs, design report, and data sheets are stored in Git repositories. To get access to these, you need to "clone" the correct repository to your machine.
 <pre>
-git clone git@robojackets.org:igvc/software.git igvc/software
+:Software
 </pre>
 :Electrical
-: Electrical
+<pre>git clone git@robojackets.org:igvc/electrical.git igvc/electrical
 </pre>
 :Documents
-: Documents
+<pre>git clone git@robojackets.org:igvc/docs.git igvc/docs
 </pre>
 If you got the code off of a flash drive, you will need to reset your local copy of the git repository to use the server instead. Go into your software folder and execute:
-<pre>
+<pre>git remote rm origin
 git remote add -t master -m master origin git@robojackets.org:igvc/software.git
 </pre>
-==Committing Local Changes==
+As you add changes and make something work, you should commit your changes to your local repository. This will allow you to manage changes by making use of git, if you want to go back. Once you have something working, execute the following command:
-As you add changes and make something work, you should commit your changes to your local repository.  This will allow you to manage changes by making use of git, if you want to go back.  Once you have something working, execute the following command:
+<pre>git commit -a
 </pre>
-'''You will add a meaningful commit message to say what you did.''' This is important so that other people can understand what you are doing.  After committing, you can check that you have committed things by running status:
+'''You will add a meaningful commit message to say what you did.''' This is important so that other people can understand what you are doing. After committing, you can check that you have committed things by running status:
-<pre>
+<pre>git status
 </pre>
-==Updating Your Local Repository==
+Because other people are making changes to the repository on the server, you will need to update your local repository from time to time to get these new changes. You should do this just before any commits to a server so that you don't break the build on the server.
-Because other people are making changes to the repository on the server, you will need to update your local repository from time to time to get these new changes.  You should do this just before any commits to a server so that you don't break the build on the server.
+<pre>git pull
 </pre>
 You may need to jump through some hoops to merge things properly if there are conflicts.
 You can set up an alias to automatically update multiple repositories. For example, if you have the software, electronics, documentation, and mechanical repositories inside a folder called robocup, you can add the following line to your .bashrc file located in your home folder.
-<pre>
+<pre>alias update_robocup='echo "Checking..."; cd /home/UserName/robocup/electrical; echo "Electrical: "; git pull; cd ../mechanical;
 echo "Mechanical: "; git pull; cd ../robocup_docs; echo "Documentation: "; git pull; cd ../software; echo "Software: "; git pull; cd ../; echo "Done!";'
 </pre>
-You'll probably have to edit that to work with the exact file structure you are using.
+== Committing Changes to the Server ==
 Once you think you have something that should go on the server, you should first check to make sure it works, because if your code breaks the build no one will like you any more and all of the cool kids won't invite you to cool things and everyone will point fingers at you when you walk around campus. Commit all of the changes to your local repository and then push:
-<pre>
+<pre>git push
 </pre>
 Branches allow us to keep separate instances of the code base for work on individual features. You will often create a branch of the code while you work on fixing a bug or adding a feature, then merge the changes from your branch to the "master" branch when you are done. Here is a summary of the branching workflow:
 *Create a new branch with this command. Our branch names follow the convention "usrname-taskname". This naming scheme allows us to quickly see who's working on what.
-<pre>
+<pre>git branch branchname
 </pre>
 *Write your code, and commit your changes.
@@ Line 75: / Line 67: @@
 **If you want to save yourself some trouble, commit and pull often.
 **This command needs to be run while you are on your feature branch for the changes to be merged into your feature branch.
-<pre>
+<pre>git pull origin master
 </pre>
 *Once you've fixed any merge conflicts and tested that the code works with all of the combined changes, checkout the master branch to merge the changes from your branch.
-<pre>
+<pre>git checkout master
 git merge branchname
 </pre>
 *Finally, push your merge to the remote server
-<pre>
+<pre>git push
 </pre>
-<br/>
+<br/>If you ever want to see all of the branches in the system, use the following command.
-If you ever want to see all of the branches in the system, use the following command.
+<pre>git branch -a
 </pre>
 The branch you are currently on will be marked with an asterisk(*).
 [[Category: How to Guides]]

← Older revision	Revision as of 03:02, 14 June 2018
(No difference)

@@ Line 9: / Line 9: @@
 ==Getting Code from the Server==
-Currently, the software team uses Git, so you will need to clone your team's repository to your machine as follows in the folder of your choice:
+Our code, electronics designs, design report, and data sheets are stored in Git repositories.
-: Robocup
+: Software
 <pre>
-git clone ssh://[username]@robojackets.org/git/robocup/software software
+git clone git@robojackets.org:igvc/software.git igvc/software
 </pre>
-: IGVC
 <pre>
-git clone ssh://[username]@robojackets.org/git/igvc igvc
+git clone git@robojackets.org:igvc/docs.git igvc/docs
 </pre>
 ==Changing Remote to the Server==