Skip to content

Commit 8e753c1

Browse files
authored
docs: fix typos in documentation files (#962)
Correct spelling errors in CONTRIBUTING.adoc, README files, and IDL documentation: - Fix "identifer" to "identifier" in CONTRIBUTING.adoc - Fix "numer" to "number" in CONTRIBUTING.adoc - Fix "Bug reports" to "Feature requests" in feature request section - Fix "backend" to "backends" in portfolio templates README - Fix "both share inherit" to "both inherit" in IDL documentation - Fix duplicated "former" to "former"/"latter" in struct description Clean up. Signed-off-by: Afonso Oliveira <[email protected]>
1 parent acab81b commit 8e753c1

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

CONTRIBUTING.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Bug reports should be filed as a https://github.com/riscv-software-src/riscv-uni
1111

1212
=== Feature Requests
1313

14-
Bug reports should be filed as a https://github.com/riscv-software-src/riscv-unified-db/issues[GitHub Issue] using the `Feature request` template.
14+
Feature requests should be filed as a https://github.com/riscv-software-src/riscv-unified-db/issues[GitHub Issue] using the `Feature request` template.
1515

1616
=== Bug Fixes
1717

@@ -105,7 +105,7 @@ When a commit will close a GitHub Issue, it should be noted in the footer:
105105

106106
```
107107
Fixes #<issue number>
108-
Closes #<issue numer>
108+
Closes #<issue number>
109109
```
110110

111111
==== Git trailers
@@ -170,7 +170,7 @@ Under special circumstances code may be added under a different license.
170170
For example, code from an existing project may be integrated after careful deliberation.
171171
Any contributions under a different license will receive extra review.
172172
When any contribution is made under a different license, it must be tracked using
173-
https://reuse.software/tutorial/#step-2[a Reuse-compatible identifer].
173+
https://reuse.software/tutorial/#step-2[a Reuse-compatible identifier].
174174

175175
To keep UnifiedDB open to both private and commercial interests, contributions under a
176176
https://en.wikipedia.org/wiki/copyleft[copyleft license] will never be accepted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
This directory contains partial ERB templates shared by multiple portfolio-based backend.
1+
This directory contains partial ERB templates shared by multiple portfolio-based backends.

doc/idl.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The RISC-V ISA functionality is formally described in a domain specific language called ISA Description Language (IDL). The language is intended to be:
55

66
* *Human readable* so that it can serve as a reliable documentation source.
7-
* *Familiar* to both hardware and software designers. For that reason, the syntax resembles a mix of Verilog and C++ (which both share inherit a C-like syntax).
7+
* *Familiar* to both hardware and software designers. For that reason, the syntax resembles a mix of Verilog and C++ (which both inherit a C-like syntax).
88
* *Strongly typed* to reduce ambiguity as a documentation source.
99
* *Modular* to reflect RISC-V's modular ISA structure. IDL can describe a wide range of devices, and then be customized with configuration variables to generate an implementation-specific description.
1010

@@ -239,7 +239,7 @@ Bits<2> pbmt = pte.PBMT;
239239

240240
==== Structs
241241

242-
A struct is a collection of unrelated types, similar to a `struct` in C/C++ or Verilog. Structs are declared using the `struct` keyword. Struct names must begin with a capital letter. Struct members can begin with either lowercase or uppercase; in the former, the member is mutable and in the former the member is const. Struct members may be any type, including other structs.
242+
A struct is a collection of unrelated types, similar to a `struct` in C/C++ or Verilog. Structs are declared using the `struct` keyword. Struct names must begin with a capital letter. Struct members can begin with either lowercase or uppercase; in the former, the member is mutable and in the latter the member is const. Struct members may be any type, including other structs.
243243

244244
Struct declarations do _not_ need to be followed by a semicolon (as they are in C/C++).
245245

0 commit comments

Comments
 (0)