Skip to content

Commit

Permalink
lint: Remove space after nolint:
Browse files Browse the repository at this point in the history
With recent changes `gofmt` [1] started reformatting godoc comments.
This causes a problem wherein it reformats `//nolint: staticcheck` to
`// nolint: staticcheck`.

But it does ignore directives [2]. So let's change all our nolint to
directive format. This avoids the conflict with `gofmt`.

This fix was done by running:
`grep -r --include="*.go" -E "//nolint: .*" -l | xargs sed -i 's/nolint:
stylecheck/nolint:stylecheck/g'`
as such, we can skip it from review.

[1]:
golangci/golangci-lint#1658 (comment)
[2]:
golangci/golangci-lint#3098 (comment)
  • Loading branch information
Karthik Nayak committed Sep 30, 2022
1 parent 857a17a commit 4325323
Show file tree
Hide file tree
Showing 50 changed files with 106 additions and 106 deletions.
2 changes: 1 addition & 1 deletion auth/token.go
Expand Up @@ -18,7 +18,7 @@ import (
)

var (
//nolint: gochecknoglobals
//nolint:gochecknoglobals
// This infrastructure is required for testing purposes and there is no
// proper place to put it instead. While we could move it into the
// config, we certainly don't want to make it configurable for now, so
Expand Down
2 changes: 1 addition & 1 deletion client/pool_options.go
Expand Up @@ -7,7 +7,7 @@ type poolOptions struct {
dialOptions []grpc.DialOption
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
type PoolOption func(*poolOptions)

func applyPoolOptions(options []PoolOption) *poolOptions {
Expand Down
6 changes: 3 additions & 3 deletions internal/cgroups/noop.go
Expand Up @@ -9,17 +9,17 @@ import (
// NoopManager is a cgroups manager that does nothing
type NoopManager struct{}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (cg *NoopManager) Setup() error {
return nil
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (cg *NoopManager) AddCommand(cmd *command.Command, repo repository.GitRepo) (string, error) {
return "", nil
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (cg *NoopManager) Cleanup() error {
return nil
}
Expand Down
4 changes: 2 additions & 2 deletions internal/cgroups/v1_linux.go
Expand Up @@ -56,7 +56,7 @@ func newV1Manager(cfg cgroupscfg.Config, pid int) *CGroupV1Manager {
}
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (cg *CGroupV1Manager) Setup() error {
var parentResources specs.LinuxResources

Expand Down Expand Up @@ -200,7 +200,7 @@ func (cg *CGroupV1Manager) Describe(ch chan<- *prometheus.Desc) {
prometheus.DescribeByCollect(cg, ch)
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (cg *CGroupV1Manager) Cleanup() error {
processCgroupPath := cg.currentProcessCgroup()

Expand Down
12 changes: 6 additions & 6 deletions internal/command/stats.go
Expand Up @@ -9,13 +9,13 @@ import (

type requestStatsKey struct{}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
type Stats struct {
registry map[string]int
sync.Mutex
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (stats *Stats) RecordSum(key string, value int) {
stats.Lock()
defer stats.Unlock()
Expand All @@ -27,7 +27,7 @@ func (stats *Stats) RecordSum(key string, value int) {
stats.registry[key] = value
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (stats *Stats) RecordMax(key string, value int) {
stats.Lock()
defer stats.Unlock()
Expand All @@ -41,7 +41,7 @@ func (stats *Stats) RecordMax(key string, value int) {
stats.registry[key] = value
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (stats *Stats) Fields() logrus.Fields {
stats.Lock()
defer stats.Unlock()
Expand All @@ -53,13 +53,13 @@ func (stats *Stats) Fields() logrus.Fields {
return f
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func StatsFromContext(ctx context.Context) *Stats {
stats, _ := ctx.Value(requestStatsKey{}).(*Stats)
return stats
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func InitContextStats(ctx context.Context) context.Context {
return context.WithValue(ctx, requestStatsKey{}, &Stats{
registry: make(map[string]int),
Expand Down
4 changes: 2 additions & 2 deletions internal/git/stats/packfile_negotiation.go
Expand Up @@ -11,7 +11,7 @@ import (
"gitlab.com/gitlab-org/gitaly/v15/internal/helper/text"
)

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
type PackfileNegotiation struct {
// Total size of all pktlines' data
PayloadSize int64
Expand All @@ -31,7 +31,7 @@ type PackfileNegotiation struct {
Filter string
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func ParsePackfileNegotiation(body io.Reader) (PackfileNegotiation, error) {
n := PackfileNegotiation{}
return n, n.Parse(body)
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/config/config.go
Expand Up @@ -92,7 +92,7 @@ type Hooks struct {
CustomHooksDir string `toml:"custom_hooks_dir" json:"custom_hooks_dir"`
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
type HTTPSettings struct {
ReadTimeout int `toml:"read_timeout" json:"read_timeout"`
User string `toml:"user" json:"user"`
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/hook/check.go
Expand Up @@ -6,7 +6,7 @@ import (
"gitlab.com/gitlab-org/gitaly/v15/internal/gitlab"
)

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (m *GitLabHookManager) Check(ctx context.Context) (*gitlab.CheckInfo, error) {
return m.gitlabClient.Check(ctx)
}
2 changes: 1 addition & 1 deletion internal/gitaly/hook/postreceive.go
Expand Up @@ -116,7 +116,7 @@ func printAlert(m gitlab.PostReceiveMessage, w io.Writer) error {
return nil
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (m *GitLabHookManager) PostReceiveHook(ctx context.Context, repo *gitalypb.Repository, pushOptions, env []string, stdin io.Reader, stdout, stderr io.Writer) error {
payload, err := git.HooksPayloadFromEnv(env)
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/hook/referencetransaction.go
Expand Up @@ -16,7 +16,7 @@ import (
// reference without checking its current value.
var forceDeletionPrefix = fmt.Sprintf("%[1]s %[1]s ", git.ObjectHashSHA1.ZeroOID.String())

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (m *GitLabHookManager) ReferenceTransactionHook(ctx context.Context, state ReferenceTransactionState, env []string, stdin io.Reader) error {
payload, err := git.HooksPayloadFromEnv(env)
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/hook/update.go
Expand Up @@ -11,7 +11,7 @@ import (
"gitlab.com/gitlab-org/gitaly/v15/proto/go/gitalypb"
)

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (m *GitLabHookManager) UpdateHook(ctx context.Context, repo *gitalypb.Repository, ref, oldValue, newValue string, env []string, stdout, stderr io.Writer) error {
payload, err := git.HooksPayloadFromEnv(env)
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/service/operations/apply_patch.go
Expand Up @@ -33,7 +33,7 @@ func (er gitError) Error() string {
return er.ErrMsg + ": " + er.Err.Error()
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s *Server) UserApplyPatch(stream gitalypb.OperationService_UserApplyPatchServer) error {
firstRequest, err := stream.Recv()
if err != nil {
Expand Down
4 changes: 2 additions & 2 deletions internal/gitaly/service/operations/branches.go
Expand Up @@ -13,7 +13,7 @@ import (
"google.golang.org/grpc/status"
)

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s *Server) UserCreateBranch(ctx context.Context, req *gitalypb.UserCreateBranchRequest) (*gitalypb.UserCreateBranchResponse, error) {
if len(req.BranchName) == 0 {
return nil, status.Errorf(codes.InvalidArgument, "Bad Request (empty branch name)")
Expand Down Expand Up @@ -117,7 +117,7 @@ func validateUserUpdateBranchGo(req *gitalypb.UserUpdateBranchRequest) error {
return nil
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s *Server) UserUpdateBranch(ctx context.Context, req *gitalypb.UserUpdateBranchRequest) (*gitalypb.UserUpdateBranchResponse, error) {
// Validate the request
if err := validateUserUpdateBranchGo(req); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/service/operations/cherry_pick.go
Expand Up @@ -16,7 +16,7 @@ import (
"google.golang.org/grpc/status"
)

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s *Server) UserCherryPick(ctx context.Context, req *gitalypb.UserCherryPickRequest) (*gitalypb.UserCherryPickResponse, error) {
if err := validateCherryPickOrRevertRequest(req); err != nil {
return nil, status.Errorf(codes.InvalidArgument, "UserCherryPick: %v", err)
Expand Down
4 changes: 2 additions & 2 deletions internal/gitaly/service/operations/merge.go
Expand Up @@ -44,7 +44,7 @@ func validateMergeBranchRequest(request *gitalypb.UserMergeBranchRequest) error
return nil
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s *Server) UserMergeBranch(stream gitalypb.OperationService_UserMergeBranchServer) error {
ctx := stream.Context()

Expand Down Expand Up @@ -243,7 +243,7 @@ func validateFFRequest(in *gitalypb.UserFFBranchRequest) error {
return nil
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s *Server) UserFFBranch(ctx context.Context, in *gitalypb.UserFFBranchRequest) (*gitalypb.UserFFBranchResponse, error) {
if err := validateFFRequest(in); err != nil {
return nil, helper.ErrInvalidArgument(err)
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/service/operations/rebase.go
Expand Up @@ -14,7 +14,7 @@ import (
"google.golang.org/grpc/status"
)

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s *Server) UserRebaseConfirmable(stream gitalypb.OperationService_UserRebaseConfirmableServer) error {
firstRequest, err := stream.Recv()
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/service/operations/revert.go
Expand Up @@ -14,7 +14,7 @@ import (
"gitlab.com/gitlab-org/gitaly/v15/proto/go/gitalypb"
)

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s *Server) UserRevert(ctx context.Context, req *gitalypb.UserRevertRequest) (*gitalypb.UserRevertResponse, error) {
if err := validateCherryPickOrRevertRequest(req); err != nil {
return nil, helper.ErrInvalidArgument(err)
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/service/operations/server.go
Expand Up @@ -18,7 +18,7 @@ import (
"gitlab.com/gitlab-org/gitaly/v15/proto/go/gitalypb"
)

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
type Server struct {
gitalypb.UnimplementedOperationServiceServer
hookManager hook.Manager
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/service/operations/submodules.go
Expand Up @@ -19,7 +19,7 @@ import (

const userUpdateSubmoduleName = "UserUpdateSubmodule"

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s *Server) UserUpdateSubmodule(ctx context.Context, req *gitalypb.UserUpdateSubmoduleRequest) (*gitalypb.UserUpdateSubmoduleResponse, error) {
if err := validateUserUpdateSubmoduleRequest(req); err != nil {
return nil, status.Errorf(codes.InvalidArgument, userUpdateSubmoduleName+": %v", err)
Expand Down
4 changes: 2 additions & 2 deletions internal/gitaly/service/operations/tags.go
Expand Up @@ -19,7 +19,7 @@ import (
"google.golang.org/grpc/status"
)

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s *Server) UserDeleteTag(ctx context.Context, req *gitalypb.UserDeleteTagRequest) (*gitalypb.UserDeleteTagResponse, error) {
if len(req.TagName) == 0 {
return nil, status.Errorf(codes.InvalidArgument, "empty tag name")
Expand Down Expand Up @@ -82,7 +82,7 @@ func validateUserCreateTag(req *gitalypb.UserCreateTagRequest) error {
return nil
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s *Server) UserCreateTag(ctx context.Context, req *gitalypb.UserCreateTagRequest) (*gitalypb.UserCreateTagResponse, error) {
if err := validateUserCreateTag(req); err != nil {
return nil, helper.ErrInvalidArgumentf("validating request: %w", err)
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/service/smarthttp/server.go
Expand Up @@ -47,7 +47,7 @@ func NewServer(
// ServerOpt is a self referential option for server
type ServerOpt func(s *server)

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func WithPackfileNegotiationMetrics(c *prometheus.CounterVec) ServerOpt {
return func(s *server) {
s.packfileNegotiationMetrics = c
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/service/ssh/server.go
Expand Up @@ -68,7 +68,7 @@ func WithArchiveRequestTimeout(d time.Duration) ServerOpt {
}
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func WithPackfileNegotiationMetrics(c *prometheus.CounterVec) ServerOpt {
return func(s *server) {
s.packfileNegotiationMetrics = c
Expand Down
2 changes: 1 addition & 1 deletion internal/gitaly/storage/locator.go
Expand Up @@ -34,7 +34,7 @@ type Locator interface {
StateDir(storageName string) (string, error)
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
var ErrRelativePathEscapesRoot = errors.New("relative path escapes root directory")

// ValidateRelativePath validates a relative path by joining it with rootDir and verifying the result
Expand Down
8 changes: 4 additions & 4 deletions internal/helper/ticker.go
Expand Up @@ -47,16 +47,16 @@ type ManualTicker struct {
ResetFunc func()
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (mt *ManualTicker) C() <-chan time.Time { return mt.c }

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (mt *ManualTicker) Stop() { mt.StopFunc() }

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (mt *ManualTicker) Reset() { mt.ResetFunc() }

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (mt *ManualTicker) Tick() { mt.c <- time.Now() }

// NewManualTicker returns a Ticker that can be manually controlled.
Expand Down
4 changes: 2 additions & 2 deletions internal/middleware/featureflag/featureflag_handler_test.go
Expand Up @@ -47,15 +47,15 @@ func TestStreamInterceptor(t *testing.T) {
}

func callUnary(ctx context.Context) {
//nolint: errcheck
//nolint:errcheck
UnaryInterceptor(ctx, nil, nil, func(context.Context, interface{}) (interface{}, error) {
ctxlogrus.Extract(ctx).Info("verify")
return nil, nil
})
}

func callStream(ctx context.Context) {
//nolint: errcheck
//nolint:errcheck
StreamInterceptor(ctx, &grpcmw.WrappedServerStream{WrappedContext: ctx}, nil, func(interface{}, grpc.ServerStream) error {
ctxlogrus.Extract(ctx).Info("verify")
return nil
Expand Down
2 changes: 1 addition & 1 deletion internal/praefect/config/config.go
Expand Up @@ -41,7 +41,7 @@ const (
minimalSyncRunInterval = time.Minute
)

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
type Failover struct {
Enabled bool `toml:"enabled,omitempty"`
// ElectionStrategy is the strategy to use for electing primaries nodes.
Expand Down
2 changes: 1 addition & 1 deletion internal/praefect/config/node.go
Expand Up @@ -12,7 +12,7 @@ type Node struct {
Token string `toml:"token,omitempty"`
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (n Node) MarshalJSON() ([]byte, error) {
return json.Marshal(map[string]interface{}{
"storage": n.Storage,
Expand Down
4 changes: 2 additions & 2 deletions internal/praefect/coordinator.go
Expand Up @@ -235,12 +235,12 @@ func NewCoordinator(
return coordinator
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (c *Coordinator) Describe(descs chan<- *prometheus.Desc) {
prometheus.DescribeByCollect(c, descs)
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (c *Coordinator) Collect(metrics chan<- prometheus.Metric) {
c.votersMetric.Collect(metrics)
c.txReplicationCountMetric.Collect(metrics)
Expand Down
2 changes: 1 addition & 1 deletion internal/praefect/datastore/assignment.go
Expand Up @@ -37,7 +37,7 @@ func NewAssignmentStore(db glsql.Querier, configuredStorages map[string][]string
return AssignmentStore{db: db, configuredStorages: configuredStorages}
}

//nolint: stylecheck // This is unintentionally missing documentation.
//nolint:stylecheck // This is unintentionally missing documentation.
func (s AssignmentStore) GetHostAssignments(ctx context.Context, virtualStorage string, repositoryID int64) ([]string, error) {
configuredStorages, ok := s.configuredStorages[virtualStorage]
if !ok {
Expand Down

0 comments on commit 4325323

Please sign in to comment.