diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index a004c50f1..305de6bdd 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -13,7 +13,7 @@ RUN apt-get update \ && apt-get -y install --no-install-recommends apt-utils 2>&1 \ # # Verify git, process tools, lsb-release (common in install instructions for CLIs) installed - && apt-get -y install git procps lsb-release \ + && apt-get -y install --no-install-recommends git procps lsb-release \ # # Clean up && apt-get autoremove -y \ diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs index 1dcfaa482..1e21b7817 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs @@ -27,7 +27,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region Constructor /// - /// Constructor. + /// The constructor. /// public CimAsyncOperation() { @@ -126,7 +126,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// - /// wrapper of cmdlet, for details. + /// Wrapper of cmdlet, for details. /// public void ProcessActions(CmdletOperationBase cmdletOperation) { @@ -146,12 +146,12 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// process remaining actions until all operations are completed or + /// Process remaining actions until all operations are completed or /// current cmdlet is terminated by user. /// /// /// - /// wrapper of cmdlet, for details. + /// Wrapper of cmdlet, for details. /// public void ProcessRemainActions(CmdletOperationBase cmdletOperation) { @@ -202,7 +202,6 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Add temporary object to cache. /// /// - /// Computer name of the cimsession. /// Cimsession wrapper object. protected void AddCimSessionProxy(CimSessionProxy sessionproxy) { @@ -382,7 +381,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// Output the cimtype of the value, either Reference or ReferenceArray. - /// + /// The object. protected object GetReferenceOrReferenceArrayObject(object value, ref CimType referenceType) { PSReference cimReference = value as PSReference; @@ -496,7 +495,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Clean up managed resources + /// Clean up managed resources. /// /// private void Cleanup() @@ -585,7 +584,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region protected members /// /// Event to notify ps thread that either a ACK message sent back - /// or a error happened. Currently only used by class + /// or a error happened. Currently only used by /// . /// protected ManualResetEventSlim ackedEvent; diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs index 302fd16d9..345b27bb4 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs @@ -69,7 +69,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets internal class CimSyncAction : CimBaseAction, IDisposable { /// - /// Constructor. + /// The constructor. /// public CimSyncAction() { @@ -91,7 +91,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Set response result + /// Set the response result. /// /// internal CimResponseType ResponseType @@ -102,7 +102,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// Call this method when the action is completed or - /// the operation is terminated + /// the operation is terminated. /// /// internal virtual void OnComplete() @@ -112,7 +112,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// block current thread. + /// Block current thread. /// /// protected virtual void Block() diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCmdletModuleInitialize.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCmdletModuleInitialize.cs index 2de029c25..72f6f0e28 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCmdletModuleInitialize.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimCmdletModuleInitialize.cs @@ -25,7 +25,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets { /// /// - /// constructor + /// The constructor. /// /// public CimCmdletsAssemblyInitializer() @@ -56,18 +56,18 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// CimCmdlet alias entry + /// CimCmdlet alias entry. /// /// internal sealed class CimCmdletAliasEntry { /// /// - /// Constructor + /// The constructor. /// /// - /// - /// + /// The entry name. + /// The entry value. internal CimCmdletAliasEntry(string name, string value) { this._name = name; diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs index 49b77c483..28d93fc66 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs @@ -221,10 +221,10 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// session counter bound to current runspace. + /// Session counter bound to current runspace. /// /// - private UInt32 sessionNameCounter; + private uint sessionNameCounter; /// /// @@ -252,7 +252,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// Dictionary used to holds all CimSessions in current runspace by session id. /// /// - private Dictionary curCimSessionsById; + private Dictionary curCimSessionsById; /// /// @@ -265,7 +265,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// constructor + /// The constructor. /// /// internal CimSessionState() @@ -297,7 +297,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// Unique session id under current runspace. - internal UInt32 GenerateSessionId() + internal uint GenerateSessionId() { return this.sessionNameCounter++; } @@ -305,7 +305,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Indicates whether this object was disposed or not + /// Indicates whether this object was disposed or not. /// /// private bool _disposed; @@ -381,17 +381,19 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Add new CimSession object to cache + /// Add new CimSession object to cache. /// /// /// /// /// /// + /// + /// /// internal PSObject AddObjectToCache( CimSession session, - UInt32 sessionId, + uint sessionId, Guid instanceId, string name, string computerName, @@ -434,11 +436,11 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets string message = string.Empty; if (psObject.BaseObject is CimSession) { - UInt32 id = 0x0; + uint id = 0x0; Guid instanceId = Guid.Empty; string name = string.Empty; string computerName = string.Empty; - if (psObject.Properties[idPropName].Value is UInt32) + if (psObject.Properties[idPropName].Value is uint) { id = Convert.ToUInt32(psObject.Properties[idPropName].Value, null); } @@ -466,7 +468,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Remove given object from cache + /// Remove given object from cache. /// /// /// @@ -482,7 +484,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Remove given object from cache + /// Remove given object from cache. /// /// /// @@ -562,7 +564,8 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// List of session wrapper objects. - internal IEnumerable QuerySession(IEnumerable ids, + internal IEnumerable QuerySession( + IEnumerable ids, out IEnumerable errorRecords) { HashSet sessions = new HashSet(); @@ -570,7 +573,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets List errRecords = new List(); errorRecords = errRecords; // NOTES: use template function to implement this will save duplicate code - foreach (UInt32 id in ids) + foreach (uint id in ids) { if (this.curCimSessionsById.ContainsKey(id)) { @@ -594,7 +597,8 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// /// List of session wrapper objects. - internal IEnumerable QuerySession(IEnumerable instanceIds, + internal IEnumerable QuerySession( + IEnumerable instanceIds, out IEnumerable errorRecords) { HashSet sessions = new HashSet(); @@ -781,7 +785,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets #region constructor /// - /// Constructor. + /// The constructor. /// public CimSessionBase() { @@ -814,7 +818,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Default runspace id + /// Default runspace Id. /// /// internal static Guid defaultRunspaceId = Guid.Empty; @@ -855,7 +859,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// clean up the dictionaries if the runspace is closed or broken. + /// Clean up the dictionaries if the runspace is closed or broken. /// /// /// Runspace. @@ -905,7 +909,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets { /// /// - /// Constructor + /// The constructor. /// /// /// @@ -920,7 +924,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets } /// - /// namespace + /// Namespace /// internal CimSessionWrapper CimSessionWrapper { @@ -935,7 +939,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// constructor + /// The constructor. /// /// internal CimNewSession() : base() @@ -988,7 +992,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Add session to global cache + /// Add session to global cache, /// /// /// @@ -999,7 +1003,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets DebugHelper.WriteLogEx(); CimTestCimSessionContext testCimSessionContext = context as CimTestCimSessionContext; - UInt32 sessionId = this.sessionState.GenerateSessionId(); + uint sessionId = this.sessionState.GenerateSessionId(); string originalSessionName = testCimSessionContext.CimSessionWrapper.Name; string sessionName = (originalSessionName != null) ? originalSessionName : string.Format(CultureInfo.CurrentUICulture, @"{0}{1}", CimSessionState.CimSessionClassName, sessionId); @@ -1017,11 +1021,11 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// process all actions in the action queue + /// Process all actions in the action queue. /// /// /// - /// wrapper of cmdlet, for details + /// Wrapper of cmdlet, for details. /// public void ProcessActions(CmdletOperationBase cmdletOperation) { @@ -1030,12 +1034,12 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// process remaining actions until all operations are completed or - /// current cmdlet is terminated by user + /// Process remaining actions until all operations are completed or + /// current cmdlet is terminated by user. /// /// /// - /// wrapper of cmdlet, for details + /// Wrapper of cmdlet, for details. /// public void ProcessRemainActions(CmdletOperationBase cmdletOperation) { @@ -1055,7 +1059,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Indicates whether this object was disposed or not + /// Indicates whether this object was disposed or not. /// /// protected bool Disposed @@ -1120,13 +1124,13 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Get CimSession based on given id/instanceid/computername/name + /// Get CimSession based on given id/instanceid/computername/name. /// /// internal class CimGetSession : CimSessionBase { /// - /// Constructor. + /// The constructor. /// public CimGetSession() : base() { @@ -1197,7 +1201,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Get CimSession based on given id/instanceid/computername/name + /// Get CimSession based on given id/instanceid/computername/name. /// /// internal class CimRemoveSession : CimSessionBase diff --git a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs index 4f8b0e3a9..a8e4fcd97 100644 --- a/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs +++ b/src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs @@ -44,7 +44,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// - /// Session proxy + /// Session proxy. /// /// internal CimSessionProxy Proxy @@ -60,7 +60,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets /// /// Class provides all information regarding the - /// current invocation to .net api. + /// current invocation to the .NET API. /// internal class InvocationContext { diff --git a/src/libpsl-native/README.md b/src/libpsl-native/README.md index 709985944..940fe4115 100644 --- a/src/libpsl-native/README.md +++ b/src/libpsl-native/README.md @@ -1,5 +1,5 @@ # libpsl-native -The code under `libpsl-native` is being migrated to [PowerShell-native](https://github.com/PowerShell/PowerShell-native) repository. +The code under `libpsl-native` is being migrated to the [PowerShell-native](https://github.com/PowerShell/PowerShell-native) repository. Please make PRs to the new repository. Code under here will be removed once the move is complete.