diff mbox series

doc: module: update file references

Message ID 20220613081741.1699713-1-masahiroy@kernel.org (mailing list archive)
State New, archived
Headers show
Series doc: module: update file references | expand

Commit Message

Masahiro Yamada June 13, 2022, 8:17 a.m. UTC
Adjust documents to the file moves made by commit cfc1d277891e ("module:
Move all into module/").

Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
---

I did not touch

  Documentation/translations/zh_CN/core-api/kernel-api.rst

because I cannot modify it.

 Documentation/core-api/kernel-api.rst                  |  2 +-
 Documentation/core-api/symbol-namespaces.rst           |  4 ++--
 Documentation/livepatch/module-elf-format.rst          | 10 +++++-----
 .../translations/it_IT/core-api/symbol-namespaces.rst  |  6 +++---
 .../translations/zh_CN/core-api/symbol-namespaces.rst  |  2 +-
 5 files changed, 12 insertions(+), 12 deletions(-)

Comments

Yanteng Si June 14, 2022, 12:28 p.m. UTC | #1
On 2022/6/13 下午4:17, Masahiro Yamada wrote:
> Adjust documents to the file moves made by commit cfc1d277891e ("module:
> Move all into module/").
> 
> Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
Acked-by: Yanteng Si <siyanteng@loongson.cn>
> ---
> 
> I did not touch
> 
>    Documentation/translations/zh_CN/core-api/kernel-api.rst
diff --git a/Documentation/translations/zh_CN/core-api/kernel-api.rst 
b/Documentation/translations/zh_CN/core-api/kernel-api.rst
index e45fe80d1cd8..962d31d019d7 100644
--- a/Documentation/translations/zh_CN/core-api/kernel-api.rst
+++ b/Documentation/translations/zh_CN/core-api/kernel-api.rst
@@ -224,7 +224,7 @@ kernel/kmod.c
  模块接口支持
  ------------

-更多信息请参考文件kernel/module.c。
+更多信息请参阅kernel/module/目录下的文件。

  硬件接口
  ========

> 
> because I cannot modify it.Let me help you, it's my pleasure.  :)

Thanks,
Yanteng
> 
>   Documentation/core-api/kernel-api.rst                  |  2 +-
>   Documentation/core-api/symbol-namespaces.rst           |  4 ++--
>   Documentation/livepatch/module-elf-format.rst          | 10 +++++-----
>   .../translations/it_IT/core-api/symbol-namespaces.rst  |  6 +++---
>   .../translations/zh_CN/core-api/symbol-namespaces.rst  |  2 +-
>   5 files changed, 12 insertions(+), 12 deletions(-)
> 
> diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst
> index d6b3f94b9f1f..0793c400d4b0 100644
> --- a/Documentation/core-api/kernel-api.rst
> +++ b/Documentation/core-api/kernel-api.rst
> @@ -223,7 +223,7 @@ Module Loading
>   Inter Module support
>   --------------------
>   
> -Refer to the file kernel/module.c for more information.
> +Refer to the files in kernel/module/ for more information.
>   
>   Hardware Interfaces
>   ===================
> diff --git a/Documentation/core-api/symbol-namespaces.rst b/Documentation/core-api/symbol-namespaces.rst
> index 5ad9e0abe42c..12e4aecdae94 100644
> --- a/Documentation/core-api/symbol-namespaces.rst
> +++ b/Documentation/core-api/symbol-namespaces.rst
> @@ -51,8 +51,8 @@ namespace ``USB_STORAGE``, use::
>   The corresponding ksymtab entry struct ``kernel_symbol`` will have the member
>   ``namespace`` set accordingly. A symbol that is exported without a namespace will
>   refer to ``NULL``. There is no default namespace if none is defined. ``modpost``
> -and kernel/module.c make use the namespace at build time or module load time,
> -respectively.
> +and kernel/module/main.c make use the namespace at build time or module load
> +time, respectively.
>   
>   2.2 Using the DEFAULT_SYMBOL_NAMESPACE define
>   =============================================
> diff --git a/Documentation/livepatch/module-elf-format.rst b/Documentation/livepatch/module-elf-format.rst
> index dbe9b400e39f..7347638895a0 100644
> --- a/Documentation/livepatch/module-elf-format.rst
> +++ b/Documentation/livepatch/module-elf-format.rst
> @@ -210,11 +210,11 @@ module->symtab.
>   =====================================
>   Normally, a stripped down copy of a module's symbol table (containing only
>   "core" symbols) is made available through module->symtab (See layout_symtab()
> -in kernel/module.c). For livepatch modules, the symbol table copied into memory
> -on module load must be exactly the same as the symbol table produced when the
> -patch module was compiled. This is because the relocations in each livepatch
> -relocation section refer to their respective symbols with their symbol indices,
> -and the original symbol indices (and thus the symtab ordering) must be
> +in kernel/module/kallsyms.c). For livepatch modules, the symbol table copied
> +into memory on module load must be exactly the same as the symbol table produced
> +when the patch module was compiled. This is because the relocations in each
> +livepatch relocation section refer to their respective symbols with their symbol
> +indices, and the original symbol indices (and thus the symtab ordering) must be
>   preserved in order for apply_relocate_add() to find the right symbol.
>   
>   For example, take this particular rela from a livepatch module:::
> diff --git a/Documentation/translations/it_IT/core-api/symbol-namespaces.rst b/Documentation/translations/it_IT/core-api/symbol-namespaces.rst
> index 42f5d04e38ec..0f6898860d6d 100644
> --- a/Documentation/translations/it_IT/core-api/symbol-namespaces.rst
> +++ b/Documentation/translations/it_IT/core-api/symbol-namespaces.rst
> @@ -50,9 +50,9 @@ Di conseguenza, nella tabella dei simboli del kernel ci sarà una voce
>   rappresentata dalla struttura ``kernel_symbol`` che avrà il campo
>   ``namespace`` (spazio dei nomi) impostato. Un simbolo esportato senza uno spazio
>   dei nomi avrà questo campo impostato a ``NULL``. Non esiste uno spazio dei nomi
> -di base. Il programma ``modpost`` e il codice in kernel/module.c usano lo spazio
> -dei nomi, rispettivamente, durante la compilazione e durante il caricamento
> -di un modulo.
> +di base. Il programma ``modpost`` e il codice in kernel/module/main.c usano lo
> +spazio dei nomi, rispettivamente, durante la compilazione e durante il
> +caricamento di un modulo.
>   
>   2.2 Usare il simbolo di preprocessore DEFAULT_SYMBOL_NAMESPACE
>   ==============================================================
> diff --git a/Documentation/translations/zh_CN/core-api/symbol-namespaces.rst b/Documentation/translations/zh_CN/core-api/symbol-namespaces.rst
> index 6abf7ed534ca..bb16f0611046 100644
> --- a/Documentation/translations/zh_CN/core-api/symbol-namespaces.rst
> +++ b/Documentation/translations/zh_CN/core-api/symbol-namespaces.rst
> @@ -52,7 +52,7 @@
>   
>   相应的 ksymtab 条目结构体 ``kernel_symbol`` 将有相应的成员 ``命名空间`` 集。
>   导出时未指明命名空间的符号将指向 ``NULL`` 。如果没有定义命名空间,则默认没有。
> -``modpost`` 和kernel/module.c分别在构建时或模块加载时使用名称空间。
> +``modpost`` 和kernel/module/main.c分别在构建时或模块加载时使用名称空间。
>   
>   2.2 使用DEFAULT_SYMBOL_NAMESPACE定义
>   ====================================
>
Masahiro Yamada June 14, 2022, 9:32 p.m. UTC | #2
On Tue, Jun 14, 2022 at 9:28 PM Yanteng Si <siyanteng@loongson.cn> wrote:
>
> On 2022/6/13 下午4:17, Masahiro Yamada wrote:
> > Adjust documents to the file moves made by commit cfc1d277891e ("module:
> > Move all into module/").
> >
> > Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
> Acked-by: Yanteng Si <siyanteng@loongson.cn>
> > ---
> >
> > I did not touch
> >
> >    Documentation/translations/zh_CN/core-api/kernel-api.rst
> diff --git a/Documentation/translations/zh_CN/core-api/kernel-api.rst
> b/Documentation/translations/zh_CN/core-api/kernel-api.rst
> index e45fe80d1cd8..962d31d019d7 100644
> --- a/Documentation/translations/zh_CN/core-api/kernel-api.rst
> +++ b/Documentation/translations/zh_CN/core-api/kernel-api.rst
> @@ -224,7 +224,7 @@ kernel/kmod.c
>   模块接口支持
>   ------------
>
> -更多信息请参考文件kernel/module.c。
> +更多信息请参阅kernel/module/目录下的文件。
>
>   硬件接口
>   ========
>
> >
> > because I cannot modify it.Let me help you, it's my pleasure.  :)


Thank you very much!

I will send v2 with the update.
Luis Chamberlain July 1, 2022, 9:48 p.m. UTC | #3
On Mon, Jun 13, 2022 at 05:17:40PM +0900, Masahiro Yamada wrote:
> Adjust documents to the file moves made by commit cfc1d277891e ("module:
> Move all into module/").
> 
> Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>

Queued up, thanks!

  Luis
Luis Chamberlain July 1, 2022, 9:49 p.m. UTC | #4
On Fri, Jul 01, 2022 at 02:48:58PM -0700, Luis Chamberlain wrote:
> On Mon, Jun 13, 2022 at 05:17:40PM +0900, Masahiro Yamada wrote:
> > Adjust documents to the file moves made by commit cfc1d277891e ("module:
> > Move all into module/").
> > 
> > Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
> 
> Queued up, thanks!

Sorry, missed the v2, taking that.

  Luis
diff mbox series

Patch

diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst
index d6b3f94b9f1f..0793c400d4b0 100644
--- a/Documentation/core-api/kernel-api.rst
+++ b/Documentation/core-api/kernel-api.rst
@@ -223,7 +223,7 @@  Module Loading
 Inter Module support
 --------------------
 
-Refer to the file kernel/module.c for more information.
+Refer to the files in kernel/module/ for more information.
 
 Hardware Interfaces
 ===================
diff --git a/Documentation/core-api/symbol-namespaces.rst b/Documentation/core-api/symbol-namespaces.rst
index 5ad9e0abe42c..12e4aecdae94 100644
--- a/Documentation/core-api/symbol-namespaces.rst
+++ b/Documentation/core-api/symbol-namespaces.rst
@@ -51,8 +51,8 @@  namespace ``USB_STORAGE``, use::
 The corresponding ksymtab entry struct ``kernel_symbol`` will have the member
 ``namespace`` set accordingly. A symbol that is exported without a namespace will
 refer to ``NULL``. There is no default namespace if none is defined. ``modpost``
-and kernel/module.c make use the namespace at build time or module load time,
-respectively.
+and kernel/module/main.c make use the namespace at build time or module load
+time, respectively.
 
 2.2 Using the DEFAULT_SYMBOL_NAMESPACE define
 =============================================
diff --git a/Documentation/livepatch/module-elf-format.rst b/Documentation/livepatch/module-elf-format.rst
index dbe9b400e39f..7347638895a0 100644
--- a/Documentation/livepatch/module-elf-format.rst
+++ b/Documentation/livepatch/module-elf-format.rst
@@ -210,11 +210,11 @@  module->symtab.
 =====================================
 Normally, a stripped down copy of a module's symbol table (containing only
 "core" symbols) is made available through module->symtab (See layout_symtab()
-in kernel/module.c). For livepatch modules, the symbol table copied into memory
-on module load must be exactly the same as the symbol table produced when the
-patch module was compiled. This is because the relocations in each livepatch
-relocation section refer to their respective symbols with their symbol indices,
-and the original symbol indices (and thus the symtab ordering) must be
+in kernel/module/kallsyms.c). For livepatch modules, the symbol table copied
+into memory on module load must be exactly the same as the symbol table produced
+when the patch module was compiled. This is because the relocations in each
+livepatch relocation section refer to their respective symbols with their symbol
+indices, and the original symbol indices (and thus the symtab ordering) must be
 preserved in order for apply_relocate_add() to find the right symbol.
 
 For example, take this particular rela from a livepatch module:::
diff --git a/Documentation/translations/it_IT/core-api/symbol-namespaces.rst b/Documentation/translations/it_IT/core-api/symbol-namespaces.rst
index 42f5d04e38ec..0f6898860d6d 100644
--- a/Documentation/translations/it_IT/core-api/symbol-namespaces.rst
+++ b/Documentation/translations/it_IT/core-api/symbol-namespaces.rst
@@ -50,9 +50,9 @@  Di conseguenza, nella tabella dei simboli del kernel ci sarà una voce
 rappresentata dalla struttura ``kernel_symbol`` che avrà il campo
 ``namespace`` (spazio dei nomi) impostato. Un simbolo esportato senza uno spazio
 dei nomi avrà questo campo impostato a ``NULL``. Non esiste uno spazio dei nomi
-di base. Il programma ``modpost`` e il codice in kernel/module.c usano lo spazio
-dei nomi, rispettivamente, durante la compilazione e durante il caricamento
-di un modulo.
+di base. Il programma ``modpost`` e il codice in kernel/module/main.c usano lo
+spazio dei nomi, rispettivamente, durante la compilazione e durante il
+caricamento di un modulo.
 
 2.2 Usare il simbolo di preprocessore DEFAULT_SYMBOL_NAMESPACE
 ==============================================================
diff --git a/Documentation/translations/zh_CN/core-api/symbol-namespaces.rst b/Documentation/translations/zh_CN/core-api/symbol-namespaces.rst
index 6abf7ed534ca..bb16f0611046 100644
--- a/Documentation/translations/zh_CN/core-api/symbol-namespaces.rst
+++ b/Documentation/translations/zh_CN/core-api/symbol-namespaces.rst
@@ -52,7 +52,7 @@ 
 
 相应的 ksymtab 条目结构体 ``kernel_symbol`` 将有相应的成员 ``命名空间`` 集。
 导出时未指明命名空间的符号将指向 ``NULL`` 。如果没有定义命名空间,则默认没有。
-``modpost`` 和kernel/module.c分别在构建时或模块加载时使用名称空间。
+``modpost`` 和kernel/module/main.c分别在构建时或模块加载时使用名称空间。
 
 2.2 使用DEFAULT_SYMBOL_NAMESPACE定义
 ====================================