diff --git a/.github/policies/resourceManagement.yml b/.github/policies/resourceManagement.yml index a01dda2..82307e6 100644 --- a/.github/policies/resourceManagement.yml +++ b/.github/policies/resourceManagement.yml @@ -181,7 +181,7 @@ configuration: ``` - The scipt will output the path of the log file once done. + The script will output the path of the log file once done. Once completed please upload the output files to this GitHub issue. @@ -190,7 +190,7 @@ configuration: See [Collect WSL logs (recommended method)](https://github.com/microsoft/WSL/blob/master/CONTRIBUTING.md#8-collect-wsl-logs-recommended-method). - If you choose to email these logs instead of attaching to the bug, please send them to wsl-gh-logs@microsoft.com with the number of the github issue in the subject, and in the message a link to your comment in the github issue. + If you choose to email these logs instead of attaching them to the bug, please send them to wsl-gh-logs@microsoft.com with the GitHub issue number in the subject, and include a link to your GitHub issue comment in the message body. Thank you! @@ -226,7 +226,7 @@ configuration: ``` - The scipt will output the path of the log file once done. + The script will output the path of the log file once done. Once completed please upload the output files to this GitHub issue. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d857336..3cf1e0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,7 +68,7 @@ The script will output the path of the log file once done. ### Collect WSL logs (recommended method) -If you choose to email these logs instead of attaching to the bug, please send them to wsl-gh-logs@microsoft.com with the number of the github issue in the subject, and in the message a link to your comment in the github issue. +If you choose to email these logs instead of attaching them to the bug, please send them to wsl-gh-logs@microsoft.com with the GitHub issue number in the subject, and include a link to your GitHub issue comment in the message body. To collect WSL logs, download and execute [collect-wsl-logs.ps1](https://github.com/Microsoft/WSL/blob/master/diagnostics/collect-wsl-logs.ps1) in an administrative powershell prompt: diff --git a/SECURITY.md b/SECURITY.md index 132691a..d142636 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -10,11 +10,11 @@ If you believe you have found a security vulnerability in any Microsoft-owned re **Please do not report security vulnerabilities through public GitHub issues.** -Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report). +Instead, please [report them to the Microsoft Security Response Center (MSRC)](https://aka.ms/opensource/security/create-report). If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey). -You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [Microsoft Security Response Center](https://aka.ms/opensource/security/msrc). Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: diff --git a/doc/docs/technical-documentation/boot-process.md b/doc/docs/technical-documentation/boot-process.md index 89cb232..82b7d2a 100644 --- a/doc/docs/technical-documentation/boot-process.md +++ b/doc/docs/technical-documentation/boot-process.md @@ -82,7 +82,7 @@ When started, the virtual machine will boot into the provided kernel, and then e - An entropy buffer, to seed the virtual machine's entropy - Information about the GPU drivers shares to mount, if any -- Wether [wslg](https://github.com/microsoft/wslg) is enabled +- Whether [wslg](https://github.com/microsoft/wslg) is enabled After applying all the configuration requested by [wslservice.exe](wslservice.exe.md), the virtual machine is ready to start Linux distributions. diff --git a/localization/strings/en-GB/Resources.resw b/localization/strings/en-GB/Resources.resw index 854dc35..28ca6b6 100644 --- a/localization/strings/en-GB/Resources.resw +++ b/localization/strings/en-GB/Resources.resw @@ -1100,7 +1100,7 @@ Error code: {} Failed to query networking mode - Customised kernel modules were supplied without a specifying a customised kernel. Please see https://aka.ms/wslcustomkernel for more information. + Customised kernel modules were supplied without specifying a customised kernel. Please see https://aka.ms/wslcustomkernel for more information. Due to a current compatibility issue with Global Secure Access Client, DNS Tunneling is disabled. diff --git a/localization/strings/en-US/Resources.resw b/localization/strings/en-US/Resources.resw index fc9fb8b..27a9f1a 100644 --- a/localization/strings/en-US/Resources.resw +++ b/localization/strings/en-US/Resources.resw @@ -1100,7 +1100,7 @@ Error code: {} Failed to query networking mode - Customised kernel modules were supplied without a specifying a customised kernel. Please see https://aka.ms/wslcustomkernel for more information. + Customised kernel modules were supplied without specifying a customised kernel. Please see https://aka.ms/wslcustomkernel for more information. Due to a current compatibility issue with Global Secure Access Client, DNS Tunneling is disabled. diff --git a/src/linux/init/config.cpp b/src/linux/init/config.cpp index 7ca9f7e..e786a34 100644 --- a/src/linux/init/config.cpp +++ b/src/linux/init/config.cpp @@ -835,8 +835,8 @@ try // // Run the Plan 9 server. This requires a DrvFs mount for the socket file, - // so either fstab or automount must be enabled to have a chance the mount - // exists. + // so either fstab or automount must be enabled to have a chance for the + // mount to be available. // // N.B. Failure to start the server is non-fatal. // diff --git a/src/linux/init/localhost.cpp b/src/linux/init/localhost.cpp index d743b32..88cad60 100644 --- a/src/linux/init/localhost.cpp +++ b/src/linux/init/localhost.cpp @@ -64,7 +64,7 @@ void ListenThread(sockaddr_vm hvSocketAddress, int listenSocket) // Connect to the actual socket address and set up a relay. // - // N.B. During the time setting up the relay the server may have + // N.B. While the relay was being set up, the server may have // stopped listening. sockaddr* socketAddress; int socketAddressSize; diff --git a/src/linux/init/main.cpp b/src/linux/init/main.cpp index 3dc9680..0f9c7c0 100644 --- a/src/linux/init/main.cpp +++ b/src/linux/init/main.cpp @@ -3168,8 +3168,8 @@ Routine Description: Arguments: - MessageFd - Supplies a file descriptor to the socket the message was received - on. This is used for operations that require responses, for example a + MessageFd - Supplies a file descriptor to the socket on which the message was + received. This is used for operations that require responses, for example a VHD eject request. Buffer - Supplies the message. @@ -3802,7 +3802,7 @@ Routine Description: Arguments: - Pth - Supplies the path to the block device. + Path - Supplies the path to the block device. Return Value: diff --git a/src/shared/inc/message.h b/src/shared/inc/message.h index 6d6a15e..016bfff 100644 --- a/src/shared/inc/message.h +++ b/src/shared/inc/message.h @@ -143,7 +143,7 @@ public: gsl::span Span() { // In case the structure is padded, - // make sure that the message is a least the size of the structure. + // make sure that the message is at least the size of the structure. const int64_t diff = sizeof(TMessage) - m_buffer.size(); if (diff > 0) diff --git a/src/windows/common/Localization.cpp b/src/windows/common/Localization.cpp index cb2875d..433ce7c 100644 --- a/src/windows/common/Localization.cpp +++ b/src/windows/common/Localization.cpp @@ -45,7 +45,7 @@ std::vector GetUserLanguages(bool impersonate) { if (g_runningInService) { - // N.B. If we're in the service the locale needs to be queried every time since different users + // N.B. If we're in the service, the locale needs to be queried every time since different users // can have different language configurations. std::optional revert; if (impersonate) diff --git a/src/windows/common/WslCoreNetworkingSupport.h b/src/windows/common/WslCoreNetworkingSupport.h index a1ac364..ff6ac76 100644 --- a/src/windows/common/WslCoreNetworkingSupport.h +++ b/src/windows/common/WslCoreNetworkingSupport.h @@ -545,7 +545,7 @@ private: &BufferSize); } while (Result == ERROR_BUFFER_OVERFLOW); - THROW_LAST_ERROR_IF_MSG((Result != ERROR_SUCCESS), "GetAdpatersAddresses"); + THROW_LAST_ERROR_IF_MSG((Result != ERROR_SUCCESS), "GetAdaptersAddresses"); m_buffer.resize(BufferSize); auto AddressBuffer = (PIP_ADAPTER_ADDRESSES)m_buffer.data(); std::vector addresses; diff --git a/src/windows/service/exe/LxssUserSession.h b/src/windows/service/exe/LxssUserSession.h index 9a08591..20d1227 100644 --- a/src/windows/service/exe/LxssUserSession.h +++ b/src/windows/service/exe/LxssUserSession.h @@ -484,7 +484,7 @@ public: HRESULT AttachDisk(_In_ LPCWSTR Disk, _In_ ULONG Flags); /// - /// Detach a passthrough a disk from the utility VM. + /// Detach a passthrough disk from the utility VM. /// HRESULT DetachDisk(_In_ LPCWSTR Disk, _Out_ int* Result, _Out_ int* Step); diff --git a/test/linux/unit_tests/auxv.c b/test/linux/unit_tests/auxv.c index 0d6914b..fbbbacb 100644 --- a/test/linux/unit_tests/auxv.c +++ b/test/linux/unit_tests/auxv.c @@ -411,7 +411,7 @@ int AuxvAtExecfn(PLXT_ARGS Args) LxtCheckResult(LxtWaitPidPoll(ChildPid, LXT_RESULT_SUCCESS)); // - // Run the binary an empty command line. + // Run the binary with an empty command line. // LxtCheckErrno(ChildPid = fork()); @@ -516,7 +516,7 @@ int AuxvAtExecfn(PLXT_ARGS Args) LxtCheckResult(LxtWaitPidPoll(ChildPid, LXT_RESULT_SUCCESS)); // - // Run the script an empty command line. + // Run the script with an empty command line. // LxtCheckErrno(ChildPid = fork()); diff --git a/test/linux/unit_tests/dev_pt_common.c b/test/linux/unit_tests/dev_pt_common.c index c213e39..1b6201d 100644 --- a/test/linux/unit_tests/dev_pt_common.c +++ b/test/linux/unit_tests/dev_pt_common.c @@ -72,7 +72,7 @@ int GetPtSerialNumFromDeviceString(const char PtsNameString[]) Routine Description: - This routine will parse the PTS (Psedu Terminal Slave) device name and + This routine will parse the PTS (Pseudo Terminal Slave) device name and retrieve the Serial Number from the string. Arguments: diff --git a/test/linux/unit_tests/get_set_id.c b/test/linux/unit_tests/get_set_id.c index 5d3d9fc..f2590a9 100644 --- a/test/linux/unit_tests/get_set_id.c +++ b/test/linux/unit_tests/get_set_id.c @@ -1027,7 +1027,7 @@ Return Value: LxtCheckErrnoZeroSuccess(connect(ClientSocket, (struct sockaddr*)&Address, sizeof(Address))); // - // Tell the parent the process is running inside the execve'd binary. + // Tell the parent that the process is running inside the execve'd binary. // LxtCheckResult(LxtSendMessage(ClientSocket, "execve")); @@ -1106,7 +1106,7 @@ Return Value: LxtCheckEqual(Sid, getpgid(0), "%d"); // - // Tell the parent the new session was created. + // Tell the parent that a new session was created. // LxtCheckErrnoZeroSuccess(kill(getppid(), SIGUSR1)); diff --git a/test/linux/unit_tests/lxtfs.c b/test/linux/unit_tests/lxtfs.c index ce030e3..ee5fd47 100644 --- a/test/linux/unit_tests/lxtfs.c +++ b/test/linux/unit_tests/lxtfs.c @@ -3403,7 +3403,7 @@ Return Value: // // When using the current time, there is a slight chance of this test - // failing when the time the file was set to and the time when the check + // failing when the time set for the file and the time when the check // is done straddle midnight. // diff --git a/test/linux/unit_tests/sched.c b/test/linux/unit_tests/sched.c index b59e711..5ff716f 100644 --- a/test/linux/unit_tests/sched.c +++ b/test/linux/unit_tests/sched.c @@ -320,7 +320,7 @@ int SetGetAffinityNp(PLXT_ARGS Args) // // N.B Affinity cannot be validated because its not guaranteed for it to - // take affect. + // take effect. // LxtLogInfo("Current Affinity: %08x", *(uint32_t*)&Set); diff --git a/test/linux/unit_tests/sem.c b/test/linux/unit_tests/sem.c index 85cfd5f..07904a5 100644 --- a/test/linux/unit_tests/sem.c +++ b/test/linux/unit_tests/sem.c @@ -181,7 +181,7 @@ int SemCtlSyscall(PLXT_ARGS Args) // // Ensure that each semaphore's value has been updated. Interestingly the - // lastpid value is not updated by the SETALL command. + // last pid value is not updated by the SETALL command. // LxtCheckErrno(LxtSemCtl(Id, 0, SETALL, &Values)); diff --git a/test/linux/unit_tests/vnet.c b/test/linux/unit_tests/vnet.c index 6d08b19..173a87b 100644 --- a/test/linux/unit_tests/vnet.c +++ b/test/linux/unit_tests/vnet.c @@ -1486,7 +1486,7 @@ Arguments: Flag - Supplies the flag to toggle. - IsFlagEnabled - Supplies the state the flag should be set to. + IsFlagEnabled - Supplies the state to which the flag should be set. Response - Supplies a pointer to receive the response errno. diff --git a/test/linux/unit_tests/waitpid.c b/test/linux/unit_tests/waitpid.c index a7ef753..beccf08 100644 --- a/test/linux/unit_tests/waitpid.c +++ b/test/linux/unit_tests/waitpid.c @@ -29,8 +29,8 @@ Abstract: #define WAITPID_DEFAULT_WAIT_TIMEOUT_US 100000 #define WAITPID_DEFAULT_WAIT_COUNT 20 -#define WAIDPID_THREADGROUP_LEADER_UID 1044 -#define WAIDPID_PTHREAD_UID 1055 +#define WAITPID_THREADGROUP_LEADER_UID 1044 +#define WAITPID_PTHREAD_UID 1055 bool g_VmMode = false; @@ -719,7 +719,7 @@ Return Value: int Result; LxtLogInfo("WaitPid child tid %d", gettid()); - LxtCheckErrno(LxtSetUid(WAIDPID_PTHREAD_UID)); + LxtCheckErrno(LxtSetUid(WAITPID_PTHREAD_UID)); // // Enter a very long sleep, this will be interrupted when the threadgroup @@ -785,7 +785,7 @@ Return Value: // sleep(1); - LxtCheckErrno(LxtSetUid(WAIDPID_THREADGROUP_LEADER_UID)); + LxtCheckErrno(LxtSetUid(WAITPID_THREADGROUP_LEADER_UID)); _exit(ExpectedStatus); } @@ -794,7 +794,7 @@ Return Value: LxtCheckEqual(SigInfo.si_code, CLD_EXITED, "%d"); LxtCheckEqual(SigInfo.si_status, ExpectedStatus, "%d"); LxtCheckEqual(SigInfo.si_pid, ChildPid, "%d"); - LxtCheckEqual(SigInfo.si_uid, WAIDPID_THREADGROUP_LEADER_UID, "%d"); + LxtCheckEqual(SigInfo.si_uid, WAITPID_THREADGROUP_LEADER_UID, "%d"); // // Wait for a specific child. @@ -1006,7 +1006,7 @@ Return Value: ChildPid = -1; // - // Create a child process, that in turn creates a granchild process + // Create a child process, that in turn creates a grandchild process // with CLONE_PARENT. // diff --git a/test/windows/NetworkTests.cpp b/test/windows/NetworkTests.cpp index c4994e2..82e6a67 100644 --- a/test/windows/NetworkTests.cpp +++ b/test/windows/NetworkTests.cpp @@ -2680,7 +2680,7 @@ class NetworkTests {.guiApplications = true, .networkingMode = wsl::core::NetworkingMode::Mirrored, .hostAddressLoopback = true})); WaitForMirroredStateInLinux(); - // We list the IPv4 addresses mirrored in Linux and use in the test the first one we find + // We list the IPv4 addresses mirrored in Linux and use the first one we find in the test std::vector interfaceStates = GetAllInterfaceStates(); std::wstring ipAddress; @@ -2760,7 +2760,7 @@ class NetworkTests {.guiApplications = true, .networkingMode = wsl::core::NetworkingMode::Mirrored, .hostAddressLoopback = true})); WaitForMirroredStateInLinux(); - // We list the IPv4 addresses mirrored in Linux and use in the test the first one we find + // We list the IPv4 addresses mirrored in Linux and use the first one we find in the test std::vector interfaceStates = GetAllInterfaceStates(); std::wstring ipAddress; @@ -3650,7 +3650,7 @@ class NetworkTests return std::find(v6State.Routes.begin(), v6State.Routes.end(), route) != v6State.Routes.end(); } - // Reads from the file until the substring is found, a timeout is reached or ReadFile returns an error + // Reads from the file until the substring is found, a timeout is reached, or ReadFile returns an error // Returns true on success, false otherwise static bool FindSubstring(wil::unique_handle& file, const std::string& substr, std::string& output) { diff --git a/test/windows/UnitTests.cpp b/test/windows/UnitTests.cpp index 400dc90..d20bb14 100644 --- a/test/windows/UnitTests.cpp +++ b/test/windows/UnitTests.cpp @@ -227,7 +227,7 @@ class UnitTests CreateUser(LXSST_TEST_USERNAME, &TestUid, &TestGid); auto userCleanup = wil::scope_exit([]() { LxsstuLaunchWsl(L"userdel " LXSST_TEST_USERNAME); }); - auto validateUserSesssion = [&]() { + auto validateUserSession = [&]() { // verify that the user service is running const std::wstring isServiceActiveCmd = std::format(L"-u {} systemctl is-active user@{}.service ; exit 0", LXSST_TEST_USERNAME, TestUid); @@ -260,7 +260,7 @@ class UnitTests // Validate user sessions state with gui apps disabled. { - validateUserSesssion(); + validateUserSession(); auto [out, err] = LxsstuLaunchWslAndCaptureOutput(std::format(L"echo $DISPLAY", LXSST_TEST_USERNAME)); VERIFY_ARE_EQUAL(out, L"\n"); @@ -270,7 +270,7 @@ class UnitTests { WslConfigChange config(LxssGenerateTestConfig({.guiApplications = true})); - validateUserSesssion(); + validateUserSession(); auto [out, err] = LxsstuLaunchWslAndCaptureOutput(std::format(L"echo $DISPLAY", LXSST_TEST_USERNAME)); VERIFY_ARE_EQUAL(out, L":0\n"); } @@ -2608,7 +2608,7 @@ Error code: Wsl/InstallDistro/WSL_E_DISTRO_NOT_FOUND { WSL2_TEST_ONLY(); - // Get the kernel version and stip off everything after the first dash. + // Get the kernel version and strip off everything after the first dash. std::wstring kernelVersion{TEXT(KERNEL_VERSION)}; auto position = kernelVersion.find_first_of(L"-"); if (position != kernelVersion.npos) @@ -3585,10 +3585,10 @@ localhostForwarding=true validateUidChange(L"testuser", Uid, L"The operation completed successfully. \r\n", L"", 0); validateUidChange(L"root", 0, L"The operation completed successfully. \r\n", L"", 0); - const std::wstring invalidUser = L"DoesntExist"; + const std::wstring invalidUser = L"Nonexistent"; validateUidChange(invalidUser, 0, L"", L"/usr/bin/id: \u2018" + invalidUser + L"\u2019: no such user\n", 1); - auto [out, _] = LxsstuLaunchWslAndCaptureOutput(L"--manage doesntexist --set-default-user root", -1); + auto [out, _] = LxsstuLaunchWslAndCaptureOutput(L"--manage nonexistent --set-default-user root", -1); VERIFY_ARE_EQUAL( out, L"There is no distribution with the supplied name.\r\nError code: Wsl/Service/WSL_E_DISTRO_NOT_FOUND\r\n"); @@ -5203,7 +5203,7 @@ Error code: Wsl/InstallDistro/WSL_E_DISTRO_NOT_FOUND\r\n", "Name": "{}", "FriendlyName": "DebianFriendlyName", "Amd64Url": {{ - "Url": "file://doesnotexist", + "Url": "file://nonexistent", "Sha256": "" }} }}, @@ -5211,7 +5211,7 @@ Error code: Wsl/InstallDistro/WSL_E_DISTRO_NOT_FOUND\r\n", "Name": "dummy", "FriendlyName": "dummy", "Amd64Url": {{ - "Url": "file://doesnotexist", + "Url": "file://nonexistent", "Sha256": "" }} }} diff --git a/triage/config.yml b/triage/config.yml index 9bf4f4a..9a3a4ad 100644 --- a/triage/config.yml +++ b/triage/config.yml @@ -27,7 +27,7 @@ logs_rules: See [Collect WSL logs (recommended method)](https://github.com/microsoft/WSL/blob/master/CONTRIBUTING.md#8-collect-wsl-logs-recommended-method). - If you choose to email these logs instead of attaching to the bug, please send them to wsl-gh-logs@microsoft.com with the number of the github issue in the subject, and in the message a link to your comment in the github issue and reply with '/emailed-logs'. + If you choose to email these logs instead of attaching them to the bug, please send them to wsl-gh-logs@microsoft.com with the GitHub issue number in the subject, and include a link to your GitHub issue comment in the message body, and reply with '/emailed-logs'.