big-data/hadoop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

HADOOP-14066 VersionInfo should be marked as public API

Browse Source
This commit is contained in:
Steve Loughran 2017-04-08 13:41:10 +01:00
parent 612578fe67
commit 2ed65540a3
No known key found for this signature in database
GPG Key ID: 950CC3E032B79CA2
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/VersionInfo.java
View File

@ -31,8 +31,8 @@
/** /**
* This class returns build information about Hadoop components. * This class returns build information about Hadoop components.
*/ */
@InterfaceAudience.Private @InterfaceAudience.Public
@InterfaceStability.Unstable @InterfaceStability.Stable
public class VersionInfo { public class VersionInfo {
private static final Log LOG = LogFactory.getLog(VersionInfo.class); private static final Log LOG = LogFactory.getLog(VersionInfo.class);
@ -102,8 +102,8 @@ public static String getVersion() {
} }
/** /**
* Get the subversion revision number for the root directory * Get the Git commit hash of the repository when compiled.
* @return the revision number, eg. "451451" * @return the commit hash, eg. "18f64065d5db6208daf50b02c1b5ed4ee3ce547a"
*/ */
public static String getRevision() { public static String getRevision() {
return COMMON_VERSION_INFO._getRevision(); return COMMON_VERSION_INFO._getRevision();
@ -124,7 +124,7 @@ public static String getBranch() {
public static String getDate() { public static String getDate() {
return COMMON_VERSION_INFO._getDate(); return COMMON_VERSION_INFO._getDate();
} }
/** /**
* The user that compiled Hadoop. * The user that compiled Hadoop.
* @return the username of the user * @return the username of the user
@ -132,25 +132,27 @@ public static String getDate() {
public static String getUser() { public static String getUser() {
return COMMON_VERSION_INFO._getUser(); return COMMON_VERSION_INFO._getUser();
} }
/** /**
* Get the subversion URL for the root Hadoop directory. * Get the URL for the Hadoop repository.
* @return the URL of the Hadoop repository
*/ */
public static String getUrl() { public static String getUrl() {
return COMMON_VERSION_INFO._getUrl(); return COMMON_VERSION_INFO._getUrl();
} }
/** /**
* Get the checksum of the source files from which Hadoop was * Get the checksum of the source files from which Hadoop was built.
* built. * @return the checksum of the source files
**/ */
public static String getSrcChecksum() { public static String getSrcChecksum() {
return COMMON_VERSION_INFO._getSrcChecksum(); return COMMON_VERSION_INFO._getSrcChecksum();
} }
/** /**
* Returns the buildVersion which includes version, * Returns the buildVersion which includes version,
* revision, user and date. * revision, user and date.
* @return the buildVersion
*/ */
public static String getBuildVersion(){ public static String getBuildVersion(){
return COMMON_VERSION_INFO._getBuildVersion(); return COMMON_VERSION_INFO._getBuildVersion();
@ -158,6 +160,7 @@ public static String getBuildVersion(){
/** /**
* Returns the protoc version used for the build. * Returns the protoc version used for the build.
* @return the protoc version
*/ */
public static String getProtocVersion(){ public static String getProtocVersion(){
return COMMON_VERSION_INFO._getProtocVersion(); return COMMON_VERSION_INFO._getProtocVersion();