pingcap/tidb

Wrong function comment for `UpdateGlobal`

Open

#61,311 opened on May 26, 2025

View on GitHubContributor guide
 (4 comments) (0 reactions) (1 assignee)Go (6,186 forks)batch import
good first issueseverity/minorsig/sql-infratype/bug

Repository metrics

Stars
 (40,090 stars)
PR merge metrics
 (Avg merge 14d 4h) (346 merged PRs in 30d)

Description

Bug Report

https://github.com/pingcap/tidb/blob/1c6c5ad2acd6d5d2d4eee9b80032181a8f936a65/pkg/config/config.go#L1396-L1402

There's no "restore function" returned by UpdateGlobal. The comment should be updated, or code should be aligned with comment.

Contributor guide

Research direction
Look at the function UpdateGlobal in pkg/config/config.go, lines 1396-1402. Compare the comment with the actual function signature/behavior. If the comment mentions a 'restore function' that is not returned, decide whether to update the comment to match the code or modify the code to match the comment.
Tech stack
go
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90