diff --git a/rocm_smi/docs/README.md b/README.md similarity index 84% rename from rocm_smi/docs/README.md rename to README.md index 554a58df85..81b824c14f 100755 --- a/rocm_smi/docs/README.md +++ b/README.md @@ -3,11 +3,6 @@ The ROCm System Management Interface Library, or ROCm SMI library, is part of the Radeon Open Compute [ROCm](https://github.com/RadeonOpenCompute) software stack . It is a C library for Linux that provides a user space interface for applications to monitor and control GPU applications. -# Important note about Versioning and Backward Compatibility -The ROCm SMI library is currently under development, and therefore subject to change either at the ABI or API level. The intention is to keep the API as stable as possible even while in development, but in some cases we may need to break backwards compatibility in order to ensure future stability and usability. Following [Semantic Versioning](https://semver.org/) rules, while the ROCm SMI library is in high state of change, the major version will remain 0, and backward compatibility is not ensured. - -Once new development has leveled off, the major version will become greater than 0, and backward compatibility will be enforced between major versions. - # Building ROCm SMI #### Additional Required software for building diff --git a/rocm_smi/CMakeLists.txt b/rocm_smi/CMakeLists.txt index f71fe8eb65..d9b087912c 100755 --- a/rocm_smi/CMakeLists.txt +++ b/rocm_smi/CMakeLists.txt @@ -147,7 +147,7 @@ if (DOXYGEN_FOUND AND LATEX_FOUND) add_dependencies(${ROCM_SMI_TARGET} docs) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/latex/refman.pdf DESTINATION ${ROCM_SMI}/docs/${RSMI_MANUAL_NAME}.pdf) - install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/docs/README.md + install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/../README.md DESTINATION ${ROCM_SMI}/docs/) else() message("Doxygen or Latex is not found. Will not generate documents.") diff --git a/rocm_smi/docs/amd_smi_doxygen.cfg b/rocm_smi/docs/amd_smi_doxygen.cfg index a25e8f42f5..a600a361c8 100644 --- a/rocm_smi/docs/amd_smi_doxygen.cfg +++ b/rocm_smi/docs/amd_smi_doxygen.cfg @@ -758,7 +758,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/docs/README.md \ +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../README.md \ @CMAKE_CURRENT_SOURCE_DIR@/../include/rocm_smi/rocm_smi.h # This tag can be used to specify the character encoding of the source files