From 394956ca4eddd25cc79a9d9792ba52d6fc5fa4d8 Mon Sep 17 00:00:00 2001 From: Benjamin Wang Date: Fri, 2 Dec 2022 14:13:18 +0800 Subject: [PATCH] doc: cleanup etcd/raft in all documents TODO: 1. Update Documentation/contributor-guide/modules.svg; 2. Update bill-of-materials.json when raft and raftexample are removed in future; Signed-off-by: Benjamin Wang --- Documentation/contributor-guide/modules.md | 5 +- bill-of-materials.json | 63 ++++------------------ codecov.yml | 1 - server/etcdserver/api/rafthttp/doc.go | 2 +- 4 files changed, 13 insertions(+), 58 deletions(-) diff --git a/Documentation/contributor-guide/modules.md b/Documentation/contributor-guide/modules.md index 2e8ded443..a8551aa39 100644 --- a/Documentation/contributor-guide/modules.md +++ b/Documentation/contributor-guide/modules.md @@ -24,8 +24,9 @@ There are following modules: - **go.etcd.io/etcd/client/v2** - legacy client library used to contact etcd over HTTP protocol. Deprecated. All new usage should depend on /v3 library. - - **go.etcd.io/etcd/raft/v3** - implementation of distributed consensus - protocol. Should have no etcd specific code. + - **go.etcd.io/raft/v3** - implementation of distributed consensus + protocol. Should have no etcd specific code. Hosted in a separate repository: + https://github.com/etcd-io/raft. - **go.etcd.io/etcd/server/v3** - etcd implementation. The code in this package is etcd internal and should not be consumed diff --git a/bill-of-materials.json b/bill-of-materials.json index 5b36cbb48..2324ca7d1 100644 --- a/bill-of-materials.json +++ b/bill-of-materials.json @@ -53,15 +53,6 @@ } ] }, - { - "project": "github.com/certifi/gocertifi", - "licenses": [ - { - "type": "Mozilla Public License 2.0", - "confidence": 1 - } - ] - }, { "project": "github.com/cespare/xxhash/v2", "licenses": [ @@ -80,33 +71,6 @@ } ] }, - { - "project": "github.com/cockroachdb/datadriven", - "licenses": [ - { - "type": "Apache License 2.0", - "confidence": 1 - } - ] - }, - { - "project": "github.com/cockroachdb/errors", - "licenses": [ - { - "type": "Apache License 2.0", - "confidence": 1 - } - ] - }, - { - "project": "github.com/cockroachdb/logtags", - "licenses": [ - { - "type": "Apache License 2.0", - "confidence": 1 - } - ] - }, { "project": "github.com/coreos/go-semver/semver", "licenses": [ @@ -161,15 +125,6 @@ } ] }, - { - "project": "github.com/getsentry/raven-go", - "licenses": [ - { - "type": "BSD 3-clause \"New\" or \"Revised\" License", - "confidence": 0.9663865546218487 - } - ] - }, { "project": "github.com/go-logr/logr", "licenses": [ @@ -350,15 +305,6 @@ } ] }, - { - "project": "github.com/pkg/errors", - "licenses": [ - { - "type": "BSD 2-clause \"Simplified\" License", - "confidence": 1 - } - ] - }, { "project": "github.com/pmezard/go-difflib/difflib", "licenses": [ @@ -584,6 +530,15 @@ } ] }, + { + "project": "go.etcd.io/raft/v3", + "licenses": [ + { + "type": "Apache License 2.0", + "confidence": 1 + } + ] + }, { "project": "go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc", "licenses": [ diff --git a/codecov.yml b/codecov.yml index a4b3b7f27..5dfc7b9b9 100644 --- a/codecov.yml +++ b/codecov.yml @@ -8,7 +8,6 @@ fixes: - "go.etcd.io/etcd/client/v2/::client/v2/" - "go.etcd.io/etcd/etcdctl/v3/::etcdctl/" - "go.etcd.io/etcd/pkg/v3/::pkg/" - - "go.etcd.io/etcd/raft/v3/::raft/" - "go.etcd.io/etcd/server/v3/::server/" ignore: diff --git a/server/etcdserver/api/rafthttp/doc.go b/server/etcdserver/api/rafthttp/doc.go index a9486a8bb..c45dc8178 100644 --- a/server/etcdserver/api/rafthttp/doc.go +++ b/server/etcdserver/api/rafthttp/doc.go @@ -12,5 +12,5 @@ // See the License for the specific language governing permissions and // limitations under the License. -// Package rafthttp implements HTTP transportation layer for etcd/raft pkg. +// Package rafthttp implements HTTP transportation layer for raft pkg. package rafthttp