Skip to content

Commit

Permalink
s/firmwares/firmware/ in comments
Browse files Browse the repository at this point in the history
  • Loading branch information
YoshiRulz committed Oct 26, 2024
1 parent f1d71cc commit 7a1ceaf
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions src/BizHawk.Client.Common/fwmanager/FirmwareManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public static (string FilePath, int FileSize, FirmwareFile FF) PerformPatchOnDis
}

/// <remarks>
/// Sometimes this is called from a loop in <c>FirmwaresConfig.DoScan</c>.
/// Sometimes this is called from a loop in <c>FirmwareConfig.DoScan</c>.
/// In that case, we don't want to call <see cref="DoScanAndResolve"/> repeatedly, so we use <paramref name="forbidScan"/> to skip it.
/// </remarks>
public ResolutionInfo? Resolve(PathEntryCollection pathEntries, IDictionary<string, string> userSpecifications, FirmwareRecord record, bool forbidScan = false)
Expand Down Expand Up @@ -144,7 +144,7 @@ public void DoScanAndResolve(PathEntryCollection pathEntries, IDictionary<string
{
var reader = new RealFirmwareReader();

// build a list of files under the global firmwares path, and build a hash for each of them (as ResolutionInfo) while we're at it
// build a list of files under the global firmware path, and build a hash for each of them (as ResolutionInfo) while we're at it
Queue<DirectoryInfo> todo = [ new(pathEntries.FirmwareAbsolutePath()) ];
while (todo.Count != 0)
{
Expand Down Expand Up @@ -207,7 +207,7 @@ public void DoScanAndResolve(PathEntryCollection pathEntries, IDictionary<string
ri.Size = fi.Length;
ri.Hash = rff.Hash;

// check whether it was a known file anyway, and go ahead and bind to the known file, as a perk (the firmwares config doesn't really use this information right now)
// check whether it was a known file anyway, and go ahead and bind to the known file, as a perk (the firmware config doesn't really use this information right now)
if (FirmwareDatabase.FirmwareFilesByHash.TryGetValue(rff.Hash, out var ff))
{
ri.KnownFirmwareFile = ff;
Expand Down
8 changes: 4 additions & 4 deletions src/BizHawk.Client.EmuHawk/config/FirmwareConfig.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
// notes: eventually, we intend to have a "firmware acquisition interface" exposed to the emulator cores.
// it will be implemented by EmuHawk, and use firmware keys to fetch the firmware content.
// however, for now, the cores are using strings from the config class. so we have the `configMember` which is
// used by reflection to set the configuration for firmwares which were found
// used by reflection to set the configuration for firmware which were found

// TODO - we may eventually need to add a progress dialog for this. we should have one for other reasons.
// I started making one in BizHawk.Util as QuickProgressPopup but ran out of time
Expand Down Expand Up @@ -162,7 +162,7 @@ public FirmwareConfig(
}
}

// makes sure that the specified SystemId is selected in the list (and that all the firmwares for it are visible)
// makes sure that the specified SystemId is selected in the list (and that all the firmware for it is visible)
private void WarpToSystemId(string sysId)
{
bool selectedFirst = false;
Expand Down Expand Up @@ -460,7 +460,7 @@ private void TsmiSetCustomization_Click(object sender, EventArgs e)
var filePath = result;

// if the selected file is an archive, allow the user to pick the inside file
// to always be copied to the global firmwares directory
// to always be copied to the global firmware directory
if (hf.IsArchive)
{
var ac = new ArchiveChooser(new HawkFile(filePath));
Expand All @@ -469,7 +469,7 @@ private void TsmiSetCustomization_Click(object sender, EventArgs e)
var insideFile = hf.BindArchiveMember(ac.SelectedMemberIndex);
var fileData = insideFile.ReadAllBytes();

// write to file in the firmwares folder
// write to file in the firmware folder
File.WriteAllBytes(Path.Combine(firmwarePath, insideFile.Name), fileData);
filePath = Path.Combine(firmwarePath, insideFile.Name);
}
Expand Down
2 changes: 1 addition & 1 deletion src/BizHawk.Emulation.Common/Database/FirmwareDatabase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ void AddPatchAndMaybeReverse(FirmwarePatchOption fpo)
// full hash according to nointro, although incomplete dumps work just as well...
FirmwareAndOption("719B9EEF33692406D7170FF526069615759C4DFC", 65536, "NDS", "bios9i", "NDS_Bios9i.bin", "ARM9i BIOS");
Firmware("NDS", "firmware", "NDS Firmware");
// throwing a ton of hashes from various reported firmwares
// throwing a ton of hashes from various reported firmware
// TODO: Probably should just add in no-intro hashes
var knownhack1 = File("22A7547DBC302BCBFB4005CFB5A2D426D3F85AC6", 262144, "NDS_Firmware [b1].bin", "NDS Firmware", "known hack", true);
var knownhack2 = File("AE22DE59FBF3F35CCFBEACAEBA6FA87AC5E7B14B", 262144, "NDS_Firmware [b2].bin", "NDS Firmware", "known hack", true);
Expand Down
2 changes: 1 addition & 1 deletion src/BizHawk.Emulation.Cores/Consoles/Sony/PSX/Octoshock.cs
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ private void Load(
}
}

//TODO - known bad firmwares are a no-go. we should refuse to boot them. (that's the mednafen policy)
//TODO - known bad firmware is a no-go. we should refuse to boot them. (that's the mednafen policy)
var firmware = comm.CoreFileProvider.GetFirmwareOrThrow(new("PSX", firmwareRegion), $"A PSX `{firmwareRegion}` region bios file is required");

//create the instance
Expand Down
2 changes: 1 addition & 1 deletion src/BizHawk.Emulation.Cores/CoreLoadParameters.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public class CoreLoadParameters<TSettiing, TSync>
public TSync SyncSettings { get; set; }
/// <summary>
/// All roms that should be loaded as part of this core load.
/// Order may be significant. Does not include firmwares or other general resources.
/// Order may be significant. Does not include firmware or other general resources.
/// </summary>
public List<IRomAsset> Roms { get; set; } = new List<IRomAsset>();
/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion src/BizHawk.Emulation.Cores/Waterbox/LibNymaCore.cs
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ public struct SystemInfo

public delegate void FrontendFirmwareNotify(string name);
/// <summary>
/// Set a callback to be called whenever the core calls MDFN_MakeFName for a firmware, so that we can load firmwares on demand
/// Set a callback to be called whenever the core calls MDFN_MakeFName for a firmware, so that we can load firmware on demand
/// </summary>
[BizImport(CC)]
public abstract void SetFrontendFirmwareNotify(FrontendFirmwareNotify cb);
Expand Down
2 changes: 1 addition & 1 deletion src/BizHawk.Tests.Testroms.GB/DummyFrontend.cs
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ public static int TotalFrames
}

/// <summary>
/// set-up firmwares on <paramref name="efp"/>, optionally setting <paramref name="config"/>, then
/// set-up firmware on <paramref name="efp"/>, optionally setting <paramref name="config"/>, then
/// initialise and return a core instance (<paramref name="coreComm"/> is provided),
/// and optionally specify a frame number to seek to (e.g. to skip BIOS screens)
/// </summary>
Expand Down

0 comments on commit 7a1ceaf

Please sign in to comment.