diff --git a/clientv3/internal/endpoint/doc.go b/clientv3/internal/endpoint/doc.go new file mode 100644 index 000000000000..2d5150c47beb --- /dev/null +++ b/clientv3/internal/endpoint/doc.go @@ -0,0 +1,17 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package endpoint provides utilities for interpreting and handling etcd +// server endpoints with credential requirements. +package endpoint diff --git a/clientv3/internal/resolver/doc.go b/clientv3/internal/resolver/doc.go new file mode 100644 index 000000000000..8afbf9db06be --- /dev/null +++ b/clientv3/internal/resolver/doc.go @@ -0,0 +1,16 @@ +// Copyright 2014 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package resolver provides a manual resolver for etcd endpoints using gRPC. +package resolver diff --git a/clientv3/naming/endpoints/doc.go b/clientv3/naming/endpoints/doc.go new file mode 100644 index 000000000000..b03aab2d46f5 --- /dev/null +++ b/clientv3/naming/endpoints/doc.go @@ -0,0 +1,17 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package endpoints provides utilities for managing and watching etcd endpoints, +// including functions to add, remove, and list endpoints stored in etcd. +package endpoints diff --git a/clientv3/naming/endpoints/internal/doc.go b/clientv3/naming/endpoints/internal/doc.go new file mode 100644 index 000000000000..3cd6709daa56 --- /dev/null +++ b/clientv3/naming/endpoints/internal/doc.go @@ -0,0 +1,17 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package internal defines operations and structures for endpoint updates +// in etcd's storage system. +package internal diff --git a/clientv3/naming/resolver/doc.go b/clientv3/naming/resolver/doc.go new file mode 100644 index 000000000000..1e720b61a469 --- /dev/null +++ b/clientv3/naming/resolver/doc.go @@ -0,0 +1,16 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package resolver provides a gRPC resolver for discovering etcd endpoints. +package resolver diff --git a/etcdserver/cluster_util.go b/etcdserver/cluster_util.go index b67dab2b35a3..c4dba5d8b926 100644 --- a/etcdserver/cluster_util.go +++ b/etcdserver/cluster_util.go @@ -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) } diff --git a/etcdserver/etcdserverpb/doc.go b/etcdserver/etcdserverpb/doc.go new file mode 100644 index 000000000000..957c04f2170f --- /dev/null +++ b/etcdserver/etcdserverpb/doc.go @@ -0,0 +1,18 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package etcdserverpb provides protocol buffer types and utilities for etcd +// server operations, including custom stringers for redacting sensitive +// information in requests. +package etcdserverpb diff --git a/etcdserver/verify/doc.go b/etcdserver/verify/doc.go index 2c42bf6f1985..d9167d919a06 100644 --- a/etcdserver/verify/doc.go +++ b/etcdserver/verify/doc.go @@ -1,4 +1,4 @@ -// Copyright 2021 The etcd Authors +// Copyright 2024 The etcd Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -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 diff --git a/functional/rpcpb/doc.go b/functional/rpcpb/doc.go new file mode 100644 index 000000000000..632b2a74a48d --- /dev/null +++ b/functional/rpcpb/doc.go @@ -0,0 +1,17 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package rpcpb provides gRPC-based utilities and functions for interacting +// with etcd members. +package rpcpb diff --git a/pkg/grpc_testing/doc.go b/pkg/grpc_testing/doc.go new file mode 100644 index 000000000000..68bb4ac73698 --- /dev/null +++ b/pkg/grpc_testing/doc.go @@ -0,0 +1,17 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package grpc_testing provides utilities and helper functions for testing +// gRPC services, including a customizable StubServer for use in test cases. +package grpc_testing diff --git a/raft/confchange/doc.go b/raft/confchange/doc.go new file mode 100644 index 000000000000..3a2053192455 --- /dev/null +++ b/raft/confchange/doc.go @@ -0,0 +1,16 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package confchange provides utilities for managing Raft configuration changes. +package confchange diff --git a/raft/quorum/doc.go b/raft/quorum/doc.go new file mode 100644 index 000000000000..5bdae10590e5 --- /dev/null +++ b/raft/quorum/doc.go @@ -0,0 +1,17 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package quorum provides types and utilities for managing quorum-based +// voting and indexing in Raft. +package quorum diff --git a/raft/raftpb/doc.go b/raft/raftpb/doc.go new file mode 100644 index 000000000000..b633017747f6 --- /dev/null +++ b/raft/raftpb/doc.go @@ -0,0 +1,16 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package raftpb provides protocol buffer types for the Raft consensus algorithm. +package raftpb diff --git a/raft/tracker/doc.go b/raft/tracker/doc.go new file mode 100644 index 000000000000..41ad68434696 --- /dev/null +++ b/raft/tracker/doc.go @@ -0,0 +1,18 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package tracker provides utilities and data structures for tracking the +// progress and configuration of nodes within an etcd cluster, including +// vote tracking and configuration changes. +package tracker diff --git a/wal/walpb/doc.go b/wal/walpb/doc.go new file mode 100644 index 000000000000..73a1bc504ee5 --- /dev/null +++ b/wal/walpb/doc.go @@ -0,0 +1,17 @@ +// Copyright 2024 The etcd Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package walpb provides protocol buffer definitions and utilities for +// working with etcd's Write-Ahead Log (WAL). +package walpb