aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorD. Shah <dave@ds0.me>2021-02-03 10:42:46 +0000
committerD. Shah <dave@ds0.me>2021-02-03 10:53:15 +0000
commit0865198a9e5d201cc436b90a9338c3c40048e2e0 (patch)
treef86b0cc21e71cfed705b82108562d6ca692068be
parentf05d024666ba4ece6d37d49d7168f47c3ae2b51f (diff)
downloadnextpnr-0865198a9e5d201cc436b90a9338c3c40048e2e0.tar.gz
nextpnr-0865198a9e5d201cc436b90a9338c3c40048e2e0.tar.bz2
nextpnr-0865198a9e5d201cc436b90a9338c3c40048e2e0.zip
Update coding.md
Signed-off-by: D. Shah <dave@ds0.me>
-rw-r--r--docs/coding.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/coding.md b/docs/coding.md
index 5cbaef01..355fe457 100644
--- a/docs/coding.md
+++ b/docs/coding.md
@@ -28,6 +28,8 @@ Additionally to this; architectures provide functions for checking the availabil
- Pips that represent LUT permutation are not available when the LUT is in memory mode
- only a certain total number of pips in a switchbox can be used at once due to power supply limitations
+As well as implementing all of the standard [Arch API](archapi.md) functions; arches may include their own helper functions for various purposes. By convention these are in `snake_case`, to distinguish them from the `camelCase` Arch API functions.
+
## `IdString`s
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.