You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/Nerdbank/GitVersioning/GitExtensions.md
+5-14Lines changed: 5 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,20 +16,11 @@ public static class GitExtensions
16
16
## Methods
17
17
|Name|Description|
18
18
|---|---|
19
-
|[GetVersionHeight(Commit, String, Version)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetVersionHeight_Commit%2c%20String%2c%20Version_.md)|Gets the number of commits in the longest single path between
20
-
the specified commit and the most distant ancestor (inclusive)
21
-
that set the version to the value at .|
22
-
|[GetVersionHeight(Repository, String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetVersionHeight_Repository%2c%20String_.md)|Gets the number of commits in the longest single path between
23
-
HEAD in a repo and the most distant ancestor (inclusive)
24
-
that set the version to the value in the working copy
25
-
(orHEADforbare repositories).|
26
-
|[GetVersionHeight(Branch, String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetVersionHeight_Branch%2c%20String_.md)|Gets the number of commits in the longest single path between
27
-
the specified commit and the most distant ancestor (inclusive)
28
-
that set the version to the value at the tip of the .|
29
-
|[GetTruncatedCommitIdAsInt32(Commit)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetTruncatedCommitIdAsInt32_Commit_.md)|Takes the first 4 bytes of a commit ID (i.e. first 8 charactersofitshex-encodedSHA)
30
-
and returns them as an integer.|
31
-
|[GetTruncatedCommitIdAsUInt16(Commit)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetTruncatedCommitIdAsUInt16_Commit_.md)|Takes the first 2 bytes of a commit ID (i.e. first 4 charactersofitshex-encodedSHA)
32
-
and returns them as an 16-bit unsigned integer.|
19
+
|[GetVersionHeight(Commit, String, Version)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetVersionHeight_Commit%2c%20String%2c%20Version_.md)|Gets the number of commits in the longest single path between the specified commit and the most distant ancestor (inclusive) that set the version to the value at .|
20
+
|[GetVersionHeight(Repository, String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetVersionHeight_Repository%2c%20String_.md)|Gets the number of commits in the longest single path between HEAD in a repo and the most distant ancestor (inclusive) that set the version to the value in the working copy (orHEADforbare repositories).|
21
+
|[GetVersionHeight(Branch, String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetVersionHeight_Branch%2c%20String_.md)|Gets the number of commits in the longest single path between the specified commit and the most distant ancestor (inclusive) that set the version to the value at the tip of the .|
22
+
|[GetTruncatedCommitIdAsInt32(Commit)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetTruncatedCommitIdAsInt32_Commit_.md)|Takes the first 4 bytes of a commit ID (i.e. first 8 charactersofitshex-encodedSHA) and returns them as an integer.|
23
+
|[GetTruncatedCommitIdAsUInt16(Commit)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetTruncatedCommitIdAsUInt16_Commit_.md)|Takes the first 2 bytes of a commit ID (i.e. first 4 charactersofitshex-encodedSHA) and returns them as an 16-bit unsigned integer.|
33
24
|[GetCommitFromTruncatedIdInteger(Repository, Int32)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetCommitFromTruncatedIdInteger_Repository%2c%20Int32_.md)|Looks up a commit by an integer that captures the first for bytes of its ID.|
34
25
|[GetCommitFromVersion(Repository, Version, String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetCommitFromVersion_Repository%2c%20Version%2c%20String_.md)|Looks up the commit that matches a specified version number.|
35
26
|[GetCommitsFromVersion(Repository, Version, String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetCommitsFromVersion_Repository%2c%20Version%2c%20String_.md)|Looks up the commits that match a specified version number.|
> Gets the number of commits in the longest single path between
3
-
the specified commit and the most distant ancestor (inclusive)
4
-
that set the version to the value at the tip of the .
2
+
> Gets the number of commits in the longest single path between the specified commit and the most distant ancestor (inclusive) that set the version to the value at the tip of the .
> Gets the number of commits in the longest single path between
3
-
the specified commit and the most distant ancestor (inclusive)
4
-
that set the version to the value at .
2
+
> Gets the number of commits in the longest single path between the specified commit and the most distant ancestor (inclusive) that set the version to the value at .
> Gets the number of commits in the longest single path between
3
-
HEAD in a repo and the most distant ancestor (inclusive)
4
-
that set the version to the value in the working copy
5
-
(or HEAD for bare repositories).
2
+
> Gets the number of commits in the longest single path between HEAD in a repo and the most distant ancestor (inclusive) that set the version to the value in the working copy (or HEAD for bare repositories).
Copy file name to clipboardExpand all lines: doc/Nerdbank/GitVersioning/VersionExtensions.md
+2-4Lines changed: 2 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,5 @@ public static class VersionExtensions
16
16
## Methods
17
17
|Name|Description|
18
18
|---|---|
19
-
|[EnsureNonNegativeComponents(Version, Int32)](/doc/Nerdbank/GitVersioning/VersionExtensions/Methods/EnsureNonNegativeComponents_Version%2c%20Int32_.md)|Returns a instance where the specified number of components
20
-
are guaranteed to be non-negative. Any applicable negative components are converted to zeros.|
21
-
|[ToStringSafe(Version, Int32)](/doc/Nerdbank/GitVersioning/VersionExtensions/Methods/ToStringSafe_Version%2c%20Int32_.md)|Converts the value of the current System.Version object to its equivalent System.String
22
-
representation. A specified count indicates the number of components to return.|
19
+
|[EnsureNonNegativeComponents(Version, Int32)](/doc/Nerdbank/GitVersioning/VersionExtensions/Methods/EnsureNonNegativeComponents_Version%2c%20Int32_.md)|Returns a instance where the specified number of components are guaranteed to be non-negative. Any applicable negative components are converted to zeros.|
20
+
|[ToStringSafe(Version, Int32)](/doc/Nerdbank/GitVersioning/VersionExtensions/Methods/ToStringSafe_Version%2c%20Int32_.md)|Converts the value of the current System.Version object to its equivalent System.String representation. A specified count indicates the number of components to return.|
> Returns a instance where the specified number of components
3
-
are guaranteed to be non-negative. Any applicable negative components are converted to zeros.
2
+
> Returns a instance where the specified number of components are guaranteed to be non-negative. Any applicable negative components are converted to zeros.
> Converts the value of the current System.Version object to its equivalent System.String
3
-
representation. A specified count indicates the number of components to return.
2
+
> Converts the value of the current System.Version object to its equivalent System.String representation. A specified count indicates the number of components to return.
Copy file name to clipboardExpand all lines: doc/Nerdbank/GitVersioning/VersionFile.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,8 +20,7 @@ public static class VersionFile
20
20
|[GetVersion(Repository, String)](/doc/Nerdbank/GitVersioning/VersionFile/Methods/GetVersion_Repository%2c%20String_.md)|Reads the version.txt file and returns the and prerelease tag from it.|
21
21
|[GetVersion(String)](/doc/Nerdbank/GitVersioning/VersionFile/Methods/GetVersion_String_.md)|Reads the version.txt file and returns the and prerelease tag from it.|
22
22
|[IsVersionDefined(Commit, String)](/doc/Nerdbank/GitVersioning/VersionFile/Methods/IsVersionDefined_Commit%2c%20String_.md)|Checks whether the version.txt file is defined in the specified commit.|
23
-
|[IsVersionDefined(String)](/doc/Nerdbank/GitVersioning/VersionFile/Methods/IsVersionDefined_String_.md)|Checks whether the version.txt file is defined in the specified project directory
24
-
or one of its ancestors.|
23
+
|[IsVersionDefined(String)](/doc/Nerdbank/GitVersioning/VersionFile/Methods/IsVersionDefined_String_.md)|Checks whether the version.txt file is defined in the specified project directory or one of its ancestors.|
25
24
|[SetVersion(String, VersionOptions)](/doc/Nerdbank/GitVersioning/VersionFile/Methods/SetVersion_String%2c%20VersionOptions_.md)|Writes the version.json file to a directory within a repo with the specified version information.|
26
25
|[SetVersion(String, Version, String)](/doc/Nerdbank/GitVersioning/VersionFile/Methods/SetVersion_String%2c%20Version%2c%20String_.md)|Writes the version.txt file to a directory within a repo with the specified version information.|
0 commit comments