Skip to content

Commit 91b9d15

Browse files
[Spelling] Fixed Spelling in Documentation
Used codespell to fix all of the spelling in the documentation. This is basically all files which are not in the vpr or libs folder.
1 parent 8b907a5 commit 91b9d15

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+174
-174
lines changed

BUILDING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ If you download a different version of those tools, then those versions may not
4444

4545
## Verifying Installation
4646

47-
To verfiy that VTR has been installed correctly run::
47+
To verify that VTR has been installed correctly run::
4848

4949
./vtr_flow/scripts/run_vtr_task.py ./vtr_flow/tasks/regression_tests/vtr_reg_basic/basic_timing
5050

CHANGELOG.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# VTR Change Log
22
<!--
33
This file documents user-facing changes between releases of the VTR
4-
project. The goal is to concicely communicate to end users what is new
4+
project. The goal is to concisely communicate to end users what is new
55
or has changed in a particular release. It should *NOT* just be a dump
66
of the commit log, as that is far too detailed. Most code re-factoring
77
does not warrant a change log entry unless it has a significant impact
88
on the end users (e.g. substantial performance improvements).
99
10-
Each release's change log should include headings (where releveant) with
10+
Each release's change log should include headings (where relevant) with
1111
bullet points listing what was:
1212
- added (new feature)
1313
- changed (change to existing feature behaviour)
@@ -16,7 +16,7 @@ bullet points listing what was:
1616
- removed (previous features which have been removed)
1717
1818
Changes which have landed in the master/trunk but not been released
19-
should be included in the 'Unreleased' section and moved to the releveant
19+
should be included in the 'Unreleased' section and moved to the relevant
2020
releases' section when released.
2121
2222
In the case of release candidates (e.g. v8.0.0-rc1) the current
@@ -146,7 +146,7 @@ _The following are changes which have been implemented in the VTR master branch
146146
* Improved a wide variety of error messages
147147
* Improved STA timing reports (more details, clearer format)
148148
* VPR now uses Tatum as its STA engine
149-
* VPR now detects missmatched architecture (.xml) and implementation (.net/.place/.route) files more robustly
149+
* VPR now detects mismatched architecture (.xml) and implementation (.net/.place/.route) files more robustly
150150
* Improved router run-time and quality through incremental re-routing and improved handling of high-fanout nets
151151
* The timing edges within each netlist primitive must now be specified in the <models> section of the architecture file
152152
* All interconnect tags must have unique names in the architecture file
@@ -164,8 +164,8 @@ _The following are changes which have been implemented in the VTR master branch
164164
* Various other changes since VTR 7
165165

166166
### Fixed
167-
* FPGA Architecture file tags can be in arbitary orders
168-
* SDC command arguments can be in arbitary orders
167+
* FPGA Architecture file tags can be in arbitrary orders
168+
* SDC command arguments can be in arbitrary orders
169169
* Numerous other fixes since VTR 7
170170

171171
### Removed
@@ -229,7 +229,7 @@ $ sudo docker run -it mohamedelgammal/vtr8:latest
229229
* Improved a wide variety of error messages
230230
* Improved STA timing reports (more details, clearer format)
231231
* VPR now uses Tatum as its STA engine
232-
* VPR now detects missmatched architecture (.xml) and implementation (.net/.place/.route) files more robustly
232+
* VPR now detects mismatched architecture (.xml) and implementation (.net/.place/.route) files more robustly
233233
* Improved router run-time and quality through incremental re-routing and improved handling of high-fanout nets
234234
* The timing edges within each netlist primitive must now be specified in the <models> section of the architecture file
235235
* All interconnect tags must have unique names in the architecture file
@@ -245,8 +245,8 @@ $ sudo docker run -it mohamedelgammal/vtr8:latest
245245
* Various other changes since VTR 7
246246

247247
### Fixed
248-
* FPGA Architecture file tags can be in arbitary orders
249-
* SDC command arguments can be in arbitary orders
248+
* FPGA Architecture file tags can be in arbitrary orders
249+
* SDC command arguments can be in arbitrary orders
250250
* Numerous other fixes since VTR 7
251251

