Skip to content

Commit

Permalink
ectd 3.4 formatting: added package comments to fix revive linter errors.
Browse files Browse the repository at this point in the history
Signed-off-by: D Tripp <[email protected]>
  • Loading branch information
thedtripp committed Jun 30, 2024
1 parent 5cd1d28 commit 5e47b7d
Show file tree
Hide file tree
Showing 15 changed files with 24 additions and 4 deletions.
2 changes: 2 additions & 0 deletions clientv3/internal/endpoint/endpoint.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package endpoint provides utilities for handling and interpreting etcd
// endpoints.
package endpoint

import (
Expand Down
1 change: 1 addition & 0 deletions clientv3/internal/resolver/resolver.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package resolver provides a manual resolver for etcd endpoints.
package resolver

import (
Expand Down
2 changes: 2 additions & 0 deletions clientv3/naming/endpoints/endpoints.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package endpoints provides structures and methods for managing endpoints in etcd,
// including adding, deleting, and listing endpoints, as well as watching for updates.
package endpoints

import (
Expand Down
2 changes: 2 additions & 0 deletions clientv3/naming/endpoints/internal/update.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package internal provides internal structures and constants for etcd
// endpoint operations.
package internal

// Operation describes action performed on endpoint (addition vs deletion).
Expand Down
1 change: 1 addition & 0 deletions clientv3/naming/resolver/resolver.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package resolver provides a gRPC resolver for etcd endpoints.
package resolver

import (
Expand Down
2 changes: 1 addition & 1 deletion etcdserver/cluster_util.go
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ func isCompatibleWithCluster(lg *zap.Logger, cl *membership.RaftCluster, local t
Minor: maxV.Minor,
}
if nextClusterVersionCompatible {
maxV.Minor += 1
maxV.Minor++
}
return isCompatibleWithVers(lg, vers, local, minV, maxV)
}
Expand Down
1 change: 1 addition & 0 deletions etcdserver/etcdserverpb/raft_internal_stringer.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package etcdserverpb provides protocol buffer messages for the etcd server.
package etcdserverpb

import (
Expand Down
5 changes: 2 additions & 3 deletions etcdserver/verify/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package verify

// verify package is analyzing persistent state of etcd to find potential
// Package verify is analyzing persistent state of etcd to find potential
// inconsistencies.
// In particular it covers cross-checking between different aspacts of etcd
// storage like WAL & Backend.
package verify
1 change: 1 addition & 0 deletions functional/rpcpb/etcd_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package rpcpb defines the etcd configuration structure and related utilities.
package rpcpb

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/grpc_testing/stub_server.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package grpc_testing provides utilities for testing gRPC services.
package grpc_testing

import (
Expand Down
2 changes: 2 additions & 0 deletions raft/confchange/confchange.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package confchange implements configuration changes for the Raft
// consensus algorithm.
package confchange

import (
Expand Down
2 changes: 2 additions & 0 deletions raft/quorum/bench_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package quorum implements quorum-based decision making for the Raft
// consensus algorithm.
package quorum

import (
Expand Down
2 changes: 2 additions & 0 deletions raft/raftpb/confchange.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package raftpb defines protocol buffer messages for Raft consensus
// algorithm in etcd.
package raftpb

import (
Expand Down
2 changes: 2 additions & 0 deletions raft/tracker/inflights.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package tracker implements tracking of inflight messages for the Raft
// consensus algorithm.
package tracker

// Inflights limits the number of MsgApp (represented by the largest index
Expand Down
2 changes: 2 additions & 0 deletions wal/walpb/record.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package walpb defines the structures and error handling for the write-ahead
// log protocol buffer.
package walpb

import "errors"
Expand Down

0 comments on commit 5e47b7d

Please sign in to comment.