|Arch → Utilities → Git|
|Introduced in version|
This command allows to manage the current document with GIT. GIT is a powerful file version control system, which can manage different versions of files and keep track of the changes.
Git is a complex tool, consider learning the basics of it before using this tool, to avoid wrong operations that can cause data loss. An abundant literature about GIT is available and easy to find on the internet.
- The tool cannot create new repositories yet. You must have an existing local repository already created (FreeCAD will check if the current document file is inside a Git repository)
- The tool cannot change or create branches. You must do that manually with standard Git tools.
Note: To be able to use this command, the gitpython package must be installed on your system. On most linux distributions, gitpython is available from the standard software repositories as gitpython or python-git.
How to use
- Save the current active document
- Make sure the saved file is inside an existing git repository
- Select menu Arch → Utilities →
- Make sure the Report Window is open since Git messages will be printed there.
- The Git tool will only open if the current file is saved inside a Git repository. It can be in a subdirectory.
- The Log button will pop up a dialog showing the most recent log entries.
- The Refresh button will re-scan the repository for changed files.
- The Diff button will show the differences between the current version of a selected file and the previous version stored in the repository.
- The Select all button will select all files to be committed.
- The Commit button will commit the selected files. Be sure to write a commit message that describes the changes you are committing.
- The Pull button will download any new changes to the repository from the selected remote. If the file currently opened in FreeCAD is being modified by a pull, a warning message will inform you so you can either save the file again or save it elsewhere.
- The Push button will upload your latest commit(s) to the selected remote.
Enabling human-readable diff for FCStd files
FreeCAD's Fcstd file format is a zip-based binary format, for which Git cannot produce proper diffs. This means that you cannot see what has changed between one version and another, and also that each new version stored in the Git repository is a full copy of the file.
Although the second problem currently has no solution, the first one can be solved with a little tool available from the FreeCAD source code, called fcinfo. Git can be told to use the fcinfo utility to print a human-friendly report of a FCStd file, and, when asked to produce a diff between two FCStd files, will produce a diff between the two fcinfo reports instead. Please note that this is only visual feedback, a full copy of the file will still be stored internally.
Example of a diff produced with fcinfo:
diff --git a/testhouse.FcStd b/testhouse.FcStd index 08077b6..985b1d8 100644 --- a/testhouse.FcStd +++ b/testhouse.FcStd @@ -1,26 +1,25 @@ -Document: /tmp/43un09_testhouse.FcStd (442K) - SHA1: 67c1985a45d93cba57d5bf44490897aba460100d +Document: /tmp/zfXoDd_testhouse.FcStd (370K) + SHA1: db1cb5fca18af7bfdca849028f40550df4d845cb Comment : This is a test house to showcase FreeCAD's BIM worflow and IFC export capabilities Company : uncreated.net CreatedBy : Yorik van Havre CreationDate : Fri May 9 12:05:54 2014 FileVersion : 1 Id : - Label : testhouse - LastModifiedBy : Yorik van Havre - LastModifiedDate : 2016-06-28T17:05:57-03:00 + Label : testhouse2 + LastModifiedBy : Yorik van Havre + LastModifiedDate : Sat Sep 13 20:46:36 2014 + License : CC-BY 3.0 LicenseURL : http://creativecommons.org/licenses/by/3.0/ - ProgramVersion : 0.17R7800 (Git) - TipName : + ProgramVersion : 0.15R3989 (Git) Uid : 67e62d8a-6674-4358-92fe-615443be887a - Objects: (231) + Objects: (221) Annotation : Drawing::FeatureViewAnnotation Annotation001 : Drawing::FeatureViewAnnotation Annotation002 : Drawing::FeatureViewAnnotation Annotation003 : Drawing::FeatureViewAnnotation - Annotation004 : Drawing::FeatureViewAnnotation - Annotation005 : Drawing::FeatureViewAnnotation Array : Part::FeaturePython (9K) Box : Part::Box (2K) Building : App::DocumentObjectGroupPython @@ -110,7 +109,7 @@ Document: /tmp/43un09_testhouse.FcStd (442K) Floor : App::DocumentObjectGroupPython Floor001 : App::DocumentObjectGroupPython Floor002 : App::DocumentObjectGroupPython - Frame : Part::FeaturePython (89K)
Each FreeCAD file contains a SHA1 checksum number, which will change each time the file is saved, even if no contents was changed. So fcinfo will always print something, no matter of the contents changes.
To enable the use of fcinfo (Linux and Mac only - TODO: add Windows instructions)
- Save the fcinfo file somewhere in your system path
- Make it executalbe
- Create a .gitattributes file in your Git repository
- Add the following line in it: