workflows.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/7] minor document fixups
@ 2024-06-24 18:53 SeongJae Park
  2024-06-24 18:53 ` [PATCH 1/7] Docs/process/index: Remove unaligned-memory-access from 'Other material' SeongJae Park
                   ` (7 more replies)
  0 siblings, 8 replies; 16+ messages in thread
From: SeongJae Park @ 2024-06-24 18:53 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: SeongJae Park, Albert Ou, Alex Shi, Avadhut Naik, Bill Wendling,
	Carlos Bilbao, Federico Vaga, Hu Haowen, Justin Stitt,
	Miguel Ojeda, Nathan Chancellor, Nick Desaulniers, Palmer Dabbelt,
	Paul Walmsley, Yanteng Si, linux-doc, linux-riscv, llvm,
	workflows, linux-kernel

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
-- 
2.39.2


^ permalink raw reply	[flat|nested] 16+ messages in thread

* [PATCH 1/7] Docs/process/index: Remove unaligned-memory-access from 'Other material'
  2024-06-24 18:53 [PATCH 0/7] minor document fixups SeongJae Park
@ 2024-06-24 18:53 ` SeongJae Park
  2024-06-24 18:53 ` [PATCH 2/7] Docs/process/index: Remove riscv/patch-acceptance from 'Other material' section SeongJae Park
                   ` (6 subsequent siblings)
  7 siblings, 0 replies; 16+ messages in thread
From: SeongJae Park @ 2024-06-24 18:53 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: SeongJae Park, workflows, linux-doc, linux-kernel

'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.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/process/index.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst
index de9cbb7bd7eb..f66f9cbd0300 100644
--- a/Documentation/process/index.rst
+++ b/Documentation/process/index.rst
@@ -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
 
-- 
2.39.2


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH 2/7] Docs/process/index: Remove riscv/patch-acceptance from 'Other material' section
  2024-06-24 18:53 [PATCH 0/7] minor document fixups SeongJae Park
  2024-06-24 18:53 ` [PATCH 1/7] Docs/process/index: Remove unaligned-memory-access from 'Other material' SeongJae Park
@ 2024-06-24 18:53 ` SeongJae Park
  2024-06-24 18:53 ` [PATCH 3/7] Docs: Move magic-number from process to staging SeongJae Park
                   ` (5 subsequent siblings)
  7 siblings, 0 replies; 16+ messages in thread
From: SeongJae Park @ 2024-06-24 18:53 UTC (permalink / raw)
  To: Jonathan Corbet, Paul Walmsley, Palmer Dabbelt, Albert Ou
  Cc: SeongJae Park, workflows, linux-doc, linux-kernel, linux-riscv

'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.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/process/index.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst
index f66f9cbd0300..08b4eb1e9118 100644
--- a/Documentation/process/index.rst
+++ b/Documentation/process/index.rst
@@ -115,7 +115,6 @@ lack of a better place.
 
    magic-number
    clang-format
-   ../arch/riscv/patch-acceptance
 
 .. only::  subproject and html
 
-- 
2.39.2


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH 3/7] Docs: Move magic-number from process to staging
  2024-06-24 18:53 [PATCH 0/7] minor document fixups SeongJae Park
  2024-06-24 18:53 ` [PATCH 1/7] Docs/process/index: Remove unaligned-memory-access from 'Other material' SeongJae Park
  2024-06-24 18:53 ` [PATCH 2/7] Docs/process/index: Remove riscv/patch-acceptance from 'Other material' section SeongJae Park
@ 2024-06-24 18:53 ` SeongJae Park
  2024-06-25  7:50   ` Federico Vaga
  2024-06-26 22:34   ` Jonathan Corbet
  2024-06-24 18:53 ` [PATCH 4/7] Docs: Move clang-format from process/ to dev-tools/ SeongJae Park
                   ` (4 subsequent siblings)
  7 siblings, 2 replies; 16+ messages in thread
From: SeongJae Park @ 2024-06-24 18:53 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: SeongJae Park, Federico Vaga, Carlos Bilbao, Avadhut Naik,
	Alex Shi, Yanteng Si, Hu Haowen, workflows, linux-doc,
	linux-kernel

'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 <sj@kernel.org>
---
 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%)

diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst
index 08b4eb1e9118..fb089bf9d6a8 100644
--- a/Documentation/process/index.rst
+++ b/Documentation/process/index.rst
@@ -113,7 +113,6 @@ lack of a better place.
 .. toctree::
    :maxdepth: 1
 
-   magic-number
    clang-format
 
 .. only::  subproject and html
diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
index 71592f3ce89b..77bae5e5328b 100644
--- a/Documentation/staging/index.rst
+++ b/Documentation/staging/index.rst
@@ -8,6 +8,7 @@ Unsorted Documentation
 
    crc32
    lzo
+   magic-number
    remoteproc
    rpmsg
    speculation
diff --git a/Documentation/process/magic-number.rst b/Documentation/staging/magic-number.rst
similarity index 100%
rename from Documentation/process/magic-number.rst
rename to Documentation/staging/magic-number.rst
diff --git a/Documentation/translations/it_IT/process/magic-number.rst b/Documentation/translations/it_IT/process/magic-number.rst
index ae92ab633c16..cd8f23571835 100644
--- a/Documentation/translations/it_IT/process/magic-number.rst
+++ b/Documentation/translations/it_IT/process/magic-number.rst
@@ -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 <federico.vaga@vaga.pv.it>
 
 .. _it_magicnumbers:
diff --git a/Documentation/translations/sp_SP/process/magic-number.rst b/Documentation/translations/sp_SP/process/magic-number.rst
index 32a99aac2f6c..beb4b4c1de11 100644
--- a/Documentation/translations/sp_SP/process/magic-number.rst
+++ b/Documentation/translations/sp_SP/process/magic-number.rst
@@ -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 <carlos.bilbao.osdev@gmail.com>
 
 .. _sp_magicnumbers:
diff --git a/Documentation/translations/zh_CN/process/magic-number.rst b/Documentation/translations/zh_CN/process/magic-number.rst
index 4e4aeaca796c..4ebc84cc0c54 100644
--- a/Documentation/translations/zh_CN/process/magic-number.rst
+++ b/Documentation/translations/zh_CN/process/magic-number.rst
@@ -1,6 +1,6 @@
 .. include:: ../disclaimer-zh_CN.rst
 
-:Original: Documentation/process/magic-number.rst
+:Original: Documentation/staging/magic-number.rst
 
 :翻译:
 
diff --git a/Documentation/translations/zh_TW/process/magic-number.rst b/Documentation/translations/zh_TW/process/magic-number.rst
index 199cd5d63973..5582df6d7ca7 100644
--- a/Documentation/translations/zh_TW/process/magic-number.rst
+++ b/Documentation/translations/zh_TW/process/magic-number.rst
@@ -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。如果你使用英文交流有困難的話,也可
 以向中文版維護者求助。如果本翻譯更新不及時或者翻譯存在問題,請聯繫中文版維護者::
-- 
2.39.2


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH 4/7] Docs: Move clang-format from process/ to dev-tools/
  2024-06-24 18:53 [PATCH 0/7] minor document fixups SeongJae Park
                   ` (2 preceding siblings ...)
  2024-06-24 18:53 ` [PATCH 3/7] Docs: Move magic-number from process to staging SeongJae Park
