Reword comments for policheck (dotnet/coreclr#27669)
authorJeremy Koritzinsky <jekoritz@microsoft.com>
Tue, 5 Nov 2019 00:07:33 +0000 (16:07 -0800)
committerJan Kotas <jkotas@microsoft.com>
Tue, 5 Nov 2019 00:07:33 +0000 (16:07 -0800)
* Comment rewordings required by policheck.

* Use AppContainer instead of Windows Store.

* Additional wording cleanup.

Commit migrated from https://github.com/dotnet/coreclr/commit/340d69c20d57a2b161aa74c516886bf45df8ee22

src/coreclr/src/inc/bbsweep.h
src/coreclr/src/pal/inc/rt/specstrings_strict.h
src/coreclr/src/vm/rejit.cpp

index e07cd36..71c786a 100644 (file)
@@ -196,7 +196,7 @@ private:
             if (!OpenProcessToken(GetCurrentProcess(), TOKEN_QUERY, &hToken))
                 goto cleanup;
 
-            // don't set pSecurityAttributes for Metro processes
+            // don't set pSecurityAttributes for AppContainer processes
             if(!IsAppContainerProcess(hToken))
             {
                 SECURITY_ATTRIBUTES securityAttributes;
@@ -344,23 +344,23 @@ cleanup:
         // 2. From bbsweepclr.exe
         //
         // When called from process init code, processID is always INVALID_PID.
-        // In case it is a Win8-Metro/WP8 process, we need to add the AppContainerNamedObjectPath to prefix.
-        // And if it is a non-Metro process, we will continue to use the default prefix (Global).
+        // In case it is a AppContainer process, we need to add the AppContainerNamedObjectPath to prefix.
+        // And if it is a non-AppContainer process, we will continue to use the default prefix (Global).
         // We use IsAppContainerProcess(CurrentProcessId) to make this decision.
         //
         //
-        // When called from bbsweepclr, processID is valid when sweeping a Metro or WP8 process.
-        // We use this valid processID to determine if the process being swept is Metro/WP8 indeed and then
+        // When called from bbsweepclr, processID is valid when sweeping a AppContainer process.
+        // We use this valid processID to determine if the process being swept is AppContainer indeed and then
         // add AppContainerNamedObjectPath to prefix. This is done by IsAppContainerProcess(processID).
         //
-        // In case INVALID_PID is passed(non-Metro process), we have to use default prefix. To handle this
-        // case we use IsAppContainerProcess(CurrentProcessId) and since bbsweepclr is a non-Metro process,
+        // In case INVALID_PID is passed(non-AppContainer process), we have to use default prefix. To handle this
+        // case we use IsAppContainerProcess(CurrentProcessId) and since bbsweepclr is a non-AppContainer process,
         // this check always returns false and we end up using the intended(default) prefix.
         //
         if(processID == INVALID_PID) {
             // we reach here when:
             // * called from process init code:
-            // * called from bbsweepclr.exe and no processID has been passed as argument, that is, when sweeping a non-Metro process
+            // * called from bbsweepclr.exe and no processID has been passed as argument, that is, when sweeping a non-AppContainer process
             processID = GetCurrentProcessId();
         }
 
@@ -368,7 +368,7 @@ cleanup:
         if (hProcess  != INVALID_HANDLE_VALUE)
         {
             HandleHolder hToken = NULL;
-            // if in the process init code of a Metro app or if bbsweepclr is used to sweep a Metro app,
+            // if in the process init code of a AppContainer app or if bbsweepclr is used to sweep a AppContainer app,
             // construct the object name prefix using AppContainerNamedObjectPath
             if (OpenProcessToken(hProcess, TOKEN_QUERY, &hToken) && IsAppContainerProcess(hToken))
             {
@@ -377,7 +377,7 @@ cleanup:
 
                 if (fromRuntime)
                 {
-                    // for Metro apps, create the object in the "default" object path, i.e. do not provide any prefix
+                    // for AppContainer apps, create the object in the "default" object path, i.e. do not provide any prefix
                     objectNamePrefix[0] = W('\0');
                 }
                 else
@@ -394,7 +394,7 @@ cleanup:
                         GetProcAddress(WszGetModuleHandle(MODULE_NAME), "GetAppContainerNamedObjectPath");
                     if (pfnGetAppContainerNamedObjectPath)
                     {
-                        // for bbsweepclr sweeping a Metro app, create the object specifying the AppContainer's path
+                        // for bbsweepclr sweeping a AppContainer app, create the object specifying the AppContainer's path
                         DWORD sessionId = 0;
                         ProcessIdToSessionId(processID, &sessionId);
                         pfnGetAppContainerNamedObjectPath(hToken, NULL, sizeof (appxNamedObjPath) / sizeof (WCHAR), appxNamedObjPath, &appxNamedObjPathBufLen);
index 63ef075..2cf3512 100644 (file)
 *  void myfree(__deallocate_opt(Mem) void *p) : Memory is freed, no longer
 *  usable upon return, and p may be null.
 *
-*  void free(__post_invalid void* x): Mark memory as untouchable when
+*  void free(__post_invalid void* x): Mark memory as unusable when
 *  function returns.
 *
 *  ----------------------------------------------------------------------------
index 1d8105e..72e8730 100644 (file)
@@ -1154,7 +1154,7 @@ HRESULT ReJitManager::ConfigureILCodeVersion(ILCodeVersion ilCodeVersion)
     }
     else if (fWaitForParameters)
     {
-        // This feels lame, but it doesn't appear like we have the good threading primitves
+        // This feels annoying, but it doesn't appear like we have the good threading primitves
         // for this. What I would like is an AutoResetEvent that atomically exits the table
         // Crst when I wait on it. From what I can tell our AutoResetEvent doesn't have
         // that atomic transition which means this ordering could occur: