Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): fix minor typos #12824

Merged
merged 2 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions documentation/en/WIP-arch-complementary-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ These edited extracts from the `BlockHeader` show how it's treated as an IPFS bl

This duality permeates the code (and the Filecoin spec for that matter) but it is usually clear within the context to which block we are referring to. Normally the unqualified *block* is reserved for the Filecoin block and we won't usually refer to the IPFS one but only implicitly through the concept of its CID. With enough understanding of both stack's architecture the two definitions can coexist without much confusion as we will abstract away the IPFS layer and just use the CID as an identifier that we know is unique for two sequences of different *raw* byte strings.

(FIXME: We use to do this presentation when talking about `gossipsub` topics and incoming blocks, and had to deal with, besides the block ambiguity, a similar confusion with the *message* term, used in libp2p to name anything that comes through the network, needing to present the extremely confusing hierarchy of a libp2p message containing a Filecoin block, identified by a IPFS block CID, containing Filecoin messages.)
(FIXME: We use to do this presentation when talking about `gossipsub` topics and incoming blocks, and had to deal with, besides the block ambiguity, a similar confusion with the *message* term, used in libp2p to name anything that comes through the network, needing to present the extremely confusing hierarchy of a libp2p message containing a Filecoin block, identified by an IPFS block CID, containing Filecoin messages.)

FIXME: Move the following tipset definition to sync or wherever is most needed, to avoid making this more confusing.

Expand Down Expand Up @@ -124,7 +124,7 @@ nc -v -z 127.0.0.1 1234
# Start daemon and turn off the logs to not clutter the command line.
bash -c "lotus daemon &" &&
lotus wait-api &&
lotus log set-level error # Or a env.var in the daemon command.
lotus log set-level error # Or an env.var in the daemon command.

nc -v -z 127.0.0.1 1234
# Connection to 127.0.0.1 1234 port [tcp/*] succeeded!
Expand Down
6 changes: 3 additions & 3 deletions documentation/en/architecture/mpool.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ This should be used with extreme care and only in the case of errors during head
would leave the mpool in an inconsistent state.


## Command Line Interfae
## Command Line Interface

The lotus command line interface defines an `mpool` command which
allows a user to interact with the mpool.
Expand Down Expand Up @@ -111,7 +111,7 @@ Gets or sets the current mpool configuration.
Unconditionally clears pending messages from the mpool.
If the `--local` flag is passed, then local messages are also cleared; otherwise local messages are retained.

*Warning*: this command should only be used in the case of head change errors leaving the mpool in an state.
*Warning*: this command should only be used in the case of head change errors leaving the mpool in a state.

## Configuration

Expand Down Expand Up @@ -172,5 +172,5 @@ selection algorithm is used instead that simply picks dependent chains of
maximum reward. Note that pending message chains from priority addresses
are always selected, regardless of their profitability.

For algorithm details, please prefer to the implementation in
For algorithm details, please refer to the implementation in
`chain/messagepool/selection.go`.
4 changes: 2 additions & 2 deletions documentation/misc/Building_a_network_skeleton.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The table below gives an overview of how Lotus and its critical dependencies rel
There is a network skeleton in Lotus, which bubbles up all the other dependencies, and allows one to run a 2k-network and see that it switches network version from nv(XX-1) --> nvXX

## Notes
1. This is the overarching tracking issue for the network skeleton update, but thare are tasks that needed to be completed in other repos as well. All PRs for this effort can reference this issue.
1. This is the overarching tracking issue for the network skeleton update, but there are tasks that need to be completed in other repos as well. All PRs for this effort can reference this issue.
2. How to create a skeleton in Lotus is documented here: https://github.com/filecoin-project/lotus/blob/master/documentation/misc/Building_a_network_skeleton.md

```[tasklist]
Expand Down Expand Up @@ -179,7 +179,7 @@ You can take a look at [this PR as a reference](https://github.com/filecoin-proj

👉 You can take a look at this [Filecoin-FFI PR as a reference](https://github.com/filecoin-project/filecoin-ffi/pull/481), which was for network version 24.

Note: one only needs to update `filecion-ffi`'s dependency on `go-state-types` when a network upgrade is introducing new types in `go-state-types` (see [below](#new-types-in-go-state-types)). Otherwise, `filecion-ffi`'s dependency on `go-state-types` is just updated when doing final releases before the network upgrade.
Note: one only needs to update `filecoin-ffi`'s dependency on `go-state-types` when a network upgrade is introducing new types in `go-state-types` (see [below](#new-types-in-go-state-types)). Otherwise, `filecoin-ffi`'s dependency on `go-state-types` is just updated when doing final releases before the network upgrade.

## Lotus Checklist

Expand Down
Loading