@ 2024-06-24 18:53 ` SeongJae Park
  2024-06-24 19:26   ` Miguel Ojeda
  2024-06-25  7:51   ` Federico Vaga
  2024-06-24 18:53 ` [PATCH 5/7] Docs/process/index: Remove unsorted docs section SeongJae Park
                   ` (3 subsequent siblings)
  7 siblings, 2 replies; 16+ messages in thread
From: SeongJae Park @ 2024-06-24 18:53 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: SeongJae Park, Miguel Ojeda, Federico Vaga, Carlos Bilbao,
	Avadhut Naik, Alex Shi, Yanteng Si, Hu Haowen, Nathan Chancellor,
	Nick Desaulniers, Bill Wendling, Justin Stitt, linux-kernel,
	linux-doc, workflows, llvm

'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 <sj@kernel.org>
---
 .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%)

diff --git a/.clang-format b/.clang-format
index ccc9b93972a9..252820d9c80a 100644
--- a/.clang-format
+++ b/.clang-format
@@ -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
 #
diff --git a/Documentation/process/clang-format.rst b/Documentation/dev-tools/clang-format.rst
similarity index 100%
rename from Documentation/process/clang-format.rst
rename to Documentation/dev-tools/clang-format.rst
diff --git a/Documentation/dev-tools/index.rst b/Documentation/dev-tools/index.rst
index efa49cdc8e2e..a5f241cf0c02 100644
--- a/Documentation/dev-tools/index.rst
+++ b/Documentation/dev-tools/index.rst
@@ -16,6 +16,7 @@ Documentation/dev-tools/testing-overview.rst
 
    testing-overview
    checkpatch
+   clang-format
    coccinelle
    sparse
    kcov
diff --git a/Documentation/process/4.Coding.rst b/Documentation/process/4.Coding.rst
index c2046dec0c2f..80bcc1cabc23 100644
--- a/Documentation/process/4.Coding.rst
+++ b/Documentation/process/4.Coding.rst
@@ -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
diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index 7e768c65aa92..04f6aa377a5d 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -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
diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst
index fb089bf9d6a8..1827e73f6376 100644
--- a/Documentation/process/index.rst
+++ b/Documentation/process/index.rst
@@ -113,7 +113,6 @@ lack of a better place.
 .. toctree::
    :maxdepth: 1
 
-   clang-format
 
 .. only::  subproject and html
 
diff --git a/Documentation/translations/it_IT/process/clang-format.rst b/Documentation/translations/it_IT/process/clang-format.rst
index 29f83c198025..6fab07772da0 100644
--- a/Documentation/translations/it_IT/process/clang-format.rst
+++ b/Documentation/translations/it_IT/process/clang-format.rst
@@ -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 <federico.vaga@vaga.pv.it>
 
 .. _it_clangformat:
diff --git a/Documentation/translations/sp_SP/process/coding-style.rst b/Documentation/translations/sp_SP/process/coding-style.rst
index b5a84df44cea..025223be9706 100644
--- a/Documentation/translations/sp_SP/process/coding-style.rst
+++ b/Documentation/translations/sp_SP/process/coding-style.rst
@@ -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
diff --git a/Documentation/translations/zh_CN/process/4.Coding.rst b/Documentation/translations/zh_CN/process/4.Coding.rst
index 7cac9424f5d5..4cc35d410dbc 100644
--- a/Documentation/translations/zh_CN/process/4.Coding.rst
+++ b/Documentation/translations/zh_CN/process/4.Coding.rst
@@ -54,7 +54,7 @@
 注意您还可以使用 ``clang-format`` 工具来帮助您处理这些规则,快速自动重新格式
 化部分代码,和审阅完整的文件以发现代码样式错误、拼写错误和可能的改进。它还
 可以方便地排序 ``#includes`` 、对齐变量/宏、重排文本和其他类似任务。有关详细
-信息,请参阅文档 :ref:`Documentation/process/clang-format.rst <clangformat>`
+信息,请参阅文档 :ref:`Documentation/dev-tools/clang-format.rst <clangformat>`
 
 抽象层
 ******
diff --git a/Documentation/translations/zh_CN/process/coding-style.rst b/Documentation/translations/zh_CN/process/coding-style.rst
index 3bc2810b151d..10b9cb4f6a65 100644
--- a/Documentation/translations/zh_CN/process/coding-style.rst
+++ b/Documentation/translations/zh_CN/process/coding-style.rst
@@ -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 配置文件
diff --git a/Documentation/translations/zh_TW/process/4.Coding.rst b/Documentation/translations/zh_TW/process/4.Coding.rst
index bdd2abe4daf4..e90a6b51fb98 100644
--- a/Documentation/translations/zh_TW/process/4.Coding.rst
+++ b/Documentation/translations/zh_TW/process/4.Coding.rst
@@ -57,7 +57,7 @@
 注意您還可以使用 ``clang-format`` 工具來幫助您處理這些規則,快速自動重新格式
 化部分代碼,和審閱完整的文件以發現代碼樣式錯誤、拼寫錯誤和可能的改進。它還
 可以方便地排序 ``#includes`` 、對齊變量/宏、重排文本和其他類似任務。有關詳細
-信息,請參閱文檔 :ref:`Documentation/process/clang-format.rst <clangformat>`
+信息,請參閱文檔 :ref:`Documentation/dev-tools/clang-format.rst <clangformat>`
 
 抽象層
 ******
diff --git a/Documentation/translations/zh_TW/process/coding-style.rst b/Documentation/translations/zh_TW/process/coding-style.rst
index c7ac504f6f40..311c6f6bad0b 100644
--- a/Documentation/translations/zh_TW/process/coding-style.rst
+++ b/Documentation/translations/zh_TW/process/coding-style.rst
@@ -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 配置文件
-- 
2.39.2


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH 5/7] Docs/process/index: Remove unsorted docs section
  2024-06-24 18:53 [PATCH 0/7] minor document fixups SeongJae Park
                   ` (3 preceding siblings ...)
  2024-06-24 18:53 ` [PATCH 4/7] Docs: Move clang-format from process/ to dev-tools/ SeongJae Park
@ 2024-06-24 18:53 ` SeongJae Park
  2024-06-24 18:53 ` [PATCH 6/7] Docs/maintainer/maintainer-entry-profile: add DAMON maintainer profile SeongJae Park
                   ` (2 subsequent siblings)
  7 siblings, 0 replies; 16+ messages in thread
