lgladsden/jellyfin-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation and log message cleanup

Browse Source
This commit is contained in:
Mark Monteiro 2020-03-07 20:18:45 +01:00
parent 7ecb16a46e
commit 1295f6c79b
4 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Jellyfin.Server/Migrations/MigrationOptions.cs
View File

@ -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

10
Jellyfin.Server/Migrations/MigrationRunner.cs
View File

@ -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);
}

2
Jellyfin.Server/Migrations/MigrationsFactory.cs
View File

@ -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
{

4
Jellyfin.Server/Migrations/Routines/DisableTranscodingThrottling.cs
View File

@ -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)
{