版本控制
版本控制系统或VCS(Git, SVN, Perforce, Mercurial, Bazaar, CVS, TFS 等)用于管理代码和数据的更改,并使团队能够协调他们的开发工作。 要使更改的跟踪变得高效并减少所需的磁盘空间量,您应该知道VCS必须跟踪哪些文件,哪些文件可以忽略。
UNIGINE具有VCSIntegration插件,旨在简化版本控制系统(SVN,Git)的工作,并跟踪在UNIGINE编辑器中执行的所有文件更改。
忽略列表#
在任何项目中,都有不受版本控制的文件和文件夹。 这些文件可以是由编译器创建的文件、*.obj、*.tlog或用于存储二进制可执行文件的输出文件夹。
项目根目录中的以下文件和文件夹可以忽略,因为它们是在磁盘上自动生成的:
每个API和IDE的通用忽略列表#
- .thumbnails
- bin
在更新引擎版本或在 SDK 浏览器中重新配置项目之前,将此文件夹添加到版本控制中,以便向所有开发人员提供更新的 bin。
- data/.thumbnails
- data/microprofile_dump_html
- junk
- obj
- source/x64
- CMakeCache.txt
- source/**/*.obj
- unigine_editor.cfg
- *.cache
- *.modified
- *.tlog
.thumbnails
bin
data/.thumbnails
data/microprofile_dump_html
junk
obj
source/x64
CMakeCache.txt
source/**/*.obj
unigine_editor.cfg
*.cache
*.modified
*.tlog
C++(CMake)项目的附加忽略列表#
在基于 C++ (CMake) 开发项目时,将这些条目添加到上面指定的通用 .gitignore中。
- build-*
- CMakeFiles
- CMakeScripts
- CMakeCache.txt
- cmake_install.cmake
- CMakeUserPresets.json
- compile_commands.json
- CTestTestfile.cmake
build-*
CMakeFiles
CMakeScripts
CMakeCache.txt
cmake_install.cmake
CMakeUserPresets.json
compile_commands.json
CTestTestfile.cmake
C++(Visual Studio2015+)项目的附加忽略列表#
在开发基于 C++ (Visual Studio2015+) 的项目时,将这些条目添加到上面指定的通用 .gitignore 中。
- .vs
- *.vcxproj.user
- *.VC.db
- *.opendb
- *.opensdf
- *.pro.user
- *.sdf
- *.suo
.vs
*.vcxproj.user
*.VC.db
*.opendb
*.opensdf
*.pro.user
*.sdf
*.suo
要添加到版本控制的文件和文件夹#
以下文件和文件夹应受版本控制:
data文件夹及其所有内容
如果您不想与其他团队成员共享编辑器和应用程序设置,请将以下配置文件添加到 .gitignore:
- data/configs/unigine.user
- data/configs/default.user
- data/.editor2/*
此文件夹还包含应提交的运行时文件(data/.runtimes)。 但是,如果您偶尔未能提交运行时,运行时验证过程将在UNIGINE编辑器启动时运行,并且添加或更新所有丢失或过时的运行时。 运行时验证也会在添加新挂载时执行。
-
source 文件夹内容除了上面提到的元素
此文件夹仅为使用C++或C#API的项目创建。 -
包含编译着色器缓存的*.cache 文件
当团队成员为其计算机配置使用不同的Gpu或/和驱动程序版本开发项目时,最好将着色器缓存文件添加到 .gitignore,因为这些文件将由最终开发人员的计算机重新编译。 - *.project 文件(和C#项目的 *.csproj)
其他通告#
本章包含基于用户体验的建议。
Perforce#
- 在 Perforce Workspace(Advanced 选项卡)中设置 Allwrite 属性。默认情况下,该属性处于禁用状态,这可能会导致 SDK 浏览器和 *.project 文件出现问题。
- 检出和锁定文件不会阻止其他用户修改它,因为这只是一个Perforce抽象。
最新更新:
2024-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)