From: SeongJae Park @ 2024-06-24 18:53 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: SeongJae Park, workflows, linux-doc, linux-kernel

'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.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/process/index.rst | 7 -------
 1 file changed, 7 deletions(-)

diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst
index 1827e73f6376..6455eba3ef0c 100644
--- a/Documentation/process/index.rst
+++ b/Documentation/process/index.rst
@@ -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
-- 
2.39.2


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH 6/7] Docs/maintainer/maintainer-entry-profile: add DAMON maintainer profile
  2024-06-24 18:53 [PATCH 0/7] minor document fixups SeongJae Park
                   ` (4 preceding siblings ...)
  2024-06-24 18:53 ` [PATCH 5/7] Docs/process/index: Remove unsorted docs section SeongJae Park
@ 2024-06-24 18:53 ` SeongJae Park
  2024-06-24 18:53 ` [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL SeongJae Park
  2024-06-26 22:50 ` [PATCH 0/7] minor document fixups Jonathan Corbet
  7 siblings, 0 replies; 16+ messages in thread
From: SeongJae Park @ 2024-06-24 18:53 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: SeongJae Park, workflows, linux-doc, linux-kernel

DAMON has its maintainer entry profile document, but it's not listed on
the existing profiles section of maintainer-entry-profile.rst.  Add it.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/maintainer/maintainer-entry-profile.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/maintainer/maintainer-entry-profile.rst b/Documentation/maintainer/maintainer-entry-profile.rst
index b49fb6dc4d0c..cda5d691e967 100644
--- a/Documentation/maintainer/maintainer-entry-profile.rst
+++ b/Documentation/maintainer/maintainer-entry-profile.rst
@@ -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
-- 
2.39.2


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL
  2024-06-24 18:53 [PATCH 0/7] minor document fixups SeongJae Park
                   ` (5 preceding siblings ...)
  2024-06-24 18:53 ` [PATCH 6/7] Docs/maintainer/maintainer-entry-profile: add DAMON maintainer profile SeongJae Park
@ 2024-06-24 18:53 ` SeongJae Park
  2024-06-25 22:16   ` Randy Dunlap
  2024-06-26 22:35   ` Jonathan Corbet
  2024-06-26 22:50 ` [PATCH 0/7] minor document fixups Jonathan Corbet
  7 siblings, 2 replies; 16+ messages in thread
From: SeongJae Park @ 2024-06-24 18:53 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: SeongJae Park, workflows, linux-doc, linux-kernel

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/20240621170353.BFB83C2BBFC@smtp.kernel.org

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/process/email-clients.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/Documentation/process/email-clients.rst b/Documentation/process/email-clients.rst
index fc2c46f3f82d..dd22c46d1d02 100644
--- a/Documentation/process/email-clients.rst
+++ b/Documentation/process/email-clients.rst
@@ -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.
-- 
2.39.2


^ permalink raw reply related	[flat|nested] 16+ messages in thread

* Re: [PATCH 4/7] Docs: Move clang-format from process/ to dev-tools/
  2024-06-24 18:53 ` [PATCH 4/7] Docs: Move clang-format from process/ to dev-tools/ SeongJae Park
@ 2024-06-24 19:26   ` Miguel Ojeda
  2024-06-25  7:51   ` Federico Vaga
  1 sibling, 0 replies; 16+ messages in thread
From: Miguel Ojeda @ 2024-06-24 19:26 UTC (permalink / raw)
  To: SeongJae Park
  Cc: Jonathan Corbet, Miguel Ojeda, Federico Vaga, Carlos Bilbao,
	Avadhut Naik, Alex Shi, Yanteng Si, Hu Haowen, Nathan Chancellor,
	Nick Desaulniers, Bill Wendling, Justin Stitt, linux-kernel,
	linux-doc, workflows, llvm

On Mon, Jun 24, 2024 at 8:53 PM SeongJae Park <sj@kernel.org> wrote:
>
> '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 <sj@kernel.org>

Happy either way -- thanks!

Acked-by: Miguel Ojeda <ojeda@kernel.org>

Cheers,
Miguel

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH 3/7] Docs: Move magic-number from process to staging
  2024-06-24 18:53 ` [PATCH 3/7] Docs: Move magic-number from process to staging SeongJae Park
@ 2024-06-25  7:50   ` Federico Vaga
  2024-06-26 22:34   ` Jonathan Corbet
  1 sibling, 0 replies; 16+ messages in thread
From: Federico Vaga @ 2024-06-25  7:50 UTC (permalink / raw)
  To: SeongJae Park
  Cc: Jonathan Corbet, Carlos Bilbao, Avadhut Naik, Alex Shi,
	Yanteng Si, Hu Haowen, workflows, linux-doc, linux-kernel

On 2024-06-24 20:53, SeongJae Park wrote:
> '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 <sj@kernel.org>
> ---
>  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

Acked-by: Federico Vaga <federico.vaga@vaga.pv.it>

-- 
Federico Vaga

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH 4/7] Docs: Move clang-format from process/ to dev-tools/
  2024-06-24 18:53 ` [PATCH 4/7] Docs: Move clang-format from process/ to dev-tools/ SeongJae Park
  2024-06-24 19:26   ` Miguel Ojeda
@ 2024-06-25  7:51   ` Federico Vaga
  1 sibling, 0 replies; 16+ messages in thread
