nerdbank-gitversioning 3.6.132 → 3.7.48-alpha

package/nbgv.cli/tools/net6.0/any/Nerdbank.GitVersioning.xml

@@ -649,6 +649,11 @@
             Gets the canonical name for HEAD's position (e.g. <c>refs/heads/main</c>).
             </summary>
         </member>
+        <member name="P:Nerdbank.GitVersioning.GitContext.HeadTags">
+            <summary>
+            Gets a collection of the tags that reference HEAD.
+            </summary>
+        </member>
         <member name="P:Nerdbank.GitVersioning.GitContext.DotGitPath">
             <summary>
             Gets the path to the .git folder.
@@ -836,6 +841,11 @@
             A git context implemented in terms of LibGit2Sharp.
             </summary>
         </member>
+        <member name="F:Nerdbank.GitVersioning.LibGit2.LibGit2Context.headTags">
+            <summary>
+            Caching field behind <see cref="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.HeadTags" /> property.
+            </summary>
+        </member>
         <member name="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.VersionFile">
             <inheritdoc />
         </member>
@@ -851,6 +861,9 @@
         <member name="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.HeadCanonicalName">
             <inheritdoc />
         </member>
+        <member name="P:Nerdbank.GitVersioning.LibGit2.LibGit2Context.HeadTags">
+            <inheritdoc />
+        </member>
         <member name="M:Nerdbank.GitVersioning.LibGit2.LibGit2Context.Create(System.String,System.String)">
             <summary>Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.LibGit2.LibGit2Context"/> class.</summary>
             <param name="path">The path to the .git directory or somewhere in a git working tree.</param>
@@ -1183,6 +1196,76 @@
             <param name="stream">The stream to open to, if the file exists.</param>
             <returns><see langword="true" /> if the file exists; otherwise <see langword="false" />.</returns>
         </member>
+        <member name="T:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag">
+            <summary>
+            Represents a Git annotated tag, as stored in the Git object database.
+            </summary>
+        </member>
+        <member name="P:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag.Object">
+            <summary>
+            Gets or sets the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/> of object this tag is pointing at.
+            </summary>
+        </member>
+        <member name="P:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag.Sha">
+            <summary>
+            Gets or sets a <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/> which uniquely identifies the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag"/>.
+            </summary>
+        </member>
+        <member name="P:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag.Tag">
+            <summary>
+            Gets or sets the tag name of this annotated tag.
+            </summary>
+        </member>
+        <member name="P:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag.Type">
+            <summary>
+            Gets or sets the type of the object this tag is pointing to, e.g. "commit" or, for nested tags, "tag".
+            </summary>
+        </member>
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag.Equals(System.Object)">
+            <inheritdoc/>
+        </member>
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag.Equals(Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag)">
+            <inheritdoc/>
+        </member>
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag.GetHashCode">
+            <inheritdoc/>
+        </member>
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag.ToString">
+            <inheritdoc/>
+        </member>
+        <member name="T:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTagReader">
+            <summary>
+            Reads a <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag"/> object.
+            </summary>
+        </member>
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTagReader.Read(System.IO.Stream,Nerdbank.GitVersioning.ManagedGit.GitObjectId)">
+            <summary>
+            Reads a <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag"/> object from a <see cref="T:System.IO.Stream"/>.
+            </summary>
+            <param name="stream">
+            A <see cref="T:System.IO.Stream"/> which contains the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag"/> in its text representation.
+            </param>
+            <param name="sha">
+            The <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/> of the commit.
+            </param>
+            <returns>
+            The <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag"/>.
+            </returns>
+        </member>
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTagReader.Read(System.ReadOnlySpan{System.Byte},Nerdbank.GitVersioning.ManagedGit.GitObjectId)">
+            <summary>
+            Reads a <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag"/> object from a <see cref="T:System.ReadOnlySpan`1"/>.
+            </summary>
+            <param name="tag">
+            A <see cref="T:System.ReadOnlySpan`1"/> which contains the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag"/> in its text representation.
+            </param>
+            <param name="sha">
+            The <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/> of the annotated tag.
+            </param>
+            <returns>
+            The <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitAnnotatedTag"/>.
+            </returns>
+        </member>
         <member name="T:Nerdbank.GitVersioning.ManagedGit.GitCommit">
             <summary>
             Represents a Git commit, as stored in the Git object database.
