0026212: There are some problems with location of text and images on pages
[occt.git] / dox / dev_guides / git_guide / git_guide.md
1 Guide to installing and using Git for OCCT development {#occt_dev_guides__git_guide}
2 =================================
3
4 @tableofcontents 
5
6 @section occt_gitguide_1 Overview
7
8 @subsection occt_gitguide_1_1 Purpose
9
10   The purpose of this document is to provide a practical introduction to Git 
11   to OCCT developers who are not familiar with this tool 
12   and to facilitate the use of the official OCCT Git repository for code contribution to OCCT.
13
14   Reading this document does not exempt from the need to learn Git concepts and tools. 
15   Please consult a book or manual describing Git to get acquainted with this tool. 
16   Many good books on Git can be found at http://git-scm.com/documentation 
17   
18   For the experienced Git users it can be enough to read sections 1 and 3
19    of this document to start working with the repository.
20    
21   Please make sure to get familiar with the Contribution Workflow document 
22   that describes how Git is used for processing contributions to OCCT.
23   
24   This and related documents are available at the Resources page 
25   of the OCCT development portal at http://dev.opencascade.org/index.php?q=home/resources. 
26
27 @subsection occt_gitguide_1_2 Git URL
28
29   URL of the official OCCT source code Git repository (accessed by SSH protocol) is:
30   
31       gitolite@git.dev.opencascade.org:occt
32   
33   or 
34   
35       ssh://gitolite@dev.opencascade.org/occt.git
36
37 @subsection occt_gitguide_1_3 Content
38
39 The official repository contains:
40
41   * The current certified version of OCCT: the "master" branch. This branch is updated by the Bugmaster only. Official OCCT releases are marked by tags.
42   * Topic branches created by contributors to submit changes for review / testing or for collaborative development.    The topic branches should be named by the pattern "CR12345" where 12345    is the ID of the relevant issue registered in Mantis (without leading zeroes),    and "CR" stands for "Change Request". The name can have an additional postfix used if more than    one branch was created for the same issue.
43   * Occasionally topic branches with non-standard names can be created by the Bugmaster for special needs.
44
45 @subsection occt_gitguide_1_4 Short rules of use
46
47   The name specified in the user.name field in Git configuration should correspond 
48   to your login name on the OCCT development portal. 
49   This is important to clearly identify the authorship of commits. 
50   (The full real name can be used as well; in this case add the login username in parentheses.)
51   
52   By default, contributors are allowed to push branches only with the names starting with CR 
53   (followed by the relevant Mantis issue ID). 
54   Possibility to work with other branches can be enabled by the Bugmaster on request.
55   
56   The branch is created by the developer in his local repository when the development of a contribution starts. 
57   The branch for new developments is to be created from the current master. 
58   The branch for integration of patches or developments based on an obsolete version 
59   is created from a relevant tag or commit. The branch should be pushed to the official repo 
60   only when sharing with other people (for collaborative work or review / testing) is needed. 
61   
62   Rebasing the local branch to the current master is encouraged before the first submission 
63   to the official repository. If rebasing was needed after the branch is pushed to the official repo, 
64   the rebased branch should have a different name (use suffix).
65   
66   Integration of contributions that have passed certification testing is made exclusively by the Bugmaster. 
67   Normally this is made by rebasing the contribution branch on the current master 
68   and squashing it into a single commit. This is made to have the master branch history plain and clean, 
69   following the general rule “one issue – one commit”. 
70   The description of the commit integrated to the master branch is taken from the Mantis issue 
71   (ID, 'Summary', followed by the information from 'Documentation' field if present).
72   
73   In special cases when it is important to save the  commits history in the branch 
74   (e.g. in case of  a long-term development integration) it can be integrated by merge (no fast-forward).
75   
76   The authorship of the contribution is respected by preserving the Author field of the commit when integrating.
77   Branches are removed from the official repository when integrated to the master. 
78   The Bugmaster can also remove branches which have no commits during one-month period.
79   
80   The Bugmaster may ask the developer (normally the one who produced the contribution) 
81   to rebase a branch on the current master, in the case if merge conflicts appear during integration.
82
83 @subsection occt_gitguide_1_5 Version of Git
84
85   The repository is tested to work with Git 1.7.6 to 1.7.9. 
86   Please do not use versions below 1.7.1 as they are known to cause troubles.
87
88 @section occt_gitguide_2 Installing Tools for Work with Git
89
90 @subsection occt_gitguide_2_1 Windows platform
91
92   Installation of Git for Windows (provided by MSysGit project) is required. 
93   
94   In addition, it is recommended to install TortoiseGit to work with Git on Windows. 
95   If you do not install TortoiseGit or any other GUI tool, 
96   you can use GitGui and Gitk GUI tools delivered with Git and available on all platforms.
97
98 @subsubsection occt_gitguide_2_1_1 Installation of Git for Windows
99
100   Download Git for Windows distributive from https://git-for-windows.github.io/
101   During the installation:
102
103   * Check-in "Windows Explorer integration" options:
104     * "Git Bash Here";
105     * "Git GUI Here".
106   * To avoid a mess in your PATH, we recommend selecting "Run Git from Windows Prompt" in the environment settings dialog: 
107   * In "Configuring the line ending conversions" dialog, select "Checkout Windows-style, commit Unix style endings".
108  
109   Note that by default Git user interface is localized to the system default language. 
110   If you prefer to work with the English interface, remove or rename .msg localization file 
111   in subdirectories *share/git-gui/lib/msgs* and *share/gitk/lib/msgs* of the Git installation directory.
112   
113   Before the first commit to the OCCT repository, make sure that your User Name in the Git configuration file (file <i>.gitconfig</i> in the <i>$HOME</i> directory) is equal to your username on the OCCT development portal. 
114
115 @subsubsection occt_gitguide_2_1_2 Installation and configuration of TortoiseGit
116
117   Download TortoiseGit distributive from http://code.google.com/p/tortoisegit/downloads/list. 
118   Launch the installation.
119
120  * Select your SSH client. Choose option 
121           * "OpenSSH, Git default SSH Client" if you prefer to use command-line tools for SSH keys generation, or
122           * "TortoisePLink, coming from Putty, integrates with Windows better" if you prefer to use GUI tool (PuttyGen, see 3.2).
123  * Complete the installation.
124   
125   TortoiseGit integrates into Windows Explorer, thus it is possible to use context menu in Windows Explorer to access its functionality:  
126   
127 @image html OCCT_GitGuide_V2_image005.png
128 @image latex OCCT_GitGuide_V2_image005.png
129   
130
131  
132   Note that if you have installed MSysGit or have Git installed in non-default path, 
133   on the first time you use TortoiseGit you may get the message demanding to define path to Git. 
134   In such case, click on **Set MSysGit path** button and add the path to git.exe 
135   and path to MigGW libraries in the Settings dialog.
136
137   * After the installation  select Start -> Programs -> TortoiseGit Settings to configure TortoiseGit.
138   
139   Select Git->Config to add your user name and Email address to the local <i>.gitconfig</i> file
140   
141   @image html OCCT_GitGuide_V2_image006.png
142   @image latex OCCT_GitGuide_V2_image006.png
143
144 @subsection occt_gitguide_2_2 Linux platform
145
146   We assume that Linux users have Git already installed and available in the *PATH*.
147   
148   Make sure to configure Git so that the user name is equal to your username 
149   on the OCCT development portal, and set SafeCrLf option to true:
150
151 ~~~~~
152     > git config --global user.name "Your User Name"
153     > git config --global user.email your@mail.address
154     > git config --global your@mail.address
155 ~~~~~
156
157 @section occt_gitguide_3 Getting access to the repository
158
159 @subsection occt_gitguide_3_1 Prerequisites
160
161   Access to the repository is granted to the users who have signed the Contributor License Agreement.
162   
163   The repository is accessed by SSH protocol, thus you need to register your public SSH key 
164   on the development portal to get access to the repository.
165   
166   SSH keys are used for secure authentication of the user when accessing the Git server. 
167   Private key is the one stored on the user workstation (optionally encrypted). 
168   Open (or public) key is stored in the user account page on the web site. 
169   When Git client accesses the remote repository through SSH, 
170   it uses this key pair to identify the user and acquire relevant access rights.
171   
172   Normally when you have Git installed, you should have also SSH client available. 
173   On Unix/Linux it is installed by default in the system. 
174   On Windows it is typical to have several SSH clients installed; 
175   in particular they are included with Cygwin, Git, TortoiseGit.
176   
177   It is highly recommended to use the tools that come 
178   with the chosen Git client for generation of SSH keys. 
179   Using incompatible tools (e.g. *ssh-keygen.exe* from Cygwin for code generation, 
180   and TortoiseGit GUI with a default Putty client for connection to server) 
181   may lead to authentication problems.
182
183 @subsection occt_gitguide_3_2 How to generate a key
184
185 @subsubsection occt_gitguide_3_2_1 Generating key with Putty
186
187   Use this option if you have installed TortoiseGit (or other GUI Git client on Windows) 
188   and have chosen “TortoisePLink” (or other Putty client) as SSH client during installation.
189   
190   To generate the key with this client, run **Puttygen** (e.g. from Start menu -> TortoiseGit -> Puttygen), 
191   then click **Generate** and move mouse cursor over the blank area until the key is generated. 
192   
193 @image html OCCT_GitGuide_V2_image007.png "Putty key generator"
194 @image latex OCCT_GitGuide_V2_image007.png "Putty key generator"
195
196   After the key is generated, you will see GUI controls to define the public key comment 
197   and / or specify the password for the private key protection. 
198   When done, save both the public and the private key to the files of your choice 
199   (make sure to store your private key in a secure place!).
200   
201   Copy the public key as shown by Puttygen to the clipboard to add it in your account. 
202   Do not copy the Putty public key file content -- it is formatted in a way not suitable for the web site.
203
204 @subsubsection occt_gitguide_3_2_2 Generating key with command-line tools
205
206   Use this option if you work on Linux or if you have chosen “OpenSSH” as SSH client 
207   during installation of TortoiseGit (or other Windows tool).
208   
209   Make sure that you have *ssh* and *ssh-keygen* commands in the path. 
210   On Windows, you might need to start **Git Bash** command prompt window.
211   
212   Use the following command to generate SSH keys:
213 ~~~~~  
214     > ssh-keygen -t rsa -C "your@mail.address"
215 ~~~~~  
216
217   The last argument is an optional comment, which can be included with the public key and used to distinguish between different keys (if you have many).  The common practice is to put here your mail address or workstation name.
218   
219   The command will ask you where to store the keys. It is recommended to accept the default path <i>$HOME/.ssh/id_rsa</i>. Just press **Enter** for that. You will be warned if a key is already present in the specified file; you can either overwrite it by the new one, or stop generation and use the old key.
220     
221   If you want to be on the safe side, enter password to encrypt the private key. You will be asked to enter this password each time you use that key (e.g. access a remote Git repository), unless you use the tool that caches the key (like TortoiseGit). If you do not want to bother, enter an empty string.  
222   
223   On Windows, make sure to note the complete path to the generated files (the location of your $HOME might be not obvious). Two key files will be created in the specified location (by default in $HOME/.ssh/):
224   
225   * *id_rsa* - private key
226   * *id_rsa.pub* - public key
227   
228   The content of the public key file (one text line) is the key to be added to the user account on the site (see below).
229
230 @subsubsection occt_gitguide_3_2_3 Generating key with Git GUI
231
232   GitGUI (standard GUI interface included with Git) provides the option 
233   to either generate the SSH key (if not present yet) or show the existing one. 
234   Click Help/Show SSH key and copy the public key content for adding to the user account page (see below).
235
236 @subsection occt_gitguide_3_3 Adding public key in your account
237
238 Log in on the portal http://dev.opencascade.org and click on **My account** link to the right. If you have a Contributor status, you will see **SSH keys** tab to the right. 
239
240 Click on that tab, then click **Add a public key**, and paste the text of the public key (see above sections on how to generate the key) into the text box. 
241
242 Click **Save** to input the key to the system. 
243
244   Note that a user can have several SSH keys. 
245   You can distinguish between these keys by the Title field ID; by default it is taken from SSH key comment. 
246   It is typical to use your e-mail address or workstation name for this field; no restrictions are set by the portal.
247
248
249   Please note that some time (5-10 min) is needed for the system 
250   to update the configuration after the new key is added. 
251   After that time, you can try accessing Git.
252
253 @section occt_gitguide_4 Work with repository: developer operations
254
255 @subsection occt_gitguide_4_1 General workflow
256
257   To start working with OCCT source repository, you need to create its clone in your local system. 
258   This cloned repository will manage your working copy of the sources 
259   and provide you the means to exchange code between your clone and the origin. 
260   
261   In most cases it is sufficient to have one clone of the repository; 
262   your working copy will be updated automatically by Git when you switch branches.
263   
264   The typical development cycle for an issue is as follows:
265
266   * Create a new branch for your development, basing on the selected version of the sources 
267    (usually the current master) and switch your working copy to it
268   * Develop and test your change. Note that for the first time, and after any changes 
269    made in CDL files you will have to re-generate build scripts or Visual Studio projects using WOK. 
270   * Do as many commits in your branch as you feel convenient; 
271    the general recommendation is to commit every stable state (even incomplete), to record the history of your development.
272   * Push your branch to the repository when your development is complete or when you need to share it with other people (e.g. for review)
273   * Before the first push, rebase your local branch on the latest master; 
274    consider collapsing the history in one commit unless you think the history of your commits is interesting for others. 
275    Make sure to provide a good commit message.
276   * Do not amend the commits that have been already pushed in the remote repository, 
277    If you need to rebase your branch, commit the rebased branch under a different name, and remove the old branch.
278   
279   You can switch to another branch at any moment 
280   (unless you have some uncommitted changes in the working copy) 
281   and return back to the branch when necessary (e.g. to take into account review remarks). 
282   Note that only the sources that are different between the switched branches will be modified, 
283   thus required recompilation should be reasonably small in most cases.
284
285 @subsection occt_gitguide_4_2 Cloning official repository
286
287   Clone the official OCCT repository in one of following ways:
288
289   * From command line by command: 
290
291 ~~~~~  
292     > git clone gitolite@git.dev.opencascade.org:occt <path>
293 ~~~~~
294
295   where <i>\<path\></i> is the path to the new folder which will be created for the repository.
296     
297   * In TortoiseGit: create a new folder, open it and right-click in the Explorer window, then choose **Git Clone** in the context menu:
298  
299 @image html OCCT_GitGuide_V2_image009.png
300 @image latex OCCT_GitGuide_V2_image009.png
301
302   If you have chosen Putty as SSH client during TortoiseGit installation, check the **Load Putty Key** option and specify the location of the private key file saved by PuttyGen (see 3.2.1). This shall be done for the first time only.   
303   
304   Note that on the first connection to the repository server you may be requested to enter a password for your private SSH key; further you can get a message that the authenticity of the host cannot be established and will be asked if you want to continue connecting or not. Choose **Yes** to continue. The host’s key will be stored in <i>$HOME/.ssh/known_hosts</i> file.
305
306 @subsection occt_gitguide_4_3 Branch creation
307
308   You need to create a branch when you are going to start development of a new change, 
309   apply a patch, etc. It is recommended to fetch updates from the remote repository 
310   before this operation, to make sure you work with the up-to-date version.
311   
312   Create a branch from the current master branch unless you need to base your development on a particular version or revision. 
313
314 In the console:
315
316 ~~~~~
317     > git checkout -b CR12345 origin/master
318 ~~~~~
319   
320 In TortoiseGit: 
321   * Go to the local copy of the repository. 
322   * Right-click in the Explorer window, then choose **Git Create Branch**.
323   * Select **Base On** Branch *remotes/origin/master*.  
324
325 @image html OCCT_GitGuide_V2_image012.png
326 @image latex OCCT_GitGuide_V2_image012.png
327
328   Check option **Switch to new branch** if you are going to start working with the newly created branch immediately.
329
330 @subsection occt_gitguide_4_4 Branch switching
331
332   If you need to switch to another branch, use Git command checkout for that.
333   In the console:
334
335 ~~~~~
336     > git checkout CR12345
337 ~~~~~
338   
339   In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Switch/Checkout**.
340  
341 @image html OCCT_GitGuide_V2_image013.png
342 @image latex OCCT_GitGuide_V2_image013.png
343
344   Note that in order to work with the branch locally you need to set option 
345   **Create new branch** when you checkout the branch from the remote repository for the first time. 
346   Option **Track** stores association between the local branch and the original branch in a remote repository.
347
348 @subsection occt_gitguide_4_5 Committing branch changes
349
350   Commit your changes locally as soon as a stable status of the work is reached. 
351   Make sure to review carefully the committed changes beforehand to avoid unintentional commit of a wrong code. 
352   
353   * In the console:
354   
355 ~~~~~
356     > git diff
357     …
358     > git commit -a -m "Write meaningful commit message here"
359 ~~~~~
360
361   Option –a tells the command to automatically include (stage) files 
362   that have been modified or deleted, but it will omit the new files that might have been added by you. 
363   To commit such new files, you must add (stage) them before commit command.
364
365   To find new unstaged files and them to commit, use commands:
366
367 ~~~~~
368     > git status -s
369       ?? file1.hxx 
370       ?? file2.cxx
371     > git add file1.hxx file2.cxx
372 ~~~~~
373
374   * In TortoiseGit: right-click in the explorer window and select in the context menu <b>Git Commit -> CR…</b>:
375  
376 @image html OCCT_GitGuide_V2_image014.png
377 @image latex OCCT_GitGuide_V2_image014.png
378
379   Unstaged files will be shown if you check the option ‘Show Unversioned Files’. 
380   Double-click on each modified file to see the changes to be committed (as a difference vs. the base version). 
381
382 @subsection occt_gitguide_4_6 Pushing branch to the remote repository
383
384   When the code developed in your local branch is ready for review, 
385   or you need to share it with others, push your local changes to the remote repository.
386   
387   * In the console:
388
389 ~~~~~  
390     > git push "origin" CR12345:CR12345
391 ~~~~~
392
393   * In TortoiseGit: right-click in the explorer window and select in the context menu, TortoiseGit -> **Push**
394
395 @image html OCCT_GitGuide_V2_image015.png
396 @image latex OCCT_GitGuide_V2_image015.png
397
398 Note that Git forbids pushing a branch if the corresponding remote branch already exists and has some changes, which are not in the history of your local branch. This may happen in different situations:
399   * You have amended the last commit which is already in the remote repository. If you are sure that nobody else uses your branch, push again with **Force** option. 
400   * You have rebased your branch, so that now it is completely different from the branch in the remote repository. In this case, push it under a different name (add a suffix): 
401  
402 @image html OCCT_GitGuide_V2_image016.png
403 @image latex OCCT_GitGuide_V2_image016.png
404
405   Then remove the original remote branch so that other people recognize that it has been replaced by the new one. For that, select TortoiseGit -> **Push** again, select an empty line for your local branch name, 
406   and enter the name of the branch to be removed in **Remote** field:
407
408   * The other developer has committed some changes in the remote branch. In this case, **Pull** changes from the remote repository to have them merged with your version, and push your branch after it is successfully merged.
409
410 @subsection occt_gitguide_4_7 Synchronizing with remote repository
411
412   Maintain your repository synchronized with the remote one and clean unnecessary stuff regularly.
413   
414   Use Git command *fetch* with option *prune* to get the update of all branches from the remote repository and to clean your local repository from the remote branches that have been deleted.
415   
416   * In the console:
417 ~~~~~  
418     > git fetch --prune 
419 ~~~~~
420     
421   * In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Fetch**. Check in **Prune** check-box.  
422   
423 @image html OCCT_GitGuide_V2_image018.png
424 @image latex OCCT_GitGuide_V2_image018.png
425
426   If the branch you are working with has been changed in the remote repository,  use Git command *pull* to get the remote changes and merge them with your local branch. 
427   
428   This operation is required in particular to update your local master branch when the remote master changes.
429   
430   * In console:
431 ~~~~~  
432     > git pull
433 ~~~~~    
434
435   * In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Pull**.
436
437 @image html OCCT_GitGuide_V2_image019.png
438 @image latex OCCT_GitGuide_V2_image019.png
439
440 Note that the local branches of your repository are the primary place, where your changes are stored until they get integrated to the official version of OCCT (master branch). The branches submitted to official repository are for collaborative work, review, and integration - that repository should not be used for long-term storage of incomplete changes. 
441   
442 Remove the local branches that you do not need any more. Note that you cannot delete the current branch. It means that you need to switch to another one (e.g. master) if the branch you are going to delete is the current one.
443   
444   * In the console:
445 ~~~~~ 
446     > git branch -d CR12345
447 ~~~~~
448     
449   * In TortoiseGit: right-click in the explorer window and select in the context menu **TortoiseGit** -> **Git Show Log**.
450
451 @image html OCCT_GitGuide_V2_image020.png
452 @image latex OCCT_GitGuide_V2_image020.png
453
454   Select **All branches** check-box to view all branches.
455   Right-click on the branch you want to delete and select **Delete** item in the context menu. 
456  
457 Note that many functions described above can be accessed from the Log View, which is a very convenient tool to visualize and manage branches.
458
459 @subsection occt_gitguide_4_8 Applying a fix made on older version of OCCT
460
461 If you have a fix made on a previous version of OCCT, perform the following sequence of operations to prepare it  for testing and integration to the current development version:
462   * Identify the version of OCCT on which the fix has been made. In most cases, this will be an OCCT release, e.g. OCCT 6.7.0. 
463   * Find a tag or a commit corresponding to this version in the Git history log of the master branch.
464   * Create a branch basing on this tag or commit. In TortoiseGit history log: right-click on the base commit, then select **Create branch at this version**.
465   
466 @image html OCCT_GitGuide_V2_image021.png
467 @image latex OCCT_GitGuide_V2_image021.png
468
469   * Check option **Switch to the new branch** to start working within the new branch immediately, or switch to it separately afterwards.
470   * Put your fix in the working copy, build and check that it works, then commit to the branch.
471   * Rebase the branch on the current master. In TortoiseGit: right-click on the working directory, choose **TortoiseGit** -> **Rebase**, select *remotes/origin/master* as UpStream revision, and click **Start**:
472  
473 @image html OCCT_GitGuide_V2_image022.png
474 @image latex OCCT_GitGuide_V2_image022.png
475
476 Note that you can get some conflicts during rebase. To resolve them, double-click on each conflicted file   (highlighted by red in the file list) to open visual merge tool.   Switch between conflicting fragments by red arrows, and for each one decide if the code of one or both conflicting versions is to be taken.
477
478 @subsection occt_gitguide_4_9 Rebasing with history clean-up
479
480 At some moments you might need to rebase your branch on the latest version of the master. 
481   
482 We recommend rebasing before the first submission of the branch for review or when the master has diverged substantially from your branch. 
483   
484 Rebasing is a good occasion to clean-up the history of commits in the branch. Consider collapsing (squashing, in terms of Git) the history of your branch into a single commit unless you deem that having separate commits is important for your future work with the branch or its code reviewing. Git also allows changing the order of commits, edit commit contents and messages, etc. 
485   
486 To rebase your branch into a single commit, you need to do the following:
487   * Switch to your branch (e.g. “CR12345”)
488   * In TortoiseGit history log, select a branch to rebase on <i>(remotes/origin/master)</i> and in the context menu choose **Rebase “CR12345” onto this**.
489   * In the **Rebase** dialog, check **Squash All**.  You can also change the order of commits and define for each commit whether it should be kept (**Pick**), edited, or just skipped.
490   
491 @image html OCCT_GitGuide_V2_image023.png
492 @image latex OCCT_GitGuide_V2_image023.png
493
494   * Click **Start**.
495   * The process will stop if a conflict is detected. In that case, find files with status **Conflicted** in the list (marked by red), and double-click on them to resolve the conflict. When all conflicts are resolved, click **Continue**.
496    
497 @image html OCCT_GitGuide_V2_image024.png
498 @image latex OCCT_GitGuide_V2_image024.png
499  
500   * At the end of the process, edit the final commit message (it should start from the issue ID and  a description from Mantis in the first line, followed by a summary of actual changes), and click **Commit**.
501    
502 @image html OCCT_GitGuide_V2_image025.png
503 @image latex OCCT_GitGuide_V2_image025.png
504
505 @section occt_gitguide_5 Work with repository: Reviewer operations
506
507 @subsection occt_gitguide_5_1 Review branch changes using GitWeb
508
509   The changes made in the branch can be reviewed without direct access to Git, using GitWeb interface:
510
511   * Open GitWeb in your web browser: http://git.dev.opencascade.org/gitweb/?p=occt.git 
512   * Locate the branch you want to review among **heads** (click ‘…’ at the bottom of the page to see the full list).
513   * Click **log** (or **shortlog**) to see the history of the branch. 
514     
515   **Note** that the branch can contain more than one commit, and you need to distinguish commits that belong to that branch (those to be reviewed) from the commits corresponding to the previous state of the master branch. Normally the first commit in the list that starts from the ID of the other issue indicates the branching point; commits above it are the ones to be reviewed.
516   
517   * Click **commitdiff** on each log entry to review the changes (highlighted with color format).
518
519 @subsection occt_gitguide_5_2 Review branch changes with TortoiseGit 
520
521   Use of TortoiseGit is recommended for convenient code review:
522
523   * Fetch the changes from the remote repository as described in <a href="#occt_gitguide_4_7">Synchronizing with remote repository</a> section.   
524   * Right-click on the repository, choose **TortoiseGit** -> **Show** log;
525   * Locate the remote branch you need to review;
526   * To review commits one-by-one, select each commit in the log. The list of changed files is shown at the bottom of the window; double-click on the file will open visual compare tool.
527   * To review all changes made in the branch at once, or to compare two arbitrary revisions, select the corresponding commits in the log (e.g. the last commit in the branch and the branching point), ight-click for the context menu, and choose **Compare revisions**.
528
529 @image html OCCT_GitGuide_V2_image026.png
530 @image latex OCCT_GitGuide_V2_image026.png
531