Skip to content

Add comments/notation to IsMountWithConfigMap in pkg/ddc/alluxio/ufs.go. #5724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wiumoo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add comments/notation to IsMountWithConfigMap in pkg/ddc/alluxio/ufs.go. #5724

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions pkg/ddc/alluxio/ufs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ import (
"os"
)

// IsMountWithConfigMap checks if the mount configuration is stored in a ConfigMap.
// It looks up the environment variable MountConfigStorage and compares it to ConfigmapStorageName.
// If the environment variable is set and matches, it returns true; otherwise, it returns the default value true.
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The description of the function's behavior is not entirely accurate. It omits the case where the environment variable is set but does not match ConfigmapStorageName, in which the function would return false. This can be misleading to developers reading the code. A more precise comment would improve clarity.

Suggested change
// If the environment variable is set and matches, it returns true; otherwise, it returns the default value true.
// If the environment variable is set, it returns true if the value matches ConfigmapStorageName, and false otherwise. If the variable is not set, it defaults to true.

func IsMountWithConfigMap() bool {
if envVal, exists := os.LookupEnv(MountConfigStorage); exists {
return envVal == ConfigmapStorageName
Expand Down
Loading