@@ -1348,6 +1431,19 @@
             A <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/>.
             </returns>
         </member>
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitObjectId.Parse(System.ReadOnlySpan{System.Char})">
+            <summary>
+            Parses a <see cref="T:System.ReadOnlySpan`1"/> of <see cref="T:System.Char"/> which contains the
+            hexadecimal representation of a <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/>.
+            </summary>
+            <param name="value">
+            A <see cref="T:System.ReadOnlySpan`1"/> of <see cref="T:System.Char"/> which contains the
+            hexadecimal representation of the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/>.
+            </param>
+            <returns>
+            A <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitObjectId"/>.
+            </returns>
+        </member>
         <member name="M:Nerdbank.GitVersioning.ManagedGit.GitObjectId.Parse(System.String)">
             <summary>
             Parses a <see cref="T:System.String"/> which contains the hexadecimal representation of a
@@ -1577,15 +1673,15 @@
             compressed and can be deltified.
             </summary>
         </member>
-        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackCache.TryOpen(System.Int64,System.IO.Stream@)">
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackCache.TryOpen(System.Int64,System.Nullable{System.ValueTuple{System.IO.Stream,System.String}}@)">
             <summary>
             Attempts to retrieve a Git object from cache.
             </summary>
             <param name="offset">
             The offset of the Git object in the Git pack.
             </param>
-            <param name="stream">
-            A <see cref="T:System.IO.Stream"/> which will be set to the cached Git object.
+            <param name="hit">
+            A (<see cref="T:System.IO.Stream"/>, ContentType) tuple which will be set to the cached data if found.
             </param>
             <returns>
             <see langword="true"/> if the object was found in cache; otherwise,
@@ -1600,7 +1696,7 @@
             A <see cref="T:System.Text.StringBuilder"/> to which to write the statistics.
             </param>
         </member>
-        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackCache.Add(System.Int64,System.IO.Stream)">
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackCache.Add(System.Int64,System.IO.Stream,System.String)">
             <summary>
             Adds a Git object to this cache.
             </summary>
@@ -1611,6 +1707,7 @@
             A <see cref="T:System.IO.Stream"/> which represents the object to add. This stream
             will be copied to the cache.
             </param>
+            <param name="objectType">The object type of the object to add to the cache.</param>
             <returns>
             A <see cref="T:System.IO.Stream"/> which represents the cached entry.
             </returns>
@@ -1755,16 +1852,16 @@
               twice, it is read from the <see cref="T:System.IO.MemoryStream"/>, rather than the underlying <see cref="T:System.IO.Stream"/>.
             </para>
             <para>
-              <see cref="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCache.Add(System.Int64,System.IO.Stream)"/> and <see cref="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCache.TryOpen(System.Int64,System.IO.Stream@)"/> return <see cref="T:System.IO.Stream"/>
+              <see cref="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCache.Add(System.Int64,System.IO.Stream,System.String)"/> and <see cref="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCache.TryOpen(System.Int64,System.Nullable{System.ValueTuple{System.IO.Stream,System.String}}@)"/> return <see cref="T:System.IO.Stream"/>
               objects which may operate on the same underlying <see cref="T:System.IO.Stream"/>, but independently maintain
               their state.
             </para>
             </summary>
         </member>
-        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCache.Add(System.Int64,System.IO.Stream)">
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCache.Add(System.Int64,System.IO.Stream,System.String)">
             <inheritdoc/>
         </member>
-        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCache.TryOpen(System.Int64,System.IO.Stream@)">
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCache.TryOpen(System.Int64,System.Nullable{System.ValueTuple{System.IO.Stream,System.String}}@)">
             <inheritdoc/>
         </member>
         <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackMemoryCache.GetCacheStatistics(System.Text.StringBuilder)">
@@ -1852,10 +1949,10 @@
             Gets the default instance of the <see cref="T:Nerdbank.GitVersioning.ManagedGit.GitPackCache"/> class.
             </summary>
         </member>
-        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackNullCache.Add(System.Int64,System.IO.Stream)">
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackNullCache.Add(System.Int64,System.IO.Stream,System.String)">
             <inheritdoc/>
         </member>
-        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackNullCache.TryOpen(System.Int64,System.IO.Stream@)">
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackNullCache.TryOpen(System.Int64,System.Nullable{System.ValueTuple{System.IO.Stream,System.String}}@)">
             <inheritdoc/>
         </member>
         <member name="M:Nerdbank.GitVersioning.ManagedGit.GitPackNullCache.GetCacheStatistics(System.Text.StringBuilder)">
