Управление версиями

Version Control Systems or VCS (Git, SVN, Perforce, Mercurial, Bazaar, CVS, TFS, etc.) are used to manage changes to code and data, and enable teams to coordinate their development efforts. To make tracking of changes efficient and reduce the amount of disk space required, you should know which files must be tracked by the VCS and which can be ignored.Системы контроля версий или VCS (Git, SVN, Perforce, Mercurial, Bazaar, CVS, TFS и т.д.) используются для управления изменениями в коде и данных и позволяют командам разработчиков координировать свою работу. Для эффективного отслеживания изменений и сокращения объема требуемого дискового пространства нужно знать, какие файлы должны отслеживаться VCS, а какие можно игнорировать.

Примечание

UNIGINE has VCSIntegration Plugin that is designed to simplify work with the version control system (SVN,Git) and track all file changes performed in UNIGINE Editor.В UNIGINE есть плагин VCSIntegration, который предназначен для упрощения работы с системой контроля версий (SVN,Git) и отслеживания всех изменений файлов, выполняемых в редакторе UNIGINE.

In any project there are files and folders that are not subject to version control. These can be files created by the compiler, *.obj, *.tlog, or an output folder used to store binary executables.В любом проекте есть файлы и папки, для которых не требуется контроль версий. Это могут быть файлы, созданные компилятором, *.obj, *.tlog или конечная папка, используемая для хранения двоичных исполняемых файлов.

The following files and folders in you project's root can be ignored, as they are generated automatically on your disk:Следующие файлы и папки в корневом каталоге вашего проекта можно игнорировать, поскольку они автоматически создаются на вашем диске:

Common ignore list for every API and IDE

Общий список игнорирования для любого API и IDE#

.thumbnails
bin
data/.thumbnails
data/microprofile_dump_html
junk
obj
source/x64
CMakeCache.txt
source/**/*.obj
unigine_editor.cfg
*.cache
*.modified
*.tlog

Additional ignore list for C++ (CMake) projects

Дополнительный список игнорирования для проектов на C++ (CMake)#

build-*
CMakeFiles
CMakeScripts
CMakeCache.txt
cmake_install.cmake
CMakeUserPresets.json
compile_commands.json
CTestTestfile.cmake

Additional ignore list for C++ (Visual Studio 2015+) projects

Дополнительный список игнорирования для проектов на C++ (Visual Studio 2015+)#

.vs
*.vcxproj.user
*.VC.db
*.opendb
*.opensdf
*.pro.user
*.sdf
*.suo

The following files and folders should be subject to version control:Следующие файлы и папки должны учитываться системой контроля версий:

• data folder with all its contentsпапка data со всем ее содержимым

  Примечание

  If you do not want to share the editor and application settings with other team members, add the following configuration files to .gitignore:Если вы не хотите делиться настройками редактора и приложения с другими членами команды, добавьте в .gitignore следующие файлы конфигурации:

  • data/configs/unigine.user
  • data/configs/default.user
  • data/.editor2/*

  This folder also contains runtime files (data/.runtimes) that should be committed. However, if you occasionally fail to commit runtimes, the runtimes validation process will run when UNIGINE Editor is started, and the missing/outdated runtimes are added/updated. The runtime validation is also performed on adding a new mount.В этой папке также содержатся файлы среды выполнения — рантаймы (data/.runtimes), которые нужно закоммитить. Однако, если вы случайно не закоммитили рантаймы, при запуске редактора UNIGINE будет запущен процесс проверки рантаймов, а отсутствующие/устаревшие рантаймы будут добавлены/обновлены. Валидация рантаймов также проводится при подключении новой точки монтирования.

• source folder contents except for the elements mentioned aboveсодержимое папки source, за исключением элементов, упомянутых выше

  Примечание

  This folder is created only for projects that use C++ or C# API.Эта папка создается только для проектов, использующих C++ или C# API.

• *.cache files containing compiled shader cacheфайлы *.cache, содержащие скомпилированный шейдерный кэш

  Примечание

  When team members develop a project using different GPUs or/and driver’s version for their machine configuration, it is better to add the shader cache files to .gitignore since these file will be recompiled by an end developer’s computer.Когда члены команды разрабатывают проект, используя разные графические процессоры или/и версию драйвера для своей конфигурации компьютера, лучше добавить файлы шейдерного кэша в .gitignore, поскольку эти файлы будут перекомпилированы компьютером конечного разработчика.
• *.project file (and *.csproj for C# projects)файл *.project (и *.csproj для проектов на C#)

This chapter contains recommendations based on the user experience.В этой главе содержатся рекомендации, основанные на пользовательском опыте.

Perforce

Perforce#