Skip to content

Commit f3017a4

Browse files
yashicfriedt
authored andcommitted
doc: kernel: services: interrupts: Add markup for generated files
Apply `:file:` markup to file names in the "Files generated by the script" section under "Implementation Details" to improve clarity and readability. Signed-off-by: Yasushi SHOJI <[email protected]>
1 parent 555590e commit f3017a4

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/kernel/services/interrupts.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -689,16 +689,16 @@ Files generated by the script
689689
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
690690

691691
The interrupt tables generator script creates 3 files:
692-
isr_tables.c, isr_tables_swi.ld, and isr_tables_vt.ld.
692+
:file:`isr_tables.c`, :file:`isr_tables_swi.ld`, and :file:`isr_tables_vt.ld`.
693693

694-
The isr_tables.c will contain all the structures for interrupts, direct interrupts and
694+
The :file:`isr_tables.c` will contain all the structures for interrupts, direct interrupts and
695695
shared interrupts (if enabled). This file implements only all the structures that
696696
are not implemented by the application, leaving a comment where the interrupt
697697
not implemented here can be found.
698698

699-
Then two linker files are used. The isr_tables_vt.ld file is included in place
699+
Then two linker files are used. The :file:`isr_tables_vt.ld` file is included in place
700700
where the interrupt vectors are required to be placed in the selected architecture.
701-
The isr_tables_swi.ld file describes the placement of the software interrupt table
701+
The :file:`isr_tables_swi.ld` file describes the placement of the software interrupt table
702702
elements. The separated file is required as it might be placed in writable on nonwritable
703703
section, depending on the current configuration.
704704

0 commit comments

Comments
 (0)