Browse Source

Documentation and log message cleanup

Mark Monteiro 5 years ago
parent
commit
1295f6c79b

+ 1 - 1
Jellyfin.Server/Migrations/MigrationOptions.cs

@@ -15,7 +15,7 @@ namespace Jellyfin.Server.Migrations
 
 #pragma warning disable CA1819 // Properties should not return arrays
         /// <summary>
-        /// Gets or sets he list of applied migration routine names.
+        /// Gets or sets the list of applied migration routine names.
         /// </summary>
         public string[] Applied { get; set; }
 #pragma warning restore CA1819 // Properties should not return arrays

+ 5 - 5
Jellyfin.Server/Migrations/MigrationRunner.cs

@@ -6,7 +6,7 @@ using Microsoft.Extensions.Logging;
 namespace Jellyfin.Server.Migrations
 {
     /// <summary>
-    /// The class that knows how migrate between different Jellyfin versions.
+    /// The class that knows which migrations to apply and how to apply them.
     /// </summary>
     public sealed class MigrationRunner
     {
@@ -45,22 +45,22 @@ namespace Jellyfin.Server.Migrations
                 var updater = Migrations[i];
                 if (applied.Contains(updater.Name))
                 {
-                    logger.LogDebug("Skipping migration {Name} as it is already applied", updater.Name);
+                    logger.LogDebug("Skipping migration '{Name}' since it is already applied", updater.Name);
                     continue;
                 }
 
-                logger.LogInformation("Applying migration {Name}", updater.Name);
+                logger.LogInformation("Applying migration '{Name}'", updater.Name);
                 try
                 {
                     updater.Perform(host, logger);
                 }
                 catch (Exception ex)
                 {
-                    logger.LogError(ex, "Cannot apply migration {Name}", updater.Name);
+                    logger.LogError(ex, "Could not apply migration '{Name}'", updater.Name);
                     throw;
                 }
 
-                logger.LogInformation("Migration {Name} applied successfully", updater.Name);
+                logger.LogInformation("Migration '{Name}' applied successfully", updater.Name);
                 applied.Add(updater.Name);
             }
 

+ 1 - 1
Jellyfin.Server/Migrations/MigrationsFactory.cs

@@ -4,7 +4,7 @@ using MediaBrowser.Common.Configuration;
 namespace Jellyfin.Server.Migrations
 {
     /// <summary>
-    /// A factory that teachs Jellyfin how to find a peristent file which lists all applied migrations.
+    /// A factory that can find a persistent file of the migration configuration, which lists all applied migrations.
     /// </summary>
     public class MigrationsFactory : IConfigurationFactory
     {

+ 2 - 2
Jellyfin.Server/Migrations/Routines/DisableTranscodingThrottling.cs

@@ -8,7 +8,7 @@ using Microsoft.Extensions.Logging;
 namespace Jellyfin.Server.Migrations.Routines
 {
     /// <summary>
-    /// Updater that takes care of bringing configuration up to 10.5.0 standards.
+    /// Disable transcode throttling for all installations since it is currently broken for certain video formats.
     /// </summary>
     internal class DisableTranscodingThrottling : IUpdater
     {
@@ -18,7 +18,7 @@ namespace Jellyfin.Server.Migrations.Routines
         /// <inheritdoc/>
         public void Perform(CoreAppHost host, ILogger logger)
         {
-            // Set EnableThrottling to false as it wasn't used before, and in 10.5.0 it may introduce issues
+            // Set EnableThrottling to false since it wasn't used before and may introduce issues
             var encoding = ((IConfigurationManager)host.ServerConfigurationManager).GetConfiguration<EncodingOptions>("encoding");
             if (encoding.EnableThrottling)
             {