Skip to content

Commit 4cbdf09

Browse files
authored
docs: fix some typos (#13289)
* Update Builtin-actors_Development.md * Update chain-indexer-overview-for-operators.md * docs: fix some typos * Update doc_gen.go * Update types.go
1 parent 84bc827 commit 4cbdf09

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

documentation/en/chain-indexer-overview-for-operators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ In case you need to downgrade to the [previous indexing system](#previous-indexi
310310
* It persists state to `${LOTUS_PATH}/chainindex`.
311311
* It has this CLI backfill tooling: [`lotus index validate-backfill`](#lotus-shed-chainindex-validate-backfill-cli-tool)
312312
* **Storage requirements:** See the [backfill disk space requirements](#backfill-disk-space-requirements).
313-
* **Backfil times:** See the [backfill timing](#backfill-timing).
313+
* **Backfill times:** See the [backfill timing](#backfill-timing).
314314

315315
## Appendix
316316

documentation/en/default-lotus-config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
# env var: LOTUS_LIBP2P_LISTENADDRESSES
4141
#ListenAddresses = ["/ip4/0.0.0.0/tcp/0", "/ip6/::/tcp/0", "/ip4/0.0.0.0/udp/0/quic-v1", "/ip6/::/udp/0/quic-v1", "/ip4/0.0.0.0/udp/0/quic-v1/webtransport", "/ip6/::/udp/0/quic-v1/webtransport"]
4242

43-
# Addresses to explicitally announce to other peers. If not specified,
43+
# Addresses to explicitly announce to other peers. If not specified,
4444
# all interface addresses are announced
4545
# Format: multiaddress
4646
#

documentation/misc/Builtin-actors_Development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Testing integration of builtin-actors code typically involves bundling pre-relea
2525

2626
### Environment variable override
2727

28-
When developing builtin-actors, the `bundle-devnet` Makefile target can be used to compile a devenet ("2k") version of builtin-actors into a CAR file in the `output/` directory. This bundle is immediately usable by Lotus for testing using the `LOTUS_BUILTIN_ACTORS_VXX` environment variable. For a given actors version, `XX`, which corresponds to the network version you want to replace, you can execute itests using the `LOTUS_BUILTIN_ACTORS_VXX` environment variable to test the changes you have made. The file [`chain/consensus/filcns/upgrades.go`](../../chain/consensus/filcns/upgrades.go) contains the full list of mappings from network versions to actors versions. For example, `LOTUS_BUILTIN_ACTORS_V15=/path/to/builtin-actors/output/builtin-actors-devnet.car go test ./itests/test_foo.go` will run `test_foo.go` using the `builtin-actors-devnet.car` bundle if the test expects to load actors version 15. By default, itests will run using the latest network / actors version. So if the current network version is NV15, then actors version 15 will be loaded by default and `LOTUS_BUILTIN_ACTORS_V15` will intercept the load and use the specified bundle instead of the devnet bundle packaged in [`build/actors/`](../../build/actors/). In this way you can run integration tests manually off a custom actors build.
28+
When developing builtin-actors, the `bundle-devnet` Makefile target can be used to compile a devnet ("2k") version of builtin-actors into a CAR file in the `output/` directory. This bundle is immediately usable by Lotus for testing using the `LOTUS_BUILTIN_ACTORS_VXX` environment variable. For a given actors version, `XX`, which corresponds to the network version you want to replace, you can execute itests using the `LOTUS_BUILTIN_ACTORS_VXX` environment variable to test the changes you have made. The file [`chain/consensus/filcns/upgrades.go`](../../chain/consensus/filcns/upgrades.go) contains the full list of mappings from network versions to actors versions. For example, `LOTUS_BUILTIN_ACTORS_V15=/path/to/builtin-actors/output/builtin-actors-devnet.car go test ./itests/test_foo.go` will run `test_foo.go` using the `builtin-actors-devnet.car` bundle if the test expects to load actors version 15. By default, itests will run using the latest network / actors version. So if the current network version is NV15, then actors version 15 will be loaded by default and `LOTUS_BUILTIN_ACTORS_V15` will intercept the load and use the specified bundle instead of the devnet bundle packaged in [`build/actors/`](../../build/actors/). In this way you can run integration tests manually off a custom actors build.
2929

3030
This method does not extend to being able to run your Lotus changes in CI with a pull request as this override is not possible in that environment. This method is only useful for local development and testing, but can be used until a tagged and released version of builtin-actors containing your changes is checked into the Lotus repository. For a development workflow that works with CI, see [Replacing actors bundles](#replacing-actors-bundles).
3131

@@ -103,4 +103,4 @@ _**TODO**: More detail is needed on how to coordinate changes between builtin-ac
103103

104104
Similar to builtin-actors and state migration changes, but requires additional coordination to integrate a new version of [ref-fvm](https://github.com/filecoin-project/ref-fvm/) with builtin-actors and [filecoin-ffi](https://github.com/filecoin-project/filecoin-ffi) and then integrate that into Lotus along with builtin-actors and go-state-types, along with appropriate tests.
105105

106-
_**TODO**: More detail is needed on how to coordinate changes between builtin-actors, go-state-types, ref-fvm and Lotus for state migration_
106+
_**TODO**: More detail is needed on how to coordinate changes between builtin-actors, go-state-types, ref-fvm and Lotus for state migration_

node/config/doc_gen.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

node/config/types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ type Libp2p struct {
416416
// Binding address for the libp2p host - 0 means random port.
417417
// Format: multiaddress; see https://multiformats.io/multiaddr/
418418
ListenAddresses []string
419-
// Addresses to explicitally announce to other peers. If not specified,
419+
// Addresses to explicitly announce to other peers. If not specified,
420420
// all interface addresses are announced
421421
// Format: multiaddress
422422
AnnounceAddresses []string

0 commit comments

Comments
 (0)