aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorD. Shah <dave@ds0.me>2021-01-28 15:19:06 +0000
committerD. Shah <dave@ds0.me>2021-01-28 15:19:06 +0000
commit94e8847d674388c3c8ac663fa4912bb8029b2951 (patch)
tree8e7ffbce4b7d253f05d0bb58ea6430aae8e1b065 /docs
parent5fc3e8e4d2d82396e8ade480192379ccff95a931 (diff)
downloadnextpnr-94e8847d674388c3c8ac663fa4912bb8029b2951.tar.gz
nextpnr-94e8847d674388c3c8ac663fa4912bb8029b2951.tar.bz2
nextpnr-94e8847d674388c3c8ac663fa4912bb8029b2951.zip
cleanup: Spelling fixes
Signed-off-by: D. Shah <dave@ds0.me>
Diffstat (limited to 'docs')
-rw-r--r--docs/archapi.md8
-rw-r--r--docs/coding.md2
-rw-r--r--docs/faq.md4
3 files changed, 7 insertions, 7 deletions
diff --git a/docs/archapi.md b/docs/archapi.md
index 3de6c132..a9c38589 100644
--- a/docs/archapi.md
+++ b/docs/archapi.md
@@ -320,8 +320,8 @@ Get the source wire for a pip.
Get the destination wire for a pip.
-Bi-directional switches (transfer gates) are modelled using two
-antiparallel pips.
+Bi-directional switches (transfer gates) are modeled using two
+anti-parallel pips.
### DelayInfo getPipDelay(PipId pip) const
@@ -378,8 +378,8 @@ This should return a low upper bound for the fastest route from `src` to `dst`.
Or in other words it should assume an otherwise unused chip (thus "fastest route").
But it only produces an estimate for that fastest route, not an exact
-result, and for that estimate it is considered more accaptable to return a
-slightly too high result and it is considered less accaptable to return a
+result, and for that estimate it is considered more acceptable to return a
+slightly too high result and it is considered less acceptable to return a
too low result (thus "low upper bound").
### delay\_t predictDelay(const NetInfo \*net\_info, const PortRef &sink) const
diff --git a/docs/coding.md b/docs/coding.md
index e801f239..b8025f8b 100644
--- a/docs/coding.md
+++ b/docs/coding.md
@@ -32,7 +32,7 @@ Additionally to this; architectures provide functions for checking the availabil
To avoid the high cost of using strings as identifiers directly; almost all "string" identifiers in nextpnr (such as cell names and types) use an indexed string pool type named `IdString`. Unlike Yosys, which has a global garbage collected pool, nextpnr has a per-Context pool without any garbage collection.
-`IdString`s can be created in two ways. Architectures can add `IdString`s with constant indicies - allowing `IdString` constants to be provided too - using `initialize_add` at startup. See how `constids.inc` is used in iCE40 for an example of this. The main way to create `IdString`s, however, is at runtime using the `id` member function of `BaseCtx` given the string to create from (if an `IdString` of that string already exists, the existing `IdString` will be returned).
+`IdString`s can be created in two ways. Architectures can add `IdString`s with constant indices - allowing `IdString` constants to be provided too - using `initialize_add` at startup. See how `constids.inc` is used in iCE40 for an example of this. The main way to create `IdString`s, however, is at runtime using the `id` member function of `BaseCtx` given the string to create from (if an `IdString` of that string already exists, the existing `IdString` will be returned).
Note that `IdString`s need a `Context` (or `BaseCtx`) pointer to convert them back to regular strings, due to the pool being per-context as described above.
diff --git a/docs/faq.md b/docs/faq.md
index fe0c7231..8a1b3f6a 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -57,7 +57,7 @@ for your architecture once implementing small designs work.
The `getConflictingWireWire()`, `getConflictingWireNet()`, `getConflictingPipWire()`, and `getConflictingPipNet()` methods are used by the router
to determine which resources to rip up in order to make a given routing resource (wire or pip) available.
-The architecture must guanrantee that the following invariants hold.
+The architecture must guarantee that the following invariants hold.
**Invariant 1:**
@@ -223,4 +223,4 @@ for these parts.
As the open source community now has support for multiple different FPGA parts,
in the nextpnr documentation we generally use Project IceStorm to mean the database and
-tools that fulfil the same role as Project Trellis or Project X-Ray.
+tools that fulfill the same role as Project Trellis or Project X-Ray.