Git and remote repositiories (fetching new code templates)¶

Setting a remote repository in command line¶

Open command line and move to your local repository. Execute the following command:

git remote add <shortname> <url>

where <shortname> is a short, descriptive name for the new remote repository and <url> is the address of if. For example:

git remote add course https://course-gitlab.tuni.fi/compcs110-spring2024/student_template_project.git

To test how the above command succeeded, write:

git remote –v

You can see a list of all remote repositories, for example:

course https://course-gitlab.tuni.fi/compcs110-spring2024/student_template_project.git (fetch)
course https://course-gitlab.tuni.fi/compcs110-spring2024/student_template_project.git (push)
origin https://course-gitlab.tuni.fi/compcs110-spring2024/user_id.git (fetch)
origin https://course-gitlab.tuni.fi/compcs110-spring2024/user_id.git (push)

If everything goes well, you need to do the above kind of remote addition only once during the course.

Retrieving new materials from the remote repository in command line¶

After setting a remote repository, you can retrieve updates from it to your local repository by writing:

git pull <remote> <branch>

where <remote> is the name of the remote repository that you gave above, and <branch> is the branch of the remote repository, from which you want to retrieve the updates.

Note that the above command starts a text editor set for Git (vi by default). In the text editor, you will write a merge message describing why you have merged. This happens in the same way as writing commit messages, which we have learned earlier. (If you happen to end up in vi editor, you can exit from there by writing ”:wq”.)

For example, the command described above can be executed as:

git pull course main

We have not considered Git branches in this course, they are mainly material of the next programming course. The only branch so far is main.

The above action is needed whenever course staff has delivered new material in student_template_project, typically at the beginning of each round.

Alternatively (if you do not want to write a merge message in an editor) you can, instead of pull, do the same action in two phases as:

git fetch <remote> <branch>
git merge <remote>/<branch> -m "Write a message here"

From above, you can conclude that git pull is actually the same as git fetch + git merge.

Setting a remote repository in Qt Creator¶

In Qt Creator, open a project stored in version control to make the necessary menu available. In the menu of Qt Creator, choose the action Tools > Git > Remote Repository > Manage Remotes...:

As URL, you should have https://course-gitlab.tuni.fi/compcs110-spring2024/xyz.git or git@course-gitlab.tuni.fi:compcs110-spring2024/xyz.git, where in the place of xyz you have your user id.

Click ”Add…”, and in the opening dialog at ”Name”, write a short, descriptive name to the new remote (e.g. course or in Finnish kurssi). At ”URL”, write the address mentioned at the very beginning of this material section. After that you can see the new remote repository in the list:

If everything goes well, you need to do the above kind of remote addition only once during the course.

Retrieving new materials from the remote repository in Qt Creator¶

After adding the remote repository in the list, choose it by clicking the mouse. After that, when clicking ”Fetch”, the updates will be retrieved from the remote repository to your local one. In the case of student_template_project, these updates mean the material of a new round. However, the updates cannot yet be seen the structure of the directory. Click ”Close”.

In Qt Creator menu, choose next action Tools > Git > Local Repository > Branches...:

From the list, choose branch main, just below the newly added remote repository (the line with main (master in figure), but do not confuse it with another main line). Click ”Merge” (if this takes you to a menu, choose ”Fast Forward”). If your repository is in a state, in which it should be, you should now see the updates in the structure of the directory. In this case, you should see new rounds in the directory templates.

If you have, for example, changed the content of the directory templates, it is possible that the above operation does not succeed. In such a case, contact course personnel.

The above action is needed whenever course staff has delivered new material in student_template_project, typically at the beginning of each round.