Skip to content

Commit

Permalink
README: provide a cm.log.conf file and explain how to use it
Browse files Browse the repository at this point in the history
  • Loading branch information
SRombautsU committed Jul 3, 2024
1 parent 5a9d0d7 commit d03ffdd
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ Quick tour "Branching with Unity Version Control (Plastic SCM) in Unreal Engine
- [Features not supported](#features-not-supported)
- [Support](#support)
- [Enable debug logs](#enable-debug-logs)
- [Enable Verbose logs in Unreal Engine](#enable-verbose-logs-in-unreal-engine)
- [Enable logging for Unity Version Control CLI](#enable-logging-for-unity-version-control-cli)
- [Report an issue](#report-an-issue)
- [Source code architecture](#source-code-architecture)
- [Copyright](#copyright)
Expand Down Expand Up @@ -668,16 +670,20 @@ Some are reserved for internal use by Epic Games with Perforce only:

#### Enable Verbose logs in Unreal Engine

To help diagnose any issue related to the plugin or to the Editor, toggle Verbose logs in [Source Control settings](#source-control-settings).
To help diagnose any issue related to the plugin or to the Editor, toggle Verbose logs for *LogSourceControl* in [Source Control settings](#source-control-settings).

Unreal log files are in `<ProjectName>/Save/Logs/ProjectName.log`.

#### Enable logging for Unity Version Control
#### Enable logging for Unity Version Control CLI

To help diagnose any issue related to the underlying Unity Version Control "cm" Command Line Interface,
[enable logging for Unity Version Control](https://docs.plasticscm.com/technical-articles/kb-enabling-logging-for-plastic-scm-part-i).
enable debug logs for the CLI client cm.exe:

cm log files are typically in `<LOCALAPPDATA>\plastic4\logs\cm.log.txt`.
Copy [the configuration file cm.log.conf](https://raw.githubusercontent.com/PlasticSCM/UEPlasticPlugin/master/cm.log.conf) in the directory where the cm.exe resides, by default in `C:\Program Files\PlasticSCM5\client\`.

cm log files are then stored in `<LOCALAPPDATA>\plastic4\logs\cm.log.txt`.

(from [enable logging for Plastic SCM](https://docs.plasticscm.com/technical-articles/kb-enabling-logging-for-plastic-scm-part-i))

### Report an issue

Expand Down
32 changes: 32 additions & 0 deletions cm.log.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<log4net>
<appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date %-5level %thread %logger - %message%newline" />
</layout>
</appender>

<appender name="FileAppender" type="log4net.Appender.FileAppender">
<file value="${LOCALAPPDATA}\plastic4\logs\cm.log.txt" />
<appendToFile value="true" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date %-5level %thread %logger - %message%newline" />
</layout>
</appender>

<logger name="Serialization">
<level value="DEBUG" />
</logger>

<logger name="BufferPool">
<level value="DEBUG" />
</logger>

<logger name="MasterViewManagerGroups">
<level value="DEBUG" />
</logger>

<root>
<level value="DEBUG" />
<appender-ref ref="FileAppender" />
</root>
</log4net>

0 comments on commit d03ffdd

Please sign in to comment.