minor document fixups
Subsystems (8)
cover minor document fixups
This patch series is for minor document fixups. First five patches clean up and remove 'Other material' section of process/index in favor of 'staging/' and better place for docs on the section. A patch for adding DAMON maintainer-profile reference on maintainers' handbook follows. And then the last patch adds 'hkml' as one of available email tools on email-clients document.
SeongJae Park (7):
Docs/process/index: Remove unaligned-memory-access from 'Other
material'
Docs/process/index: Remove riscv/patch-acceptance from 'Other
material' section
Docs: Move magic-number from process to staging
Docs: Move clang-format from process/ to dev-tools/ Docs/process/index: Remove unsorted docs section Docs/maintainer/maintainer-entry-profile: add DAMON maintainer profile Docs/process/email-clients: Document HacKerMaiL
.clang-format | 2 +-
Documentation/{process => dev-tools}/clang-format.rst | 0
Documentation/dev-tools/index.rst | 1 +
Documentation/maintainer/maintainer-entry-profile.rst | 1 +
Documentation/process/4.Coding.rst | 2 +-
Documentation/process/coding-style.rst | 2 +-
Documentation/process/email-clients.rst | 9 +++++++++
Documentation/process/index.rst | 11 -----------
Documentation/staging/index.rst | 1 +
Documentation/{process => staging}/magic-number.rst | 0
.../translations/it_IT/process/clang-format.rst | 2 +-
.../translations/it_IT/process/magic-number.rst | 2 +-
.../translations/sp_SP/process/coding-style.rst | 2 +-
.../translations/sp_SP/process/magic-number.rst | 2 +-
Documentation/translations/zh_CN/process/4.Coding.rst | 2 +-
.../translations/zh_CN/process/coding-style.rst | 2 +-
.../translations/zh_CN/process/magic-number.rst | 2 +-
Documentation/translations/zh_TW/process/4.Coding.rst | 2 +-
.../translations/zh_TW/process/coding-style.rst | 2 +-
.../translations/zh_TW/process/magic-number.rst | 2 +-
20 files changed, 25 insertions(+), 24 deletions(-)
rename Documentation/{process => dev-tools}/clang-format.rst (100%)
rename Documentation/{process => staging}/magic-number.rst (100%)base-commit: 88407e61007a3d3ebb62fc65479cc58d891ef74e
Signature · 1 line
2.39.2
PATCH 1/7 Docs/process/index: Remove unaligned-memory-access from 'Other material'
'unaligned-memory-access document' is linked on 'Other material' section of 'core-api/index', which is for unsorted documents. But it is actually well organized under 'core-api/' directory, and linked on the 'core-api/index'. Remove it from 'Other material' section of 'process/index' document.
--- Documentation/process/index.rst | 1 - 1 file changed, 1 deletion(-)
Documentation/process/index.rst +0 -1
@@ -116,7 +116,6 @@ lack of a better place. magic-number clang-format ../arch/riscv/patch-acceptance - ../core-api/unaligned-memory-access .. only:: subproject and html
Signature · 1 line
2.39.2
PATCH 2/7 Docs/process/index: Remove riscv/patch-acceptance from 'Other material' section
In reply to SeongJae Park'patch-acceptance' on 'Other material' section of 'process/index', which is for unsorted documents, is actually well organized under 'arch/riscv/' directory, and linked on the index document of the directory. Remove it from the 'Other material' section.
--- Documentation/process/index.rst | 1 - 1 file changed, 1 deletion(-)
Documentation/process/index.rst +0 -1
@@ -115,7 +115,6 @@ lack of a better place. magic-number clang-format - ../arch/riscv/patch-acceptance .. only:: subproject and html
Signature · 1 line
2.39.2
PATCH 3/7 Docs: Move magic-number from process to staging
In reply to SeongJae Park'Other material' section on 'process/index' is for unsorted documents. However we also have a dedicated place for the purpose, 'staging/'. Move 'magic-number' from the section to 'staging/' directory.
---
Documentation/process/index.rst | 1 -
Documentation/staging/index.rst | 1 +
Documentation/{process => staging}/magic-number.rst | 0
Documentation/translations/it_IT/process/magic-number.rst | 2 +-
Documentation/translations/sp_SP/process/magic-number.rst | 2 +-
Documentation/translations/zh_CN/process/magic-number.rst | 2 +-
Documentation/translations/zh_TW/process/magic-number.rst | 2 +-
7 files changed, 5 insertions(+), 5 deletions(-)
rename Documentation/{process => staging}/magic-number.rst (100%)Documentation/process/index.rst +0 -1
@@ -113,7 +113,6 @@ lack of a better place. .. toctree:: :maxdepth: 1 - magic-number clang-format .. only:: subproject and html
Documentation/staging/index.rst +1 -0
@@ -8,6 +8,7 @@ Unsorted Documentation crc32 lzo + magic-number remoteproc rpmsg speculation
Documentation/staging/magic-number.rst renamed from Documentation/process/magic-number.rst +0 -0
Documentation/translations/it_IT/process/magic-number.rst +1 -1
@@ -1,6 +1,6 @@ .. include:: ../disclaimer-ita.rst -:Original: :ref:`Documentation/process/magic-number.rst <magicnumbers>` +:Original: :ref:`Documentation/staging/magic-number.rst <magicnumbers>` :Translator: Federico Vaga <[email protected]> .. _it_magicnumbers:
Documentation/translations/sp_SP/process/magic-number.rst +1 -1
@@ -1,6 +1,6 @@ .. include:: ../disclaimer-sp.rst -:Original: :ref:`Documentation/process/magic-number.rst <magicnumbers>` +:Original: :ref:`Documentation/staging/magic-number.rst <magicnumbers>` :Translator: Carlos Bilbao <[email protected]> .. _sp_magicnumbers:
Documentation/translations/zh_CN/process/magic-number.rst +1 -1
@@ -1,6 +1,6 @@ .. include:: ../disclaimer-zh_CN.rst -:Original: Documentation/process/magic-number.rst +:Original: Documentation/staging/magic-number.rst :翻译:
Documentation/translations/zh_TW/process/magic-number.rst +1 -1
@@ -4,7 +4,7 @@ .. include:: ../disclaimer-zh_TW.rst -:Original: :ref:`Documentation/process/magic-number.rst <magicnumbers>` +:Original: :ref:`Documentation/staging/magic-number.rst <magicnumbers>` 如果想評論或更新本文的內容,請直接發信到LKML。如果你使用英文交流有困難的話,也可 以向中文版維護者求助。如果本翻譯更新不及時或者翻譯存在問題,請聯繫中文版維護者::
Signature · 1 line
2.39.2
Re: [PATCH 3/7] Docs: Move magic-number from process to staging
Quoted 5 lines · SeongJae Park
'Other material' section on 'process/index' is for unsorted documents. However we also have a dedicated place for the purpose, 'staging/'. Move 'magic-number' from the section to 'staging/' directory.
Signed-off-by SeongJae Park <[email protected]>
Quoted 10 lines
---
Documentation/process/index.rst | 1 -
Documentation/staging/index.rst | 1 +
Documentation/{process => staging}/magic-number.rst | 0
Documentation/translations/it_IT/process/magic-number.rst | 2 +-
Documentation/translations/sp_SP/process/magic-number.rst | 2 +-
Documentation/translations/zh_CN/process/magic-number.rst | 2 +-
Documentation/translations/zh_TW/process/magic-number.rst | 2 +-
7 files changed, 5 insertions(+), 5 deletions(-)
rename Documentation/{process => staging}/magic-number.rst (100%)Good for me
Signature · 1 line
Federico Vaga
Jonathan Corbet
maintainerRe: [PATCH 3/7] Docs: Move magic-number from process to staging
In reply to SeongJae ParkQuoted 5 lines · SeongJae Park
'Other material' section on 'process/index' is for unsorted documents. However we also have a dedicated place for the purpose, 'staging/'. Move 'magic-number' from the section to 'staging/' directory.
Signed-off-by SeongJae Park <[email protected]>
Quoted 10 lines
---
Documentation/process/index.rst | 1 -
Documentation/staging/index.rst | 1 +
Documentation/{process => staging}/magic-number.rst | 0
Documentation/translations/it_IT/process/magic-number.rst | 2 +-
Documentation/translations/sp_SP/process/magic-number.rst | 2 +-
Documentation/translations/zh_CN/process/magic-number.rst | 2 +-
Documentation/translations/zh_TW/process/magic-number.rst | 2 +-
7 files changed, 5 insertions(+), 5 deletions(-)
rename Documentation/{process => staging}/magic-number.rst (100%)I'll apply this for now, but I really think that this file, which has little to say about Git-era kernels, should just be removed.
Thanks,
jon
PATCH 4/7 Docs: Move clang-format from process/ to dev-tools/
In reply to SeongJae Park'clang-format' is on 'Other material' section of 'process/index', but it may fit more under 'dev-tools/' directory. Move it.
---
.clang-format | 2 +-
Documentation/{process => dev-tools}/clang-format.rst | 0
Documentation/dev-tools/index.rst | 1 +
Documentation/process/4.Coding.rst | 2 +-
Documentation/process/coding-style.rst | 2 +-
Documentation/process/index.rst | 1 -
Documentation/translations/it_IT/process/clang-format.rst | 2 +-
Documentation/translations/sp_SP/process/coding-style.rst | 2 +-
Documentation/translations/zh_CN/process/4.Coding.rst | 2 +-
Documentation/translations/zh_CN/process/coding-style.rst | 2 +-
Documentation/translations/zh_TW/process/4.Coding.rst | 2 +-
Documentation/translations/zh_TW/process/coding-style.rst | 2 +-
12 files changed, 10 insertions(+), 10 deletions(-)
rename Documentation/{process => dev-tools}/clang-format.rst (100%).clang-format +1 -1
@@ -4,7 +4,7 @@ # # For more information, see: # -# Documentation/process/clang-format.rst +# Documentation/dev-tools/clang-format.rst # https://clang.llvm.org/docs/ClangFormat.html # https://clang.llvm.org/docs/ClangFormatStyleOptions.html #
Documentation/dev-tools/clang-format.rst renamed from Documentation/process/clang-format.rst +0 -0
Documentation/dev-tools/index.rst +1 -0
@@ -16,6 +16,7 @@ Documentation/dev-tools/testing-overview.rst testing-overview checkpatch + clang-format coccinelle sparse kcov
Documentation/process/4.Coding.rst +1 -1
@@ -63,7 +63,7 @@ these rules, to quickly re-format parts of your code automatically, and to review full files in order to spot coding style mistakes, typos and possible improvements. It is also handy for sorting ``#includes``, for aligning variables/macros, for reflowing text and other similar tasks. -See the file :ref:`Documentation/process/clang-format.rst <clangformat>` +See the file :ref:`Documentation/dev-tools/clang-format.rst <clangformat>` for more details. Some basic editor settings, such as indentation and line endings, will be
Documentation/process/coding-style.rst +1 -1
@@ -732,7 +732,7 @@ these rules, to quickly re-format parts of your code automatically, and to review full files in order to spot coding style mistakes, typos and possible improvements. It is also handy for sorting ``#includes``, for aligning variables/macros, for reflowing text and other similar tasks. -See the file :ref:`Documentation/process/clang-format.rst <clangformat>` +See the file :ref:`Documentation/dev-tools/clang-format.rst <clangformat>` for more details. Some basic editor settings, such as indentation and line endings, will be
Documentation/process/index.rst +0 -1
@@ -113,7 +113,6 @@ lack of a better place. .. toctree:: :maxdepth: 1 - clang-format .. only:: subproject and html
Documentation/translations/it_IT/process/clang-format.rst +1 -1
@@ -1,6 +1,6 @@ .. include:: ../disclaimer-ita.rst -:Original: :ref:`Documentation/process/clang-format.rst <clangformat>` +:Original: :ref:`Documentation/dev-tools/clang-format.rst <clangformat>` :Translator: Federico Vaga <[email protected]> .. _it_clangformat:
Documentation/translations/sp_SP/process/coding-style.rst +1 -1
@@ -754,7 +754,7 @@ código automáticamente, y revisar archivos completos para detectar errores de estilo del código, errores tipográficos y posibles mejoras. También es útil para ordenar ``#includes``, para alinear variables/macros, para redistribuir texto y otras tareas similares. Vea el archivo -:ref:`Documentation/process/clang-format.rst <clangformat>` para más +:ref:`Documentation/dev-tools/clang-format.rst <clangformat>` para más detalles. 10) Archivos de configuración de Kconfig
Documentation/translations/zh_CN/process/4.Coding.rst +1 -1
@@ -54,7 +54,7 @@ 注意您还可以使用 ``clang-format`` 工具来帮助您处理这些规则,快速自动重新格式 化部分代码,和审阅完整的文件以发现代码样式错误、拼写错误和可能的改进。它还 可以方便地排序 ``#includes`` 、对齐变量/宏、重排文本和其他类似任务。有关详细 -信息,请参阅文档 :ref:`Documentation/process/clang-format.rst <clangformat>` +信息,请参阅文档 :ref:`Documentation/dev-tools/clang-format.rst <clangformat>` 抽象层 ******
Documentation/translations/zh_CN/process/coding-style.rst +1 -1
@@ -654,7 +654,7 @@ Documentation/translations/zh_CN/doc-guide/index.rst 和 scripts/kernel-doc 。 请注意,您还可以使用 ``clang-format`` 工具帮助您处理这些规则,快速自动重新格 式化部分代码,并审阅整个文件以发现代码风格错误、打字错误和可能的改进。它还可 以方便地排序 ``#include`` ,对齐变量/宏,重排文本和其他类似任务。 -详见 Documentation/process/clang-format.rst 。 +详见 Documentation/dev-tools/clang-format.rst 。 10) Kconfig 配置文件
Documentation/translations/zh_TW/process/4.Coding.rst +1 -1
@@ -57,7 +57,7 @@ 注意您還可以使用 ``clang-format`` 工具來幫助您處理這些規則,快速自動重新格式 化部分代碼,和審閱完整的文件以發現代碼樣式錯誤、拼寫錯誤和可能的改進。它還 可以方便地排序 ``#includes`` 、對齊變量/宏、重排文本和其他類似任務。有關詳細 -信息,請參閱文檔 :ref:`Documentation/process/clang-format.rst <clangformat>` +信息,請參閱文檔 :ref:`Documentation/dev-tools/clang-format.rst <clangformat>` 抽象層 ******
Documentation/translations/zh_TW/process/coding-style.rst +1 -1
@@ -657,7 +657,7 @@ Documentation/translations/zh_CN/doc-guide/index.rst 和 scripts/kernel-doc 。 請注意,您還可以使用 ``clang-format`` 工具幫助您處理這些規則,快速自動重新格 式化部分代碼,並審閱整個文件以發現代碼風格錯誤、打字錯誤和可能的改進。它還可 以方便地排序 ``#include`` ,對齊變量/宏,重排文本和其他類似任務。 -詳見 Documentation/process/clang-format.rst 。 +詳見 Documentation/dev-tools/clang-format.rst 。 10) Kconfig 配置文件
Signature · 1 line
2.39.2
Re: [PATCH 4/7] Docs: Move clang-format from process/ to dev-tools/
Quoted 5 lines · SeongJae Park
'clang-format' is on 'Other material' section of 'process/index', but it may fit more under 'dev-tools/' directory. Move it.
Signed-off-by SeongJae Park <[email protected]>
Happy either way -- thanks!
Cheers,
Miguel
Re: [PATCH 4/7] Docs: Move clang-format from process/ to dev-tools/
In reply to SeongJae ParkQuoted 4 lines · SeongJae Park
'clang-format' is on 'Other material' section of 'process/index', but it may fit more under 'dev-tools/' directory. Move it.
Signed-off-by SeongJae Park <[email protected]>
Quoted 15 lines
---
.clang-format | 2 +-
Documentation/{process => dev-tools}/clang-format.rst | 0
Documentation/dev-tools/index.rst | 1 +
Documentation/process/4.Coding.rst | 2 +-
Documentation/process/coding-style.rst | 2 +-
Documentation/process/index.rst | 1 -
Documentation/translations/it_IT/process/clang-format.rst | 2 +-
Documentation/translations/sp_SP/process/coding-style.rst | 2 +-
Documentation/translations/zh_CN/process/4.Coding.rst | 2 +-
Documentation/translations/zh_CN/process/coding-style.rst | 2 +-
Documentation/translations/zh_TW/process/4.Coding.rst | 2 +-
Documentation/translations/zh_TW/process/coding-style.rst | 2 +-
12 files changed, 10 insertions(+), 10 deletions(-)
rename Documentation/{process => dev-tools}/clang-format.rst (100%)Good for me
Signature · 1 line
Federico Vaga
PATCH 5/7 Docs/process/index: Remove unsorted docs section
In reply to SeongJae Park'Other material' section on 'process/index' is no more necessary since we have 'staging/' directory. Also all documents on the section has moved to better places. Remove the section.
--- Documentation/process/index.rst | 7 ------- 1 file changed, 7 deletions(-)
Documentation/process/index.rst +0 -7
@@ -107,13 +107,6 @@ developers: kernel-docs deprecated -These are some overall technical guides that have been put here for now for -lack of a better place. - -.. toctree:: - :maxdepth: 1 - - .. only:: subproject and html Indices
Signature · 1 line
2.39.2
PATCH 6/7 Docs/maintainer/maintainer-entry-profile: add DAMON maintainer profile
In reply to SeongJae ParkDAMON has its maintainer entry profile document, but it's not listed on the existing profiles section of maintainer-entry-profile.rst. Add it.
--- Documentation/maintainer/maintainer-entry-profile.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/maintainer/maintainer-entry-profile.rst +1 -0
@@ -109,3 +109,4 @@ to do something different in the near future. ../driver-api/vfio-pci-device-specific-driver-acceptance ../nvme/feature-and-quirk-policy ../filesystems/xfs/xfs-maintainer-entry-profile + ../mm/damon/maintainer-profile
Signature · 1 line
2.39.2
PATCH 7/7 Docs/process/email-clients: Document HacKerMaiL
In reply to SeongJae ParkHacKerMaiL (hkml) [1] is a simple tool for mailing lists-based development workflows such as that for most Linux kernel subsystems. It is actively being maintained by DAMON maintainer, and recommended for DAMON community[2]. Add a simple introduction of the tool on the email-clients document, too.
[1] https://github.com/sjp38/hackermail
[2] https://lore.kernel.org/[email protected]
--- Documentation/process/email-clients.rst | 9 +++++++++ 1 file changed, 9 insertions(+)
Documentation/process/email-clients.rst +9 -0
@@ -350,3 +350,12 @@ although tab2space problem can be solved with external editor. Another problem is that Gmail will base64-encode any message that has a non-ASCII character. That includes things like European names. + +HacKerMaiL (TUI) +**************** + +HacKerMaiL (hkml) is a public-inbox based simple mails management tool that +doesn't require subscription of mailing lists. It is developed and maintained +by the DAMON maintainer and aims to support simple development workflows for +DAMON and general kernel subsystems. Refer to the README +(https://github.com/sjp38/hackermail/blob/master/README.md) for details.
Signature · 1 line
2.39.2
Re: [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL
Quoted 10 lines · SeongJae Park
HacKerMaiL (hkml) [1] is a simple tool for mailing lists-based development workflows such as that for most Linux kernel subsystems. It is actively being maintained by DAMON maintainer, and recommended for DAMON community[2]. Add a simple introduction of the tool on the email-clients document, too.
[1] https://github.com/sjp38/hackermail
[2] https://lore.kernel.org/[email protected]Signed-off-by SeongJae Park <[email protected]>
Thanks.
Quoted 21 lines
--- Documentation/process/email-clients.rst | 9 +++++++++ 1 file changed, 9 insertions(+)Documentation/process/email-clients.rst +9
-0@@ -350,3 +350,12 @@ although tab2space problem can be solved with external editor. Another problem is that Gmail will base64-encode any message that has a non-ASCII character. That includes things like European names. + +HacKerMaiL (TUI) +**************** + +HacKerMaiL (hkml) is a public-inbox based simple mails management tool that +doesn't require subscription of mailing lists. It is developed and maintained +by the DAMON maintainer and aims to support simple development workflows for +DAMON and general kernel subsystems. Refer to the README +(https://github.com/sjp38/hackermail/blob/master/README.md) for details.
Signature · 1 line
~Randy
Jonathan Corbet
maintainerRe: [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL
In reply to SeongJae ParkQuoted 6 lines · SeongJae Park
HacKerMaiL (hkml) [1] is a simple tool for mailing lists-based development workflows such as that for most Linux kernel subsystems. It is actively being maintained by DAMON maintainer, and recommended for DAMON community[2]. Add a simple introduction of the tool on the email-clients document, too.
Quoted 7 lines
[1] https://github.com/sjp38/hackermail
[2] https://lore.kernel.org/[email protected]Signed-off-by SeongJae Park <[email protected]>--- Documentation/process/email-clients.rst | 9 +++++++++ 1 file changed, 9 insertions(+)
We should really document lei as well if we're going to do this, but I won't try to insist on that here...:)
jon
Re: [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL
Quoted 11 lines · On Wed, 26 Jun 2024 16:35:49 -0600 Jonathan Corbet <[email protected]> wrote:
Quoted 9 lines · SeongJae Park
HacKerMaiL (hkml) [1] is a simple tool for mailing lists-based development workflows such as that for most Linux kernel subsystems. It is actively being maintained by DAMON maintainer, and recommended for DAMON community[2]. Add a simple introduction of the tool on the email-clients document, too.
[1] https://github.com/sjp38/hackermail
[2] https://lore.kernel.org/[email protected]
Quoted 6 lines
Quoted 4 lines
Signed-off-by SeongJae Park <[email protected]>--- Documentation/process/email-clients.rst | 9 +++++++++ 1 file changed, 9 insertions(+)We should really document lei as well
I'd also love that. But I cannot document lei here on my own since I don't know how to use it :'(
I might try again, but please don't wait for me.
Quoted 1 line
if we're going to do this, but I won't try to insist on that here...:)
Thank you for understanding, Jon! :)
Thanks,
SJ
[...]
Jonathan Corbet
maintainerQuoted 33 lines · SeongJae Park
This patch series is for minor document fixups. First five patches clean up and remove 'Other material' section of process/index in favor of 'staging/' and better place for docs on the section. A patch for adding DAMON maintainer-profile reference on maintainers' handbook follows. And then the last patch adds 'hkml' as one of available email tools on email-clients document.
SeongJae Park (7):
Docs/process/index: Remove unaligned-memory-access from 'Other
material'
Docs/process/index: Remove riscv/patch-acceptance from 'Other
material' section
Docs: Move magic-number from process to staging
Docs: Move clang-format from process/ to dev-tools/ Docs/process/index: Remove unsorted docs section Docs/maintainer/maintainer-entry-profile: add DAMON maintainer profile Docs/process/email-clients: Document HacKerMaiL.clang-format | 2 +- Documentation/{process => dev-tools}/clang-format.rst | 0 Documentation/dev-tools/index.rst | 1 + Documentation/maintainer/maintainer-entry-profile.rst | 1 + Documentation/process/4.Coding.rst | 2 +- Documentation/process/coding-style.rst | 2 +- Documentation/process/email-clients.rst | 9 +++++++++ Documentation/process/index.rst | 11 ----------- Documentation/staging/index.rst | 1 + Documentation/{process => staging}/magic-number.rst | 0 .../translations/it_IT/process/clang-format.rst | 2 +- .../translations/it_IT/process/magic-number.rst | 2 +- .../translations/sp_SP/process/coding-style.rst | 2 +- .../translations/sp_SP/process/magic-number.rst | 2 +- Documentation/translations/zh_CN/process/4.Coding.rst | 2 +-
Quoted 8 lines
.../translations/zh_CN/process/coding-style.rst | 2 +-
.../translations/zh_CN/process/magic-number.rst | 2 +-
Documentation/translations/zh_TW/process/4.Coding.rst | 2 +-
.../translations/zh_TW/process/coding-style.rst | 2 +-
.../translations/zh_TW/process/magic-number.rst | 2 +-
20 files changed, 25 insertions(+), 24 deletions(-)
rename Documentation/{process => dev-tools}/clang-format.rst (100%)
rename Documentation/{process => staging}/magic-number.rst (100%)Series applied, thanks.
jon