From ffe273b0c9d00a8792b01567d2eaaa444a9d0df1 Mon Sep 17 00:00:00 2001
From: Jordan Dominion <Cyberboss@users.noreply.github.com>
Date: Sun, 3 Mar 2024 13:36:18 -0500
Subject: [PATCH] A note about `IIOManager.ReadAllBytes` and `/proc`

---
 src/Tgstation.Server.Host/IO/IIOManager.cs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/Tgstation.Server.Host/IO/IIOManager.cs b/src/Tgstation.Server.Host/IO/IIOManager.cs
index 8b8b6f0ce7..e14f15cf29 100644
--- a/src/Tgstation.Server.Host/IO/IIOManager.cs
+++ b/src/Tgstation.Server.Host/IO/IIOManager.cs
@@ -85,6 +85,7 @@ namespace Tgstation.Server.Host.IO
 		/// <param name="path">The path of the file to read.</param>
 		/// <param name="cancellationToken">A <see cref="CancellationToken"/> for the operation.</param>
 		/// <returns>A <see cref="ValueTask"/> that results in the contents of a file at <paramref name="path"/>.</returns>
+		/// <remarks>This function will fail to read files from the /proc filesystem on Linux.</remarks>
 		ValueTask<byte[]> ReadAllBytes(string path, CancellationToken cancellationToken);
 
 		/// <summary>