From: Federico Vaga @ 2024-06-25  7:51 UTC (permalink / raw)
  To: SeongJae Park
  Cc: Jonathan Corbet, Miguel Ojeda, Carlos Bilbao, Avadhut Naik,
	Alex Shi, Yanteng Si, Hu Haowen, Nathan Chancellor,
	Nick Desaulniers, Bill Wendling, Justin Stitt, linux-kernel,
	linux-doc, workflows, llvm

On 2024-06-24 20:53, SeongJae Park wrote:
> '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 <sj@kernel.org>
> ---
>  .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

Acked-by: Federico Vaga <federico.vaga@vaga.pv.it>

-- 
Federico Vaga

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL
  2024-06-24 18:53 ` [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL SeongJae Park
@ 2024-06-25 22:16   ` Randy Dunlap
  2024-06-26 22:35   ` Jonathan Corbet
  1 sibling, 0 replies; 16+ messages in thread
From: Randy Dunlap @ 2024-06-25 22:16 UTC (permalink / raw)
  To: SeongJae Park, Jonathan Corbet; +Cc: workflows, linux-doc, linux-kernel



On 6/24/24 11:53 AM, SeongJae Park wrote:
> 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/20240621170353.BFB83C2BBFC@smtp.kernel.org
> 
> Signed-off-by: SeongJae Park <sj@kernel.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  Documentation/process/email-clients.rst | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/Documentation/process/email-clients.rst b/Documentation/process/email-clients.rst
> index fc2c46f3f82d..dd22c46d1d02 100644
> --- a/Documentation/process/email-clients.rst
> +++ b/Documentation/process/email-clients.rst
> @@ -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.

-- 
~Randy

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH 3/7] Docs: Move magic-number from process to staging
  2024-06-24 18:53 ` [PATCH 3/7] Docs: Move magic-number from process to staging SeongJae Park
  2024-06-25  7:50   ` Federico Vaga
@ 2024-06-26 22:34   ` Jonathan Corbet
  1 sibling, 0 replies; 16+ messages in thread
From: Jonathan Corbet @ 2024-06-26 22:34 UTC (permalink / raw)
  To: SeongJae Park
  Cc: SeongJae Park, Federico Vaga, Carlos Bilbao, Avadhut Naik,
	Alex Shi, Yanteng Si, Hu Haowen, workflows, linux-doc,
	linux-kernel

SeongJae Park <sj@kernel.org> writes:

