From 942542111447bbc076c9d20bc11ddb17fb410ea0 Mon Sep 17 00:00:00 2001 From: Andrew Gillis <11790789+gammazero@users.noreply.github.com> Date: Sun, 29 Dec 2024 19:27:41 -1000 Subject: [PATCH] collection of typo fixes (#10647) --- core/commands/files.go | 2 +- core/commands/stat.go | 2 +- core/coreiface/unixfs.go | 2 +- core/node/helpers/helpers.go | 2 +- docs/changelogs/v0.13.md | 4 ++-- docs/changelogs/v0.5.md | 2 +- docs/changelogs/v0.8.md | 8 ++++---- docs/config.md | 8 ++++---- fuse/node/mount_unix.go | 2 +- repo/common/common.go | 4 ++-- repo/fsrepo/datastores.go | 13 ++++++------- repo/fsrepo/migrations/fetcher.go | 4 ++-- 12 files changed, 26 insertions(+), 27 deletions(-) diff --git a/core/commands/files.go b/core/commands/files.go index e06833f6f1d..a9c876d78fd 100644 --- a/core/commands/files.go +++ b/core/commands/files.go @@ -68,7 +68,7 @@ of consistency guarantees and unbound growth of the directories' in-memory caches. If the daemon is unexpectedly killed before running 'ipfs files flush' on the files in question, then data may be lost. This also applies to run 'ipfs repo gc' concurrently with '--flush=false' operations. We recommend -flushing paths reguarly with 'ipfs files flush', specially the folders on +flushing paths regularly with 'ipfs files flush', specially the folders on which many write operations are happening, as a way to clear the directory cache, free memory and speed up read operations.`, }, diff --git a/core/commands/stat.go b/core/commands/stat.go index 3f32a77a6cf..2632d6aa257 100644 --- a/core/commands/stat.go +++ b/core/commands/stat.go @@ -56,7 +56,7 @@ to a particular peer, use the 'peer' option along with that peer's multihash id. To specify a specific protocol, use the 'proto' option. The 'peer' and 'proto' options cannot be specified simultaneously. The protocols that are queried using this method are outlined in the specification: -https://github.com/libp2p/specs/blob/master/7-properties.md#757-protocol-multicodecs +https://github.com/libp2p/specs/blob/master/_archive/7-properties.md#757-protocol-multicodecs Example protocol options: - /ipfs/id/1.0.0 diff --git a/core/coreiface/unixfs.go b/core/coreiface/unixfs.go index 10371998c20..a8740e2b3ba 100644 --- a/core/coreiface/unixfs.go +++ b/core/coreiface/unixfs.go @@ -105,7 +105,7 @@ type UnixfsAPI interface { // Iteration stops if the context is canceled or if the iterator yields an // error. // -// Exmaple: +// Example: // // for dirEnt, err := LsIter(ctx, ufsAPI, p) { // if err != nil { diff --git a/core/node/helpers/helpers.go b/core/node/helpers/helpers.go index 4c3a0488116..36ac435e8da 100644 --- a/core/node/helpers/helpers.go +++ b/core/node/helpers/helpers.go @@ -8,7 +8,7 @@ import ( type MetricsCtx context.Context -// LifecycleCtx creates a context which will be cancelled when lifecycle stops +// LifecycleCtx creates a context which will be canceled when lifecycle stops // // This is a hack which we need because most of our services use contexts in a // wrong way diff --git a/docs/changelogs/v0.13.md b/docs/changelogs/v0.13.md index 9bf4ee88acf..a985f179c32 100644 --- a/docs/changelogs/v0.13.md +++ b/docs/changelogs/v0.13.md @@ -53,7 +53,7 @@ View the linked [security advisory](https://github.com/ipfs/go-ipfs/security/adv - bump to newer blockstore err not found (#301) ([ipld/go-car#301](https://github.com/ipld/go-car/pull/301)) - Car command supports for `largebytes` nodes (#296) ([ipld/go-car#296](https://github.com/ipld/go-car/pull/296)) - fix(test): rootless fixture should have no roots, not null roots - - Allow extracton of a raw unixfs file (#284) ([ipld/go-car#284](https://github.com/ipld/go-car/pull/284)) + - Allow extraction of a raw unixfs file (#284) ([ipld/go-car#284](https://github.com/ipld/go-car/pull/284)) - cmd/car: use a better install command in the README - feat: --version selector for `car create` & update deps - feat: add option to create blockstore that writes a plain CARv1 (#288) ([ipld/go-car#288](https://github.com/ipld/go-car/pull/288)) @@ -537,7 +537,7 @@ The more fully featured yamux stream multiplexer is now prioritized over mplex f - Fix unixfs fetch (#364) ([ipfs/go-graphsync#364](https://github.com/ipfs/go-graphsync/pull/364)) - [Feature] UUIDs, protocol versioning, v2 protocol w/ dag-cbor messaging (#332) ([ipfs/go-graphsync#332](https://github.com/ipfs/go-graphsync/pull/332)) - feat(CHANGELOG): update for v0.12.0 - - Use do not send blocks for pause/resume & prevent processing of blocks on cancelled requests (#333) ([ipfs/go-graphsync#333](https://github.com/ipfs/go-graphsync/pull/333)) + - Use do not send blocks for pause/resume & prevent processing of blocks on canceled requests (#333) ([ipfs/go-graphsync#333](https://github.com/ipfs/go-graphsync/pull/333)) - Support unixfs reification in default linksystem (#329) ([ipfs/go-graphsync#329](https://github.com/ipfs/go-graphsync/pull/329)) - Don't run hooks on blocks we didn't have (#331) ([ipfs/go-graphsync#331](https://github.com/ipfs/go-graphsync/pull/331)) - feat(responsemanager): trace full messages via links to responses (#325) ([ipfs/go-graphsync#325](https://github.com/ipfs/go-graphsync/pull/325)) diff --git a/docs/changelogs/v0.5.md b/docs/changelogs/v0.5.md index aa5f9c95789..60d0313fc20 100644 --- a/docs/changelogs/v0.5.md +++ b/docs/changelogs/v0.5.md @@ -773,7 +773,7 @@ As usual, this release contains several Windows specific fixes and improvements: - Introduce first strategic provider: do nothing ([ipfs/go-ipfs#6292](https://github.com/ipfs/go-ipfs/pull/6292)) - github.com/ipfs/go-bitswap (v0.0.8-e37498cf10d6 -> v0.2.13): - refactor: remove WantManager ([ipfs/go-bitswap#374](https://github.com/ipfs/go-bitswap/pull/374)) - - Send CANCELs when session context is cancelled ([ipfs/go-bitswap#375](https://github.com/ipfs/go-bitswap/pull/375)) + - Send CANCELs when session context is canceled ([ipfs/go-bitswap#375](https://github.com/ipfs/go-bitswap/pull/375)) - refactor: remove unused code ([ipfs/go-bitswap#373](https://github.com/ipfs/go-bitswap/pull/373)) - Change timing for DONT_HAVE timeouts to be more conservative ([ipfs/go-bitswap#371](https://github.com/ipfs/go-bitswap/pull/371)) - fix: avoid calling ctx.SetDeadline() every time we send a message ([ipfs/go-bitswap#369](https://github.com/ipfs/go-bitswap/pull/369)) diff --git a/docs/changelogs/v0.8.md b/docs/changelogs/v0.8.md index 7f4e1d7594c..d9d42fa895a 100644 --- a/docs/changelogs/v0.8.md +++ b/docs/changelogs/v0.8.md @@ -1,4 +1,4 @@ -# go-ipfs changelog v0.8 + # go-ipfs changelog v0.8 ## v0.8.0 2021-02-18 @@ -160,7 +160,7 @@ Go 1.15 (the latest version of Go) [no longer supports](https://github.com/golan - Update go-ipld-prime@v0.5.0 (#92) ([ipfs/go-graphsync#92](https://github.com/ipfs/go-graphsync/pull/92)) - refactor(metadata): use cbor-gen encoding (#96) ([ipfs/go-graphsync#96](https://github.com/ipfs/go-graphsync/pull/96)) - Release/v0.1.2 ([ipfs/go-graphsync#95](https://github.com/ipfs/go-graphsync/pull/95)) - - Return Request context cancelled error (#93) ([ipfs/go-graphsync#93](https://github.com/ipfs/go-graphsync/pull/93)) + - Return Request context canceled error (#93) ([ipfs/go-graphsync#93](https://github.com/ipfs/go-graphsync/pull/93)) - feat(benchmarks): add p2p stress test (#91) ([ipfs/go-graphsync#91](https://github.com/ipfs/go-graphsync/pull/91)) - Benchmark framework + First memory fixes (#89) ([ipfs/go-graphsync#89](https://github.com/ipfs/go-graphsync/pull/89)) - docs(CHANGELOG): update for v0.1.1 ([ipfs/go-graphsync#85](https://github.com/ipfs/go-graphsync/pull/85)) @@ -277,7 +277,7 @@ Go 1.15 (the latest version of Go) [no longer supports](https://github.com/golan - satisfy race detector - clean up - copy string topic - - add test for score adjustment from topis params reset + - add test for score adjustment from topic params reset - prettify things - add test for topic score parameter reset method - add test for topic score parameter reset @@ -315,7 +315,7 @@ Go 1.15 (the latest version of Go) [no longer supports](https://github.com/golan - pass a conn that can be type asserted to a net.UDPConn to quic-go ([libp2p/go-libp2p-quic-transport#180](https://github.com/libp2p/go-libp2p-quic-transport/pull/180)) - add more integration tests ([libp2p/go-libp2p-quic-transport#181](https://github.com/libp2p/go-libp2p-quic-transport/pull/181)) - always close the connection in the cmd client ([libp2p/go-libp2p-quic-transport#175](https://github.com/libp2p/go-libp2p-quic-transport/pull/175)) - - use GitHub Actions to test interopability of releases ([libp2p/go-libp2p-quic-transport#173](https://github.com/libp2p/go-libp2p-quic-transport/pull/173)) + - use GitHub Actions to test interoperability of releases ([libp2p/go-libp2p-quic-transport#173](https://github.com/libp2p/go-libp2p-quic-transport/pull/173)) - Implement CloseRead/CloseWrite ([libp2p/go-libp2p-quic-transport#174](https://github.com/libp2p/go-libp2p-quic-transport/pull/174)) - enable quic-go metrics collection ([libp2p/go-libp2p-quic-transport#172](https://github.com/libp2p/go-libp2p-quic-transport/pull/172)) - github.com/libp2p/go-libp2p-swarm (v0.2.8 -> v0.4.0): diff --git a/docs/config.md b/docs/config.md index f1a3895f5de..4bcfcce7bc4 100644 --- a/docs/config.md +++ b/docs/config.md @@ -641,9 +641,9 @@ functions](https://github.com/ipfs/go-ipfs-blockstore/blob/547442836ade055cc114b are used, so the constant `k` is 7 in the formula. Enabling the BloomFilter can provide performance improvements specially when -responding to many requests for inexistant blocks. It however requires a full +responding to many requests for inexistent blocks. It however requires a full sweep of all the datastore keys on daemon start. On very large datastores this -can be a very taxing operation, particulary if the datastore does not support +can be a very taxing operation, particularly if the datastore does not support querying existing keys without reading their values at the same time (blocks). Default: `0` (disabled) @@ -1013,7 +1013,7 @@ Below is a list of the most common public gateway setups. `http://dweb.link/ipfs/{cid}` → `http://{cid}.ipfs.dweb.link` - - **X-Forwarded-Proto:** if you run Kubo behind a reverse proxy that provides TLS, make it add a `X-Forwarded-Proto: https` HTTP header to ensure users are redirected to `https://`, not `http://`. It will also ensure DNSLink names are inlined to fit in a single DNS label, so they work fine with a wildcart TLS cert ([details](https://github.com/ipfs/in-web-browsers/issues/169)). The NGINX directive is `proxy_set_header X-Forwarded-Proto "https";`.: + - **X-Forwarded-Proto:** if you run Kubo behind a reverse proxy that provides TLS, make it add a `X-Forwarded-Proto: https` HTTP header to ensure users are redirected to `https://`, not `http://`. It will also ensure DNSLink names are inlined to fit in a single DNS label, so they work fine with a wildcard TLS cert ([details](https://github.com/ipfs/in-web-browsers/issues/169)). The NGINX directive is `proxy_set_header X-Forwarded-Proto "https";`.: `http://dweb.link/ipfs/{cid}` → `https://{cid}.ipfs.dweb.link` @@ -2610,7 +2610,7 @@ Pebble is a LevelDB/RocksDB inspired key-value store focused on performance and You should use this datastore if: - You need a datastore that is focused on performance. -- You need a datastore that is good for multi-terrabyte data sets. +- You need a datastore that is good for multi-terabyte data sets. - You need reliability by default, but may choose to disable WAL for maximum performance when reliability is not critical. - You want a datastore that does not need GC cycles and does not use more space than necessary - You want a datastore that does not take several minutes to start with large repositories diff --git a/fuse/node/mount_unix.go b/fuse/node/mount_unix.go index 1e509a2435c..63763996b2f 100644 --- a/fuse/node/mount_unix.go +++ b/fuse/node/mount_unix.go @@ -110,7 +110,7 @@ func doMount(node *core.IpfsNode, fsdir, nsdir string) error { return fmtFuseErr(err2, nsdir) } - // setup node state, so that it can be cancelled + // setup node state, so that it can be canceled node.Mounts.Ipfs = fsmount node.Mounts.Ipns = nsmount return nil diff --git a/repo/common/common.go b/repo/common/common.go index ab74ffca853..6a6dee6ddf4 100644 --- a/repo/common/common.go +++ b/repo/common/common.go @@ -61,8 +61,8 @@ func MapSetKV(v map[string]interface{}, key string, value interface{}) error { return nil } -// Merges the right map into the left map, recursively traversing child maps -// until a non-map value is found. +// MapMergeDeep merges the right map into the left map, recursively traversing +// child maps until a non-map value is found. func MapMergeDeep(left, right map[string]interface{}) map[string]interface{} { // We want to alter a copy of the map, not the original result := make(map[string]interface{}) diff --git a/repo/fsrepo/datastores.go b/repo/fsrepo/datastores.go index 86ed0a86308..a8c6fa45cda 100644 --- a/repo/fsrepo/datastores.go +++ b/repo/fsrepo/datastores.go @@ -17,16 +17,15 @@ import ( // ConfigFromMap creates a new datastore config from a map. type ConfigFromMap func(map[string]interface{}) (DatastoreConfig, error) -// DatastoreConfig is an abstraction of a datastore config. A "spec" -// is first converted to a DatastoreConfig and then Create() is called -// to instantiate a new datastore. +// DatastoreConfig is an abstraction of a datastore config. A "spec" is first +// converted to a DatastoreConfig and then Create() is called to instantiate a +// new datastore. type DatastoreConfig interface { - // DiskSpec returns a minimal configuration of the datastore - // represting what is stored on disk. Run time values are - // excluded. + // DiskSpec returns a minimal configuration of the datastore representing + // what is stored on disk. Run time values are excluded. DiskSpec() DiskSpec - // Create instantiate a new datastore from this config + // Create instantiates a new datastore from this config. Create(path string) (repo.Datastore, error) } diff --git a/repo/fsrepo/migrations/fetcher.go b/repo/fsrepo/migrations/fetcher.go index db7a5c0c13a..36aa06036bf 100644 --- a/repo/fsrepo/migrations/fetcher.go +++ b/repo/fsrepo/migrations/fetcher.go @@ -79,7 +79,7 @@ func (f *MultiFetcher) Fetchers() []Fetcher { return f.fetchers } -// NewLimitReadCloser returns a new io.ReadCloser with the reader wrappen in a +// NewLimitReadCloser returns a new io.ReadCloser with the reader wrapped in a // io.LimitedReader limited to reading the amount specified. func NewLimitReadCloser(rc io.ReadCloser, limit int64) io.ReadCloser { return limitReadCloser{ @@ -93,7 +93,7 @@ func NewLimitReadCloser(rc io.ReadCloser, limit int64) io.ReadCloser { // variable is not set, then returns the provided distPath, and if that is not set // then returns the IPNS path. // -// To get the IPFS path of the latest distribution, if not overriddin by the +// To get the IPFS path of the latest distribution, if not overridden by the // environ variable: GetDistPathEnv(CurrentIpfsDist). func GetDistPathEnv(distPath string) string { if dist := os.Getenv(envIpfsDistPath); dist != "" {