252252
### Deprecated

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If VTR does not support your use case, consider [filling an enhancement](#fillin
2727

2828
### I have a bug-fix/feature I'd like to include in VTR
2929
Great! Submitting bug-fixes and features is a great way to improve VTR.
30-
See the guidlines for [submitting code](#submitting-code-to-vtr).
30+
See the guidelines for [submitting code](#submitting-code-to-vtr).
3131

3232
## The Details
3333

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This is a simple wrapper which hides cmake (for convenience, and from non-expert end users).
22
#
33
# It supports the targets:
4-
# 'make' - builds everything (all libaries/executables)
4+
# 'make' - builds everything (all libraries/executables)
55
# 'make clean' - removes generated build objects/libraries/executables etc.
66
# 'make distclean' - will clean everything including the cmake generated build files
77
#

README.developers.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
For general guidance on contributing to VTR see [Submitting Code to VTR](CONTRIBUTING.md#submitting-code-to-vtr).
44

5-
The actual machanics of submitting code are outlined below.
5+
The actual mechanics of submitting code are outlined below.
66

77
However they differ slightly depending on whether you are:
88
* an **internal developer** (i.e. you have commit access to the main VTR repository at `github.com/verilog-to-routing/vtr-verilog-to-routing`) or,
@@ -149,7 +149,7 @@ To provide quick context, some VTR developers also tag the first line with the m
149149
## Commit Structure
150150
Generally, you should strive to keep commits atomic (i.e. they do one logical change to the code).
151151
This often means keeping commits small and focused in what they change.
152-
Of course, a large number of miniscule commits is also unhelpful (overwhelming and difficult to see the structure), and sometimes things can only be done in large changes -- so use your judgement.
152+
Of course, a large number of minuscule commits is also unhelpful (overwhelming and difficult to see the structure), and sometimes things can only be done in large changes -- so use your judgement.
153153
A reasonable rule of thumb is to try and ensure VTR will still compile after each commit.
154154
155155
For those familiar with history re-writing features in git (e.g. rebase) you can sometimes use these to clean-up your commit history after the fact.
@@ -627,7 +627,7 @@ stratixiv_arch.timing.xml cholesky_mc_stratixiv_arch_timing.blif 0208312
627627
```
628628

629629
### Example: NoC Benchmarks QoR Measurements
630-
NoC benchmarks currently include synthetic and MLP benchmarks. Synthetic benchmarks have various NoC traffic patters,
630+
NoC benchmarks currently include synthetic and MLP benchmarks. Synthetic benchmarks have various NoC traffic patterns,
631631
bandwidth utilization, and latency requirements. High-quality NoC router placement solutions for these benchmarks are
632632
known. By comparing the known solutions with NoC router placement results, the developer can evaluate the sanity of
633633
the NoC router placement algorithm. MLP benchmarks are the only realistic netlists included in this benchmark set.
@@ -702,7 +702,7 @@ The following table provides details on available Koios settings in VTR flow:
702702

703703
For more information refer to the [Koios benchmark home page](vtr_flow/benchmarks/verilog/koios/README.md).
704704

705-
To make running all the koios benchmarks easier, especially with thos circuits scattered between different tasks, there is an overall task list that runs all the 40 circuits of Koios as follows (this will run all the circuits with complex DSP functionality enabled. If you want to disable the complex DSP, edit the file to point to the `koios_*_no_hb` tasks):
705+
To make running all the koios benchmarks easier, especially with those circuits scattered between different tasks, there is an overall task list that runs all the 40 circuits of Koios as follows (this will run all the circuits with complex DSP functionality enabled. If you want to disable the complex DSP, edit the file to point to the `koios_*_no_hb` tasks):
706706

707707
```shell
708708
$ ../scripts/run_vtr_task.py -l koios_task_list.txt
@@ -1099,7 +1099,7 @@ Introduce a test case using the `TEST_CASE` macro, and include a name and a tag.
10991099
#include "catch2/catch_test_macros.hpp"
11001100
11011101
// To choose a tag (written with square brackets "[tag]"), see examples from when you run ./test_vpr
1102-
// --list-tests in the tester exectuable directory, as shown earlier. A good default tag name is the name
1102+
// --list-tests in the tester executable directory, as shown earlier. A good default tag name is the name
11031103
// of the tester: in this case, [vpr].
11041104
TEST_CASE("a_vpr_test_name", "[vpr]") {
11051105
int x = 0;
@@ -1467,7 +1467,7 @@ exists on a different branch).
14671467
commit.
14681468
14691469
5. Recreate the local changes from step 2 above, such that the library builds
1470-
without issue; preferrably in a concise way such that the library can be
1470+
without issue; preferably in a concise way such that the library can be
14711471
easily updated in the future.
14721472
14731473
## Adding a new Subtree

cmake/toolchains/mingw-linux-cross-compile-to-windows.cmake

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# the name of the target operating system
22
SET(CMAKE_SYSTEM_NAME Windows)
33

4-
option(STATIC_LIBGCC_LIBSTDCPP "Link to libgcc and libstdc++ statically. If not set, requires libgcc and libstdc++ DLLs to be installed on the target machines. Note that static linking libgcc means exceptions will not propagate accross shared library boundaries." OFF)
4+
option(STATIC_LIBGCC_LIBSTDCPP "Link to libgcc and libstdc++ statically. If not set, requires libgcc and libstdc++ DLLs to be installed on the target machines. Note that static linking libgcc means exceptions will not propagate across shared library boundaries." OFF)
55

66
#Note that if libgcc and libstdcpp are NOT statically linked the appropriate
77
#DLL's should be installed on the target Windows machine, or distributed with
8-
#the generated executables (e.g. in the same directory as the exectuable).
8+
#the generated executables (e.g. in the same directory as the executable).
99
#
1010
#They are usually installed under:
1111
# /usr/lib/gcc/${COMPILER_PEFIX}/*-win32/libgcc*.dll
1212
# /usr/lib/gcc/${COMPILER_PEFIX}/*-win32/libstdc++*.dll
1313
#
14-
#For example targetting x86_64 with MingW based on gcc 5.3
14+
#For example targeting x86_64 with MingW based on gcc 5.3
1515
# /usr/lib/gcc/x86_64-w64-mingw32/5.3-win32/libstdc++*.dll
1616
# /usr/lib/gcc/x86_64-w64-mingw32/5.3-win32/libgcc*.dll
1717

@@ -52,7 +52,7 @@ set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
5252
add_definitions(-DHAVE_STRUCT_TIMESPEC=1)
5353

5454
#This forces ABC to use the stdint types (e.g. ptrdiff_t) instead of its platform
55-
#dependant type look-up. This avoids 'unkown platform' compilation errors.
55+
#dependent type look-up. This avoids 'unkown platform' compilation errors.
5656
add_definitions(-DABC_USE_STDINT_H=1)
5757

5858
if (STATIC_LIBGCC_LIBSTDCPP)

dev/BROKEN_ENV/alpine/Dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ RUN git clone https://github.com/c9/core.git /cloud9
3434
RUN curl -s -L https://raw.githubusercontent.com/c9/install/master/link.sh | bash
3535
RUN /cloud9/scripts/install-sdk.sh
3636

37-
# Tweak standlone.js conf
37+
# Tweak standalone.js conf
3838
RUN sed -i -e 's_127.0.0.1_0.0.0.0_g' /cloud9/configs/standalone.js
3939

4040
RUN touch /etc/supervisor.conf
@@ -60,4 +60,4 @@ VOLUME /workspace
6060

6161
EXPOSE 8080
6262

63-
CMD ["supervisord", "-c", "/etc/supervisor.conf"]
63+
CMD ["supervisord", "-c", "/etc/supervisor.conf"]

dev/DOCKER_DEPLOY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Overview
44
Docker creates an isolated container on your system so you know that VTR will run without further configurations nor affecting any other work.
55

6-
Our Docker file sets up this enviroment by installing all necessary Linux packages and applications as well as Perl modules.
6+
Our Docker file sets up this environment by installing all necessary Linux packages and applications as well as Perl modules.
77

88
## Setup
99

@@ -38,7 +38,7 @@ The project root directory from the docker build process is copied and placed in
3838
docker exec -it vtr /bin/bash
3939
```
4040
41-
1. Verfiy that VTR has been installed correctly:
41+
1. Verify that VTR has been installed correctly:
4242
4343
```sh
4444
# in container

dev/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
This folder contains addtional development related tools and documentation
1+
This folder contains additional development related tools and documentation

dev/Running_On_ARM(raspberry_pi).txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ RUN apt-get install -y nodejs
3030
RUN git clone https://github.com/c9/core.git /cloud9
3131
RUN /cloud9/scripts/install-sdk.sh
3232

33-
# Tweak standlone.js conf
33+
# Tweak standalone.js conf
3434
RUN sed -i -e 's_127.0.0.1_0.0.0.0_g' /cloud9/configs/standalone.js

0 commit comments

Comments
 (0)