AI/rocm-systems
2
0
Vork 0
Code Kwesties Pull-aanvragen Actions Paketten Projecten Publicaties Wiki Activiteit

Run pre-commit's whitespace related hooks on projects/rocm-core (#2127)

Bladeren bron 
In order for pre-commit to be useful, everything needs to meet a common
baseline.

Signed-off-by: Mario Limonciello (AMD) <superm1@kernel.org>
This commit is contained in:
Mario Limonciello
2025-12-07 12:29:38 -06:00
gecommit door GitHub
bovenliggende 659737c824
commit b958ce88c2
6 gewijzigde bestanden met toevoegingen van 60 en 60 verwijderingen
Download Patch-bestand Download Diff-bestand Expand all files Collapse all files
projects/rocm-core/.github/workflows/rocm_ci_caller.yml
Vendored
+21 -21
Bestand weergeven
@@ -1,26 +1,26 @@
name: ROCm CI Caller name: ROCm CI Caller
on: on:
# Commenting below to avoid re-runs of amd smi for trivial rebases # Commenting below to avoid re-runs of amd smi for trivial rebases
pull_request: pull_request:
branches: [release/rocm-rel-*, amd-mainline] branches: [release/rocm-rel-*, amd-mainline]
types: [opened, reopened, synchronize] types: [opened, reopened, synchronize]
push: push:
branches: [amd-mainline] branches: [amd-mainline]
workflow_dispatch: workflow_dispatch:
issue_comment: issue_comment:
types: [created] types: [created]
jobs: jobs:
call-workflow: call-workflow:
if: github.event_name != 'issue_comment' ||(github.event_name == 'issue_comment' && github.event.issue.pull_request && (startsWith(github.event.comment.body, '!verify') || startsWith(github.event.comment.body, '!verify release') || startsWith(github.event.comment.body, '!verify retest'))) if: github.event_name != 'issue_comment' ||(github.event_name == 'issue_comment' && github.event.issue.pull_request && (startsWith(github.event.comment.body, '!verify') || startsWith(github.event.comment.body, '!verify release') || startsWith(github.event.comment.body, '!verify retest')))
uses: AMD-ROCm-Internal/rocm_ci_infra/.github/workflows/rocm_ci.yml@mainline uses: AMD-ROCm-Internal/rocm_ci_infra/.github/workflows/rocm_ci.yml@mainline
secrets: inherit secrets: inherit
with: with:
input_sha: ${{github.event_name == 'pull_request' && github.event.pull_request.head.sha || (github.event_name == 'push' && github.sha) || (github.event_name == 'issue_comment' && github.event.issue.pull_request.head.sha) || github.sha}} input_sha: ${{github.event_name == 'pull_request' && github.event.pull_request.head.sha || (github.event_name == 'push' && github.sha) || (github.event_name == 'issue_comment' && github.event.issue.pull_request.head.sha) || github.sha}}
input_pr_num: ${{github.event_name == 'pull_request' && github.event.pull_request.number || (github.event_name == 'issue_comment' && github.event.issue.number) || 0}} input_pr_num: ${{github.event_name == 'pull_request' && github.event.pull_request.number || (github.event_name == 'issue_comment' && github.event.issue.number) || 0}}
input_pr_url: ${{github.event_name == 'pull_request' && github.event.pull_request.html_url || (github.event_name == 'issue_comment' && github.event.issue.pull_request.html_url) || ''}} input_pr_url: ${{github.event_name == 'pull_request' && github.event.pull_request.html_url || (github.event_name == 'issue_comment' && github.event.issue.pull_request.html_url) || ''}}
input_pr_title: ${{github.event_name == 'pull_request' && github.event.pull_request.title || (github.event_name == 'issue_comment' && github.event.issue.pull_request.title) || ''}} input_pr_title: ${{github.event_name == 'pull_request' && github.event.pull_request.title || (github.event_name == 'issue_comment' && github.event.issue.pull_request.title) || ''}}
repository_name: ${{ github.repository }} repository_name: ${{ github.repository }}
base_ref: ${{github.event_name == 'pull_request' && github.event.pull_request.base.ref || (github.event_name == 'issue_comment' && github.event.issue.pull_request.base.ref) || github.ref}} base_ref: ${{github.event_name == 'pull_request' && github.event.pull_request.base.ref || (github.event_name == 'issue_comment' && github.event.issue.pull_request.base.ref) || github.ref}}
trigger_event_type: ${{ github.event_name }} trigger_event_type: ${{ github.event_name }}
comment_text: ${{ github.event_name == 'issue_comment' && github.event.comment.body || '' }} comment_text: ${{ github.event_name == 'issue_comment' && github.event.comment.body || '' }}
projects/rocm-core/CMakeLists.txt
+1 -1
Bestand weergeven
@@ -321,7 +321,7 @@ set ( CPACK_RPM_CORE_STATIC_POST_UNINSTALL_SCRIPT_FILE "${BUILD_DIR}/prerm" )
set ( CPACK_RPM_PACKAGE_DESCRIPTION "${EXTENDED_PACKAGE_DESCRIPTION}" ) set ( CPACK_RPM_PACKAGE_DESCRIPTION "${EXTENDED_PACKAGE_DESCRIPTION}" )
if ( DEFINED CPACK_PACKAGING_INSTALL_PREFIX ) if ( DEFINED CPACK_PACKAGING_INSTALL_PREFIX )
set ( CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION set ( CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION
"${CPACK_PACKAGING_INSTALL_PREFIX} ${CPACK_PACKAGING_INSTALL_PREFIX}/.info" ) "${CPACK_PACKAGING_INSTALL_PREFIX} ${CPACK_PACKAGING_INSTALL_PREFIX}/.info" )
endif() endif()
projects/rocm-core/CONTRIBUTING.md
+32 -32
Bestand weergeven
@@ -1,6 +1,6 @@
# ROCM-CORE Contributing Guide # ROCM-CORE Contributing Guide
To ensure the quality of the ROCM-CORE code base, the ROCM-CORE team has To ensure the quality of the ROCM-CORE code base, the ROCM-CORE team has
established a code review process to inform developers of the steps established a code review process to inform developers of the steps
that are required to shepherd a change-set into the repository. that are required to shepherd a change-set into the repository.
#### Table Of Contents #### Table Of Contents
@@ -19,14 +19,14 @@ that are required to shepherd a change-set into the repository.
[References](#References) [References](#References)
## How to get started ## How to get started
rocm-core is a utility which can be used to get ROCm release version. rocm-core is a utility which can be used to get ROCm release version.
It also provides the Lmod modules files for the ROCm release. It also provides the Lmod modules files for the ROCm release.
getROCmVersion function provides the ROCm version. getROCmVersion function provides the ROCm version.
## How do I contribute ## How do I contribute
### Deliverables ### Deliverables
All contributions you make will be under the [MIT Software License](copyright). All contributions you make will be under the [MIT Software License](copyright).
For each new file in repository, For each new file in repository,
Please include the licensing header Please include the licensing header
``` ```
/******************************************************************************* /*******************************************************************************
@@ -64,7 +64,7 @@ All the code is formatted using `clang-format`. To format a file, use:
clang-format-10 -style=file -i <path-to-source-file> clang-format-10 -style=file -i <path-to-source-file>
``` ```
### Reporting Issues ### Reporting Issues
We use [GitHub Issues](https://github.com/ROCm/rocm-core/issues) to track public **bugs** and **enhancement requests**. We use [GitHub Issues](https://github.com/ROCm/rocm-core/issues) to track public **bugs** and **enhancement requests**.
@@ -90,26 +90,26 @@ Please follow the template below to report any enhancement requests for ROCM-COR
The author must set labels (and assigns a milestone) according to his/her own understanding. The author must set labels (and assigns a milestone) according to his/her own understanding.
Other contributors can change these values if they disagree. That being said, Other contributors can change these values if they disagree. That being said,
adding a small comment explaining the motivation is highly recommended. adding a small comment explaining the motivation is highly recommended.
In this way, we keep the process flexible while cultivating mutual understanding. In this way, we keep the process flexible while cultivating mutual understanding.
[**Note**] Most likely, the labels like "bug", "feature" or "complexity*" [**Note**] Most likely, the labels like "bug", "feature" or "complexity*"
would not be changed. However, "value*" or "urgency*" might be from mutual would not be changed. However, "value*" or "urgency*" might be from mutual
understanding. understanding.
### Creating a Pull Request ### Creating a Pull Request
No changes are allowed to be directly committed to the develop No changes are allowed to be directly committed to the develop
branch of the ROCM-CORE repository. All authors are required to branch of the ROCM-CORE repository. All authors are required to
develop their change sets on a separate branch and then create develop their change sets on a separate branch and then create
a pull request (PR) to merge their changes into the develop branch. a pull request (PR) to merge their changes into the develop branch.
Once a PR has been created, a developer must choose two reviewers Once a PR has been created, a developer must choose two reviewers
to review the changes made. The first reviewer should be a to review the changes made. The first reviewer should be a
technical expert in the portion of the library that the changes technical expert in the portion of the library that the changes
are being made in. You can find a list of these experts in are being made in. You can find a list of these experts in
[CODEOWNERS](CODEOWNERS) list. [CODEOWNERS](CODEOWNERS) list.
The second reviewer should be a peer reviewer. This reviewer The second reviewer should be a peer reviewer. This reviewer
can be any other ROCM-CORE developer. can be any other ROCM-CORE developer.
## Responsibility of the Author ## Responsibility of the Author
@@ -121,38 +121,38 @@ The author of a PR is responsible for:
* Report on the impact to performance * Report on the impact to performance
## Responsibility of the Reviewer ## Responsibility of the Reviewer
Each reviewer is responsible for verifying that the changes are Each reviewer is responsible for verifying that the changes are
clearly written in keeping with the coding styles of the library, clearly written in keeping with the coding styles of the library,
are documented in a way that future developers will be able to are documented in a way that future developers will be able to
understand the intent of the added functionality, and will understand the intent of the added functionality, and will
maintain or improve the overall quality of the codebase. maintain or improve the overall quality of the codebase.
Reviewer's task checklist: Reviewer's task checklist:
1. Has the PR passed? 1. Has the PR passed?
2. Does the PR consist of a well-organized sequence of small commits, 2. Does the PR consist of a well-organized sequence of small commits,
each of which is designed to make one specific feature or fix ? each of which is designed to make one specific feature or fix ?
3. Does the PR only include a reviewable amount of changes? Or it is a 3. Does the PR only include a reviewable amount of changes? Or it is a
consolidation of already reviewed small batches? e.g. break it into smaller consolidation of already reviewed small batches? e.g. break it into smaller
testable and reviewable tasks instead of a huge chunk at once. testable and reviewable tasks instead of a huge chunk at once.
4. Does the PR have sufficient documentation and easy to read and understand, 4. Does the PR have sufficient documentation and easy to read and understand,
feasible for test and future maintainence, related docs already in place? feasible for test and future maintainence, related docs already in place?
if API or functionality has changed? if API or functionality has changed?
5. For bugfixes and new features, new regression test created? 5. For bugfixes and new features, new regression test created?
6. Is every PR associated with a ticket or issue number for tracking purposes? 6. Is every PR associated with a ticket or issue number for tracking purposes?
## The Review ## The Review
During the review, reviewers will look over the changes and make During the review, reviewers will look over the changes and make
suggestions or requests for changes. suggestions or requests for changes.
In order to assist the reviewer in prioritizing their efforts, In order to assist the reviewer in prioritizing their efforts,
authors can take the following actions: authors can take the following actions:
* Set the urgency and value labels * Set the urgency and value labels
* Set the milestone where the changes need to be delivered * Set the milestone where the changes need to be delivered
* Describe the testing procedure and post the measured effect of * Describe the testing procedure and post the measured effect of
the change the change
* Remind reviewers via email if a PR needs attention * Remind reviewers via email if a PR needs attention
* If a PR needs to be reviewed as soon as possible, explain to * If a PR needs to be reviewed as soon as possible, explain to
the reviewers why a review may need to take priority the reviewers why a review may need to take priority
## References ## References
projects/rocm-core/README.md
+2 -2
Bestand weergeven
@@ -4,13 +4,13 @@ ROCM-CORE is a package which can be used to get ROCm release version, get ROCm i
It is also important to note that ROCM-CORE takes the role as a base component on which all of ROCm can depend, It is also important to note that ROCM-CORE takes the role as a base component on which all of ROCm can depend,
to make it easy to remove all of ROCm with a package manager. to make it easy to remove all of ROCm with a package manager.
getROCmVersion function provides the ROCm version. getROCmVersion function provides the ROCm version.
It also provides an example Lmod modules files for the ROCm release. It also provides an example Lmod modules files for the ROCm release.
Lmod module files can be loaded with the following commands. Lmod module files can be loaded with the following commands.
``` shell ``` shell
module load rocm/x.y or module load rocm/x.y or
module load rocm module load rocm
``` ```
projects/rocm-core/rocm_version.cpp
+1 -1
Bestand weergeven
@@ -1,5 +1,5 @@
//Copyright © Advanced Micro Devices, Inc., or its affiliates. //Copyright © Advanced Micro Devices, Inc., or its affiliates.
//SPDX-License-Identifier: MIT //SPDX-License-Identifier: MIT
projects/rocm-core/utils.cmake
+3 -3
Bestand weergeven
@@ -202,7 +202,7 @@ function( configure_debian_pkg PACKAGE_NAME_T COMPONENT_NAME_T PACKAGE_VERSION_T
) )
endif() endif()
# Install Change Log # Install Change Log
find_program ( DEB_GZIP_EXEC gzip ) find_program ( DEB_GZIP_EXEC gzip )
if(EXISTS "${CMAKE_BINARY_DIR}/DEBIAN/changelog.Debian" ) if(EXISTS "${CMAKE_BINARY_DIR}/DEBIAN/changelog.Debian" )
execute_process( execute_process(
@@ -228,7 +228,7 @@ function( configure_debian_pkg PACKAGE_NAME_T COMPONENT_NAME_T PACKAGE_VERSION_T
endfunction() endfunction()
# Set variables for changelog and copyright # Set variables for changelog and copyright
# For Debian specific Packages # For Debian specific Packages
function( set_debian_pkg_cmake_flags DEB_PACKAGE_NAME_T DEB_PACKAGE_VERSION_T DEB_MAINTAINER_NM_T DEB_MAINTAINER_EMAIL_T ) function( set_debian_pkg_cmake_flags DEB_PACKAGE_NAME_T DEB_PACKAGE_VERSION_T DEB_MAINTAINER_NM_T DEB_MAINTAINER_EMAIL_T )
# Setting configure flags # Setting configure flags
set( DEB_PACKAGE_NAME "${DEB_PACKAGE_NAME_T}" CACHE STRING "Debian Package Name" ) set( DEB_PACKAGE_NAME "${DEB_PACKAGE_NAME_T}" CACHE STRING "Debian Package Name" )
@@ -237,7 +237,7 @@ function( set_debian_pkg_cmake_flags DEB_PACKAGE_NAME_T DEB_PACKAGE_VERSION_T DE
set( DEB_MAINTAINER_EMAIL "${DEB_MAINTAINER_EMAIL_T}" CACHE STRING "Debian Package Maintainer Email" ) set( DEB_MAINTAINER_EMAIL "${DEB_MAINTAINER_EMAIL_T}" CACHE STRING "Debian Package Maintainer Email" )
set( DEB_COPYRIGHT_YEAR "2025" CACHE STRING "Debian Package Copyright Year" ) set( DEB_COPYRIGHT_YEAR "2025" CACHE STRING "Debian Package Copyright Year" )
set( DEB_LICENSE "MIT" CACHE STRING "Debian Package License Type" ) set( DEB_LICENSE "MIT" CACHE STRING "Debian Package License Type" )
set( DEB_CHANGELOG_INSTALL_FILENM "changelog.Debian.gz" CACHE STRING "Debian Package ChangeLog File Name" ) set( DEB_CHANGELOG_INSTALL_FILENM "changelog.Debian.gz" CACHE STRING "Debian Package ChangeLog File Name" )
if( BUILD_ENABLE_LINTIAN_OVERRIDES ) if( BUILD_ENABLE_LINTIAN_OVERRIDES )
set( DEB_OVERRIDES_INSTALL_FILENM "${DEB_PACKAGE_NAME}" CACHE STRING "Debian Package Lintian Override File Name" ) set( DEB_OVERRIDES_INSTALL_FILENM "${DEB_PACKAGE_NAME}" CACHE STRING "Debian Package Lintian Override File Name" )