Iterate Documentation

.p4ignore

@@ -1,3 +1,11 @@
+###############################################################################
+###
+###  For help, see:
+###
+###      https://github.com/XistGG/Perforce-Setup
+###
+###############################################################################
+#
 # Here you can specify files to ignore when adding files to the depot.
 #
 # The syntax for P4IGNORE files is not the same as Perforce syntax.
@@ -23,7 +31,7 @@
 .p4config
 
 ###############################################################################
-###  This .p4config is for a SOURCE-ONLY UProject depot
+###  This .p4ignore is for a SOURCE-ONLY UProject depot
 ###############################################################################
 
 # This is a source-only Depot -- Ignore all Generated Binaries

README.md

@@ -3,19 +3,59 @@
 This repository contains sample files to help you set up your own P4 server
 for an Unreal Engine project.
 
+The `typemap` here will configure the entire server `//...` for the types indicated.
+Change that if needed to limit to a specific `//Depot/...`
+
+The `.p4ignore` should be the first thing you submit to P4
+to ensure that you do not add unwanted files to the stream.
+
+
+## Typemap Server Config
+
 [`typemap.txt`](https://github.com/XistGG/Perforce-Setup/blob/main/typemap.txt)
 should be used like `cat typemap.txt | p4 typemap -i`
 **before** you try to add any files to P4.
 
-The `.p4ignore`
-should be the first thing you commit to your P4 depot,
-to ensure that you do not add unwanted files to P4.
+Note this configures the entire server `//...` which is fine for a new server.
+
+If you are trying to add this to an existing server, you may wish to modify
+the `typemap` to limit its effects to a certain `//Depot/...`
+before you `| p4 typemap -i`
+
+
+## C++ Project Source Depot `.p4ignore`
+
+Source: [`.p4ignore`](https://github.com/XistGG/Perforce-Setup/blob/main/.p4ignore)
+
+This is a `.p4ignore` for a C++ (source-only) Project Source Depot.
+
+This depot is source-only.
+Each developer must compile the Project independently
+for their own platform.
+
+Building the Project in the `Debug Editor` configuration
+will generate all relevant C++ debug symbols, which are
+purely-generated massive files IMO not worth keeping in SCM.
+These files are vital to aiding in C++ debugging efforts.
+
+For best results, the Engine must also be built in `Debug Editor`,
+and/or the debugging symbols must be downloaded via the 
+Epic Games Launcher for a packaged Engine build.
+
+## C++ Custom Engine Source Depot `engine.p4ignore`
+
+Source: [`engine.p4ignore`](https://github.com/XistGG/Perforce-Setup/blob/main/engine.p4ignore)
+
+This is a `.p4ignore` for a Custom Engine Source Depot.
+
+This depot is source-only.
+Each developer must compile the Engine independently
+for their own platform.
 
-For a project-only depot, use
-[`.p4ignore`](https://github.com/XistGG/Perforce-Setup/blob/main/.p4ignore),
-for a custom engine root depot, copy
-[`engine-root.p4ignore`](https://github.com/XistGG/Perforce-Setup/blob/main/engine-root.p4ignore)
-as `.p4ignore`.
+Building the Engine in the `Debug Editor` configuration
+will generate all relevant C++ debug symbols, which are
+purely-generated massive files IMO not worth keeping in SCM.
+These files are vital to aiding in C++ debugging efforts.
 
 
 # See also

engine-root.p4ignore → engine.p4ignore

@@ -1,3 +1,10 @@
+###############################################################################
+###
+###  For help, see:
+###
+###      https://github.com/XistGG/Perforce-Setup
+###
+###############################################################################
 # Here you can specify files to ignore when adding files to the depot.
 #
 # The syntax for P4IGNORE files is not the same as Perforce syntax.
@@ -19,15 +26,18 @@
 # http://stackoverflow.com/questions/18240084/how-does-perforce-ignore-file-syntax-differ-from-gitignore-syntax
 ###############################################################################
 
+# Never check in local .p4config overrides
+.p4config
+
 ###############################################################################
-###  This .p4config is for an Unreal Engine source depot
+###  This .p4ignore is for an Unreal Engine source depot
 ###############################################################################
 
-# Never check in local .p4config overrides
-.p4config
+# This is a source-only Depot -- Ignore all Generated Binaries
+*/Binaries/*
 
-# Ignore root Visual Studio solution files. We do check in some sln files in subdirectories, so only ignore
-# the ones found in the root.
+# Ignore root Visual Studio solution files.
+# We do check in some sln files in subdirectories, so only ignore the ones found in the root.
 /*.sln
 /.p4sync.txt
 
@@ -57,29 +67,17 @@
 
 # Files generated by IDEs? And other dev-tool-related processes
 # These are not files that anyone needs unless actively building the engine
-/Engine/Binaries/DotNET/UnrealBuildTool/*
 /Engine/Plugins/**/Source/**/bin/*
 /Engine/Plugins/**/Source/**/obj/*
 /Engine/Source/Programs/**/bin/*
 /Engine/Source/Programs/**/obj/*
 
-# Ignore Live Coding patch files
-*/Binaries/**/*.patch_*.*
-
 # Ignore Python cached files
 *.pyc
 
 # Ignore JetBrain's IDE folders
 .idea/
 .gradle/
 
-# Ignore autogenerated files from HoloLens WMRInterop
-/Engine/Source/ThirdParty/WindowsMixedRealityInterop/packages/*
-/Engine/Source/ThirdParty/WindowsMixedRealityInterop/MixedRealityInteropHoloLens/Generated Files/*
-/Engine/Source/ThirdParty/WindowsMixedRealityInterop/MixedRealityInteropHoloLens/x64/*
-/Engine/Source/ThirdParty/WindowsMixedRealityInterop/MixedRealityInteropHoloLens/ARM64/*
-/Engine/Source/ThirdParty/WindowsMixedRealityInterop/MixedRealityInterop/x64/*
-/Engine/Source/ThirdParty/WindowsMixedRealityInterop/MixedRealityInterop/ARM64/*
-
 # Ignore files added by Finder on Mac
 .DS_Store