* [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
@ 2024-06-24 18:53 ` SeongJae Park
2024-06-24 19:26 ` Miguel Ojeda
2024-06-25 7:51 ` Federico Vaga
2024-06-26 22:50 ` [PATCH 0/7] minor document fixups Jonathan Corbet
1 sibling, 2 replies; 5+ 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] 5+ messages in thread* Re: [PATCH 0/7] minor document fixups
2024-06-24 18:53 [PATCH 0/7] minor document fixups SeongJae Park
2024-06-24 18:53 ` [PATCH 4/7] Docs: Move clang-format from process/ to dev-tools/ SeongJae Park
@ 2024-06-26 22:50 ` Jonathan Corbet
1 sibling, 0 replies; 5+ 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] 5+ messages in thread