Skip to content

Add comments to SyncDatasetMounts in pkg/ddc/alluxio/ufs.go. #5992

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
xxt2004 wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −0
Open

Add comments to SyncDatasetMounts in pkg/ddc/alluxio/ufs.go. #5992

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
12 changes: 12 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 @@ -233,6 +233,18 @@ func (e *AlluxioEngine) ShouldSyncDatasetMounts() (should bool, err error) {
return false, nil
}

// SyncDatasetMounts synchronizes the dataset mount points with the Alluxio runtime.

@cheyang cheyang Jun 15, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The comment describes complex synchronization behavior (mounting new UFS paths, unmounting removed paths, updating configurations), but the function body is return nil -- it is a no-op stub. This will mislead readers into thinking the function performs actual work.

Consider updating the comment to reflect the current implementation, e.g.:

// SyncDatasetMounts is a no-op for the Alluxio engine.
// Mount synchronization is not currently required for Alluxio runtimes.

Or if the intent is to document the interface contract, note explicitly that this is a placeholder.

// This function is responsible for applying mount configuration changes detected
// in the dataset specification to the running Alluxio cluster. Typical operations
// may include mounting newly added UFS paths, unmounting removed paths, and
// updating existing mount configurations to ensure consistency between the
// dataset definition and the actual runtime state.
//
// Parameters:
//
// Returns:
Comment on lines +242 to +245

@gemini-code-assist gemini-code-assist Bot Jun 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The 'Parameters:' section is empty because the 'SyncDatasetMounts' function does not accept any arguments. It is cleaner and more idiomatic in Go to omit empty documentation sections.

Suggested change
//
// Parameters:
//
// Returns:
//
// Returns:

// - err (error): Returns an error if the synchronization process fails;
// otherwise returns nil.
func (e *AlluxioEngine) SyncDatasetMounts() (err error) {
return nil
}