Skip to content

Commit ed5281b

Browse files
committed
user-manual: Minor changes in architecture
1 parent d8dfb09 commit ed5281b

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

user-manual/architecture.typ

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -191,17 +191,17 @@ Using the namespace path as the core path gives the following possibilities:
191191

192192
Sometimes a file with the `.hbs` extension is not a valid hbs file, or maybe you want to temporarily disable valid hbs files from being sourced.
193193
HBS provides a built-in mechanism for excluding files with the `.hbs` extension from being sourced.
194-
This is achieved using the `hbs::AddFileIgnoreRegex` function.
195-
You just have to call this function in one of valid hbs files.
196-
The function will be executed once the file containing the call is sourced.
194+
This is achieved using the `hbs::AddFileIgnoreRegex` proc.
195+
You just have to call this proc in one of valid hbs files.
196+
The proc will be executed once the file containing the call is sourced.
197197

198198
Usually the hbs file containing calls to the `hbs::AddFileIgnoreRegex` proc is placed in the project root directory.
199199
This is becuase hbs files placed in the project root directory are sourced before hbs files placed in subdirectories.
200200
Order of hbs files sourcing is described in @cores-and-cores-detection.
201201

202202
Arguments provided to the `hbs::AddFileIgnoreRegex` proc are treated as regular expressions.
203203
This allows for ignoring multiple paths using a single regex.
204-
However, you are free to provide multiple ignore regex, and all of them will be checked while sourcing hbs files.
204+
However, you are free to provide multiple ignore regexes, and all of them will be checked while sourcing hbs files.
205205

206206
=== Explicitly sourcing hbs files
207207

@@ -215,7 +215,7 @@ Simply use the Tcl built-in `source` command.
215215

216216
== Targets and targets detection
217217

218-
HBS automatically detects targets.
218+
The `hbs` automatically detects targets.
219219
Targets are all Tcl procedures defined in the scope of core namespaces (namespaces with a call to `hbs::Register`).
220220
However, to allow users to define custom utility procedures within cores, procedures with names starting with the floor character (`_`) are not treated as core targets.
221221
The following snippet presents an example edge detector core definition:
@@ -254,16 +254,16 @@ The `_tb` procedure calls the `src` procedure because the `edge_detector.vhd` fi
254254

255255
All targets are represented by a unique target path.
256256
Target path consists of the core path and target name.
257-
For example, the `src` target of the edge detector has the following path `vhdl::simple::edge-detector::src`.
257+
For example, the `src` target of the edge detector has the following target path `vhdl::simple::edge-detector::src`.
258258

259259

260260
== Testbench targets
261261

262-
HBS is capable of automatically detecting testbench targets.
262+
The `hbs` is capable of automatically detecting testbench targets.
263263
Testbench targets are targets which names:
264-
+ start with the `tb-` or `tb_` prefix,
265-
+ end with the `-tb` or `_tb` suffix,
266-
+ equal `tb`.
264+
+ start with the `"tb-"` or `"tb_"` prefix,
265+
+ end with the `"-tb"` or `"_tb"` suffix,
266+
+ equal `"tb"`.
267267

268268
For example, for the following hbs file:
269269
```tcl
@@ -291,7 +291,7 @@ my-core::tb_my
291291

292292
== Running targets <arch-running-targets>
293293

294-
HBS allows running any target of registered cores.
294+
The `hbs` allows running any target of registered cores.
295295
Even if the target itself has nothing to do with the hardware design.
296296
For example, running target `print` from the following snippet:
297297
```tcl
@@ -358,8 +358,8 @@ The target context assures that the following variables are not affected by depe
358358
+ HDL library,
359359
+ HDL standard,
360360
+ top module name,
361-
+ arguments prefix,
362-
+ arguments suffix,
361+
+ argument prefix,
362+
+ argument suffix,
363363
+ the core path,
364364
+ the core name,
365365
+ the target path,

user-manual/hbs-user-manual.pdf

470 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)