@@ -2204,12 +2301,30 @@
             A <see cref="T:System.String"/> which represents the cache usage statistics.
             </returns>
         </member>
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.LookupTags(Nerdbank.GitVersioning.ManagedGit.GitObjectId)">
+            <summary>
+            Returns a list of canonical names of tags that point to the given Git object id.
+            </summary>
+            <param name="objectId">The git object id to get the corresponding tags for.</param>
+            <returns>A list of canonical names of tags.</returns>
+        </member>
         <member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.ToString">
             <inheritdoc/>
         </member>
         <member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.Dispose">
             <inheritdoc/>
         </member>
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.EnumeratePackedRefsRaw(System.Boolean@)">
+            <summary>
+            Enumerate the lines in the packed-refs file. Skips comment lines.
+            </summary>
+        </member>
+        <member name="M:Nerdbank.GitVersioning.ManagedGit.GitRepository.EnumeratePackedRefsWithPeelLines(System.Boolean@)">
+            <summary>
+            Enumerate the lines in the packed-refs file. If a line has a corresponding peel
+            line, they are returned together.
+            </summary>
+        </member>
         <member name="T:Nerdbank.GitVersioning.ManagedGit.GitSignature">
             <summary>
             Represents the signature of a Git committer or author.
@@ -2557,6 +2672,11 @@
             A git context implemented without any native code dependency.
             </summary>
         </member>
+        <member name="F:Nerdbank.GitVersioning.Managed.ManagedGitContext.headTags">
+            <summary>
+            Caching field behind <see cref="P:Nerdbank.GitVersioning.Managed.ManagedGitContext.HeadTags" /> property.
+            </summary>
+        </member>
         <member name="P:Nerdbank.GitVersioning.Managed.ManagedGitContext.VersionFile">
             <inheritdoc />
         </member>
@@ -2572,6 +2692,9 @@
         <member name="P:Nerdbank.GitVersioning.Managed.ManagedGitContext.HeadCanonicalName">
             <inheritdoc />
         </member>
+        <member name="P:Nerdbank.GitVersioning.Managed.ManagedGitContext.HeadTags">
+            <inheritdoc />
+        </member>
         <member name="M:Nerdbank.GitVersioning.Managed.ManagedGitContext.Create(System.String,System.String)">
             <summary>Initializes a new instance of the <see cref="T:Nerdbank.GitVersioning.Managed.ManagedGitContext"/> class.</summary>
             <param name="path">The path to the .git directory or somewhere in a git working tree.</param>
@@ -2666,6 +2789,9 @@
         <member name="P:Nerdbank.GitVersioning.NoGitContext.HeadCanonicalName">
             <inheritdoc/>
         </member>
+        <member name="P:Nerdbank.GitVersioning.NoGitContext.HeadTags">
+            <inheritdoc/>
+        </member>
         <member name="M:Nerdbank.GitVersioning.NoGitContext.ApplyTag(System.String)">
             <inheritdoc/>
         </member>
@@ -2772,7 +2898,7 @@
             Output information about the release as JSON.
             </summary>
         </member>
-        <member name="M:Nerdbank.GitVersioning.ReleaseManager.PrepareRelease(System.String,System.String,System.Version,System.Nullable{Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement},Nerdbank.GitVersioning.ReleaseManager.ReleaseManagerOutputMode)">
+        <member name="M:Nerdbank.GitVersioning.ReleaseManager.PrepareRelease(System.String,System.String,System.Version,System.Nullable{Nerdbank.GitVersioning.VersionOptions.ReleaseVersionIncrement},Nerdbank.GitVersioning.ReleaseManager.ReleaseManagerOutputMode,System.String)">
             <summary>
             Prepares a release for the specified directory by creating a release branch and incrementing the version in the current branch.
             </summary>
@@ -2797,6 +2923,9 @@
             <param name="outputMode">
             The output format to use for writing to stdout.
             </param>
+            <param name="unformattedCommitMessage">
+            An optional, custom message to use for the commit that sets the new version number. May use <c>{0}</c> to substitute the new version number.
+            </param>
         </member>
         <member name="T:Nerdbank.GitVersioning.ReleaseManager.ReleasePreparationException">
             <summary>
@@ -4354,6 +4483,14 @@
             <summary>
             Gets or sets the ref (branch or tag) being built.
             </summary>
+            <remarks>
+            Just contains a tag if it is known that explicitly this tag is built, e.g. in a cloud build context.
+            </remarks>
+        </member>
+        <member name="P:Nerdbank.GitVersioning.VersionOracle.Tags">
+            <summary>
+            Gets a collection of the tags that reference HEAD.
+            </summary>
         </member>
         <member name="P:Nerdbank.GitVersioning.VersionOracle.Version">
             <summary>