aboutsummaryrefslogtreecommitdiffstats
path: root/docs/coding.md
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/coding.md
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/coding.md')
-rw-r--r--docs/coding.md2
1 files changed, 1 insertions, 1 deletions
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.