> '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 <sj@kernel.org>
> ---
>  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

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL
  2024-06-24 18:53 ` [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL SeongJae Park
  2024-06-25 22:16   ` Randy Dunlap
@ 2024-06-26 22:35   ` Jonathan Corbet
  2024-06-26 22:48     ` SeongJae Park
  1 sibling, 1 reply; 16+ messages in thread
From: Jonathan Corbet @ 2024-06-26 22:35 UTC (permalink / raw)
  To: SeongJae Park; +Cc: SeongJae Park, workflows, linux-doc, linux-kernel

SeongJae Park <sj@kernel.org> writes:

> 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/20240621170353.BFB83C2BBFC@smtp.kernel.org
>
> Signed-off-by: SeongJae Park <sj@kernel.org>
> ---
>  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

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL
  2024-06-26 22:35   ` Jonathan Corbet
@ 2024-06-26 22:48     ` SeongJae Park
  0 siblings, 0 replies; 16+ messages in thread
From: SeongJae Park @ 2024-06-26 22:48 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: SeongJae Park, workflows, linux-doc, linux-kernel

On Wed, 26 Jun 2024 16:35:49 -0600 Jonathan Corbet <corbet@lwn.net> wrote:

> SeongJae Park <sj@kernel.org> writes:
> 
> > 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/20240621170353.BFB83C2BBFC@smtp.kernel.org
> >
> > Signed-off-by: SeongJae Park <sj@kernel.org>
> > ---
> >  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.

> if we're going to do this, but I won't try to insist on that here...:)

Thank you for understanding, Jon! :)


Thanks,
SJ

[...]

^ permalink raw reply	[flat|nested] 16+ messages in thread

* Re: [PATCH 0/7] minor document fixups
  2024-06-24 18:53 [PATCH 0/7] minor document fixups SeongJae Park
                   ` (6 preceding siblings ...)
  2024-06-24 18:53 ` [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL SeongJae Park
@ 2024-06-26 22:50 ` Jonathan Corbet
  7 siblings, 0 replies; 16+ messages in thread
From: Jonathan Corbet @ 2024-06-26 22:50 UTC (permalink / raw)
  To: SeongJae Park
  Cc: SeongJae Park, Albert Ou, Alex Shi, Avadhut Naik, Bill Wendling,
	Carlos Bilbao, Federico Vaga, Hu Haowen, Justin Stitt,
	Miguel Ojeda, Nathan Chancellor, Nick Desaulniers, Palmer Dabbelt,
	Paul Walmsley, Yanteng Si, linux-doc, linux-riscv, llvm,
	workflows, linux-kernel

SeongJae Park <sj@kernel.org> writes:

> 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%)

Series applied, thanks.

jon

^ permalink raw reply	[flat|nested] 16+ messages in thread

end of thread, other threads:[~2024-06-26 22:50 UTC | newest]

Thread overview: 16+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-06-24 18:53 [PATCH 0/7] minor document fixups SeongJae Park
2024-06-24 18:53 ` [PATCH 1/7] Docs/process/index: Remove unaligned-memory-access from 'Other material' SeongJae Park
2024-06-24 18:53 ` [PATCH 2/7] Docs/process/index: Remove riscv/patch-acceptance from 'Other material' section SeongJae Park
2024-06-24 18:53 ` [PATCH 3/7] Docs: Move magic-number from process to staging SeongJae Park
2024-06-25  7:50   ` Federico Vaga
2024-06-26 22:34   ` Jonathan Corbet
2024-06-24 18:53 ` [PATCH 4/7] Docs: Move clang-format from process/ to dev-tools/ SeongJae Park
2024-06-24 19:26   ` Miguel Ojeda
2024-06-25  7:51   ` Federico Vaga
2024-06-24 18:53 ` [PATCH 5/7] Docs/process/index: Remove unsorted docs section SeongJae Park
2024-06-24 18:53 ` [PATCH 6/7] Docs/maintainer/maintainer-entry-profile: add DAMON maintainer profile SeongJae Park
2024-06-24 18:53 ` [PATCH 7/7] Docs/process/email-clients: Document HacKerMaiL SeongJae Park
2024-06-25 22:16   ` Randy Dunlap
2024-06-26 22:35   ` Jonathan Corbet
2024-06-26 22:48     ` SeongJae Park
2024-06-26 22:50 ` [PATCH 0/7] minor document fixups Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).