Skip to content

doc: arch: Update file summary for kernel interfaces #90970

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion include/zephyr/arch/arc/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*
* This header contains the ARC specific kernel interface. It is
* included by the kernel interface architecture-abstraction header
* include/arch/cpu.h)
* (include/zephyr/arch/cpu.h).
*/

#ifndef ZEPHYR_INCLUDE_ARCH_ARC_ARCH_H_
Expand Down
2 changes: 1 addition & 1 deletion include/zephyr/arch/arm/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*
* This header contains the ARM AArch32 specific kernel interface. It is
* included by the kernel interface architecture-abstraction header
* (include/arm/cpu.h)
* (include/zephyr/arch/cpu.h).
*/

#ifndef ZEPHYR_INCLUDE_ARCH_ARM_ARCH_H_
Expand Down
2 changes: 1 addition & 1 deletion include/zephyr/arch/arm64/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*
* This header contains the ARM64 specific kernel interface. It is
* included by the kernel interface architecture-abstraction header
* (include/arm64/cpu.h)
* (include/zephyr/arch/cpu.h).
*/

#ifndef ZEPHYR_INCLUDE_ARCH_ARM64_ARCH_H_
Expand Down
9 changes: 9 additions & 0 deletions include/zephyr/arch/mips/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@
* SPDX-License-Identifier: Apache-2.0
*/

/**
* @file
* @brief MIPS specific kernel interface header
*
* This header contains the MIPS specific kernel interface. It is
* included by the kernel interface architecture-abstraction header
* (include/zephyr/arch/cpu.h).
*/

#ifndef ZEPHYR_INCLUDE_ARCH_MIPS_ARCH_H_
#define ZEPHYR_INCLUDE_ARCH_MIPS_ARCH_H_

Expand Down
6 changes: 3 additions & 3 deletions include/zephyr/arch/posix/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
/**
* @file
* @brief POSIX arch specific kernel interface header
* This header contains the POSIX arch specific kernel interface.
* It is included by the generic kernel interface header (include/arch/cpu.h)
*
* This header contains the POSIX arch specific kernel interface. It is
* included by the kernel interface architecture-abstraction header
* (include/zephyr/arch/cpu.h).
*/


#ifndef ZEPHYR_INCLUDE_ARCH_POSIX_ARCH_H_
#define ZEPHYR_INCLUDE_ARCH_POSIX_ARCH_H_

Expand Down
4 changes: 3 additions & 1 deletion include/zephyr/arch/riscv/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@
/**
* @file
* @brief RISCV specific kernel interface header
*
* This header contains the RISCV specific kernel interface. It is
* included by the generic kernel interface header (arch/cpu.h)
* included by the kernel interface architecture-abstraction header
* (include/zephyr/arch/cpu.h).
*/

#ifndef ZEPHYR_INCLUDE_ARCH_RISCV_ARCH_H_
Expand Down
9 changes: 9 additions & 0 deletions include/zephyr/arch/rx/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@
* SPDX-License-Identifier: Apache-2.0
*/

/**
* @file
* @brief Renesas RX specific kernel interface header
*
* This header contains the Renesas RX specific kernel interface. It is
* included by the kernel interface architecture-abstraction header
* (include/zephyr/arch/cpu.h).
*/

#ifndef ZEPHYR_INCLUDE_ARCH_RX_ARCH_H_
#define ZEPHYR_INCLUDE_ARCH_RX_ARCH_H_

Expand Down
4 changes: 3 additions & 1 deletion include/zephyr/arch/sparc/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@
/**
* @file
* @brief SPARC specific kernel interface header
*
* This header contains the SPARC specific kernel interface. It is
* included by the generic kernel interface header (arch/cpu.h)
* included by the kernel interface architecture-abstraction header
* (include/zephyr/arch/cpu.h).
*/

#ifndef ZEPHYR_INCLUDE_ARCH_SPARC_ARCH_H_
Expand Down
9 changes: 9 additions & 0 deletions include/zephyr/arch/x86/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@
* SPDX-License-Identifier: Apache-2.0
*/

/**
* @file
* @brief X86 specific kernel interface header
*
* This header contains the X86 specific kernel interfaces for both
* IA-32 and Intel-64. It is included by the kernel interface
* architecture-abstraction header (include/zephyr/arch/cpu.h).
*/

#ifndef ZEPHYR_INCLUDE_ARCH_X86_ARCH_H_
#define ZEPHYR_INCLUDE_ARCH_X86_ARCH_H_

Expand Down
5 changes: 3 additions & 2 deletions include/zephyr/arch/x86/ia32/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
/**
* @file
* @brief IA-32 specific kernel interface header
* This header contains the IA-32 specific kernel interface. It is included
* by the generic kernel interface header (include/arch/cpu.h)
*
* This header contains the IA-32 portion of the X86 specific kernel
* interface (see include/zephyr/arch/x86/cpu.h).
*/

#ifndef ZEPHYR_INCLUDE_ARCH_X86_IA32_ARCH_H_
Expand Down
8 changes: 8 additions & 0 deletions include/zephyr/arch/x86/intel64/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
* SPDX-License-Identifier: Apache-2.0
*/

/**
* @file
* @brief Intel-64 specific kernel interface header
*
* This header contains the Intel-64 portion of the X86 specific kernel
* interface (see include/zephyr/arch/x86/cpu.h).
*/

#ifndef ZEPHYR_INCLUDE_ARCH_X86_INTEL64_ARCH_H_
#define ZEPHYR_INCLUDE_ARCH_X86_INTEL64_ARCH_H_

Expand Down
6 changes: 4 additions & 2 deletions include/zephyr/arch/xtensa/arch.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@
/**
* @file
* @brief Xtensa specific kernel interface header
* This header contains the Xtensa specific kernel interface. It is included
* by the generic kernel interface header (include/zephyr/arch/cpu.h)
*
* This header contains the Xtensa specific kernel interface. It is
* included by the kernel interface architecture-abstraction header
* (include/zephyr/arch/cpu.h).
*/

#ifndef ZEPHYR_INCLUDE_ARCH_XTENSA_ARCH_H_
Expand Down