diff options
| author | David Shah <dave@ds0.me> | 2021-02-03 19:55:32 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-03 19:55:32 +0000 |
| commit | 155e0b9c428aa32d1ca22d3679db6db50505b2a8 (patch) | |
| tree | f86b0cc21e71cfed705b82108562d6ca692068be /docs | |
| parent | 9a79163eab89e6351cd06c37d5916174acdfc754 (diff) | |
| parent | 0865198a9e5d201cc436b90a9338c3c40048e2e0 (diff) | |
| download | nextpnr-155e0b9c428aa32d1ca22d3679db6db50505b2a8.tar.gz nextpnr-155e0b9c428aa32d1ca22d3679db6db50505b2a8.tar.bz2 nextpnr-155e0b9c428aa32d1ca22d3679db6db50505b2a8.zip | |
Merge pull request #565 from YosysHQ/dave/snakecase
Use snake case consistently for non-Arch-API functions
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/coding.md | 2 |
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. |