linux-kernel - [PATCH v1] Documentation: Fix the compilation errors in union

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-Id: <20240801071523.463439-1-xavier_qy@163.com>
Date: Thu,  1 Aug 2024 15:15:23 +0800
From: Xavier <xavier_qy@....com>
To: sfr@...b.auug.org.au,
	tj@...nel.org
Cc: linux-kernel@...r.kernel.org,
	linux-next@...r.kernel.org,
	xavier_qy@....com
Subject: [PATCH v1] Documentation: Fix the compilation errors in union_find.rst

Fix the compilation errors and warnings caused by merging
Documentation/core-api/union_find.rst and
Documentation/core-api/union_find.rst.

Signed-off-by: Xavier <xavier_qy@....com>
---
 Documentation/core-api/index.rst              |  1 +
 Documentation/core-api/union_find.rst         |  4 +++-
 .../translations/zh_CN/core-api/index.rst     |  1 +
 .../zh_CN/core-api/union_find.rst             | 19 +++++++++++--------
 4 files changed, 16 insertions(+), 9 deletions(-)

diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index f147854700..e18a2ffe07 100644
--- a/Documentation/core-api/index.rst
+++ b/Documentation/core-api/index.rst
@@ -49,6 +49,7 @@ Library functionality that is used throughout the kernel.
    wrappers/atomic_t
    wrappers/atomic_bitops
    floating-point
+   union_find
 
 Low level entry and exit
 ========================
diff --git a/Documentation/core-api/union_find.rst b/Documentation/core-api/union_find.rst
index 38d63b16e5..0b3a86a52a 100644
--- a/Documentation/core-api/union_find.rst
+++ b/Documentation/core-api/union_find.rst
@@ -16,9 +16,11 @@ of disjoint sets. The primary operations supported by Union-Find are:
 
 	Initialization: Resetting each element as an individual set, with
 		each set's initial parent node pointing to itself.
+
 	Find: Determine which set a particular element belongs to, usually by
 		returning a “representative element” of that set. This operation
 		is used to check if two elements are in the same set.
+
 	Union: Merge two sets into one.
 
 As a data structure used to maintain sets (groups), Union-Find is commonly
@@ -63,7 +65,7 @@ operation, the tree with the smaller rank is attached under the tree with the
 larger rank to maintain balance.
 
 Initializing Union-Find
---------------------
+-----------------------
 
 When initializing the Union-Find data structure, a single pointer to the
 Union-Find instance needs to be passed. Initialize the parent pointer to point
diff --git a/Documentation/translations/zh_CN/core-api/index.rst b/Documentation/translations/zh_CN/core-api/index.rst
index 922cabf7b5..453a02cd1f 100644
--- a/Documentation/translations/zh_CN/core-api/index.rst
+++ b/Documentation/translations/zh_CN/core-api/index.rst
@@ -49,6 +49,7 @@
    generic-radix-tree
    packing
    this_cpu_ops
+   union_find
 
 =======
 
diff --git a/Documentation/translations/zh_CN/core-api/union_find.rst b/Documentation/translations/zh_CN/core-api/union_find.rst
index e1b5ae88da..ac7eaa612f 100644
--- a/Documentation/translations/zh_CN/core-api/union_find.rst
+++ b/Documentation/translations/zh_CN/core-api/union_find.rst
@@ -3,21 +3,23 @@
 
 :Original: Documentation/core-api/union_find.rst
 
-===========================
+=============================
 Linux中的并查集（Union-Find）
-===========================
+=============================
 
 
 :日期: 2024年6月21日
 :作者: Xavier <xavier_qy@....com>
 
 何为并查集，它有什么用？
----------------------
+------------------------
 
 并查集是一种数据结构，用于处理一些不交集的合并及查询问题。并查集支持的主要操作：
-	初始化：将每个元素初始化为单独的集合，每个集合的初始父节点指向自身
+	初始化：将每个元素初始化为单独的集合，每个集合的初始父节点指向自身。
+
 	查询：查询某个元素属于哪个集合，通常是返回集合中的一个“代表元素”。这个操作是为
 		了判断两个元素是否在同一个集合之中。
+
 	合并：将两个集合合并为一个。
 
 并查集作为一种用于维护集合（组）的数据结构，它通常用于解决一些离线查询、动态连通性和
@@ -37,7 +39,7 @@ Linux中的并查集（Union-Find）
     https://en.wikipedia.org/wiki/Disjoint-set_data_structure
 
 并查集的Linux实现
-----------------
+------------------
 
 Linux的并查集实现在文件“lib/union_find.c”中。要使用它，需要
 “#include <linux/union_find.h>”。
@@ -48,11 +50,12 @@ Linux的并查集实现在文件“lib/union_find.c”中。要使用它，需
 		struct uf_node *parent;
 		unsigned int rank;
 	};
+
 其中parent为当前节点的父节点，rank为当前树的高度，在合并时将rank小的节点接到rank大
 的节点下面以增加平衡性。
 
 初始化并查集
----------
+-------------
 
 初始化并查集时需要传入并查集实例的一个指针。初始化时，parent 指针指向自身，rank 设置
 为 0。
@@ -62,7 +65,7 @@ Linux的并查集实现在文件“lib/union_find.c”中。要使用它，需
 	uf_nodes_init(my_node);
 
 查找并查集的根节点
-----------------
+------------------
 
 主要用于判断两个并查集是否属于一个集合，如果根相同，那么他们就是一个集合。在查找过程中
 会对路径进行压缩，提高后续查找效率。
@@ -77,7 +80,7 @@ Linux的并查集实现在文件“lib/union_find.c”中。要使用它，需
 		connected = 0;
 
 合并两个并查集
--------------
+--------------
 
 对于两个相交的并查集进行合并，会首先查找它们各自的根节点，然后根据根节点秩大小，将小的
 节点连接到大的节点下面。
-- 
2.45.2