Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Merge tag 'docs-6.1-2' of git://git.lwn.net/linux

Pull documentation fixes from Jonathan Corbet:
"A handful of relatively simple documentation fixes, plus a set of
patches catching the Chinese translation up with the front-page
rework"

* tag 'docs-6.1-2' of git://git.lwn.net/linux:
Documentation: rtla: Correct command line example
docs/zh_CN: add a man-pages link to zh_CN/index.rst
docs/zh_CN: Rewrite the Chinese translation front page
docs/zh_CN: add zh_CN/arch.rst
docs/zh_CN: promote the title of zh_CN/process/index.rst
docs/zh_CN: Update the translation of page_owner to 6.0-rc7
docs/zh_CN: Update the translation of ksm to 6.0-rc7
docs/howto: Replace abundoned URL of gmane.org
Documentation: ubifs: Fix compression idiom
Documentation/mm/page_owner.rst: delete frequently changing experimental data
docs/zh_CN: Fix build warning
docs: ftrace: Correct access mode

+123 -166
+1 -1
Documentation/filesystems/ubifs.rst
··· 59 59 * JFFS2 is a write-through file-system, while UBIFS supports write-back, 60 60 which makes UBIFS much faster on writes. 61 61 62 - Similarly to JFFS2, UBIFS supports on-the-flight compression which makes 62 + Similarly to JFFS2, UBIFS supports on-the-fly compression which makes 63 63 it possible to fit quite a lot of data to the flash. 64 64 65 65 Similarly to JFFS2, UBIFS is tolerant of unclean reboots and power-cuts.
+4 -16
Documentation/mm/page_owner.rst
··· 38 38 label patching functionality is available. Following is the kernel's code 39 39 size change due to this facility. 40 40 41 - - Without page owner:: 42 - 43 - text data bss dec hex filename 44 - 48392 2333 644 51369 c8a9 mm/page_alloc.o 45 - 46 - - With page owner:: 47 - 48 - text data bss dec hex filename 49 - 48800 2445 644 51889 cab1 mm/page_alloc.o 50 - 6662 108 29 6799 1a8f mm/page_owner.o 51 - 1025 8 8 1041 411 mm/page_ext.o 52 - 53 - Although, roughly, 8 KB code is added in total, page_alloc.o increase by 54 - 520 bytes and less than half of it is in hotpath. Building the kernel with 55 - page owner and turning it on if needed would be great option to debug 56 - kernel memory problem. 41 + Although enabling page owner increases kernel size by several kilobytes, 42 + most of this code is outside page allocator and its hot path. Building 43 + the kernel with page owner and turning it on if needed would be great 44 + option to debug kernel memory problem. 57 45 58 46 There is one notice that is caused by implementation detail. page owner 59 47 stores information into the memory from struct page extension. This memory
+1 -1
Documentation/process/howto.rst
··· 379 379 There are archives of the mailing list on the web in many different 380 380 places. Use a search engine to find these archives. For example: 381 381 382 - http://dir.gmane.org/gmane.linux.kernel 382 + https://lore.kernel.org/lkml/ 383 383 384 384 It is highly recommended that you search the archives about the topic 385 385 you want to bring up, before you post it to the list. A lot of things
+1 -1
Documentation/tools/rtla/rtla-timerlat-top.rst
··· 39 39 latency higher than *30 us* is hit. Finally, it is set to save the trace 40 40 buffer if the stop condition is hit:: 41 41 42 - [root@alien ~]# rtla timerlat top -s 30 -t 30 -T 42 + [root@alien ~]# rtla timerlat top -s 30 -T 30 -t 43 43 Timer Latency 44 44 0 00:00:59 | IRQ Timer Latency (us) | Thread Timer Latency (us) 45 45 CPU COUNT | cur min avg max | cur min avg max
+1 -1
Documentation/trace/ftrace.rst
··· 564 564 565 565 start:: 566 566 567 - trace_fd = open("trace_marker", WR_ONLY); 567 + trace_fd = open("trace_marker", O_WRONLY); 568 568 569 569 Note: Writing into the trace_marker file can also initiate triggers 570 570 that are written into /sys/kernel/tracing/events/ftrace/print/trigger
+1 -1
Documentation/translations/it_IT/process/howto.rst
··· 394 394 Ci sono diversi archivi della lista di discussione. Usate un qualsiasi motore 395 395 di ricerca per trovarli. Per esempio: 396 396 397 - http://dir.gmane.org/gmane.linux.kernel 397 + https://lore.kernel.org/lkml/ 398 398 399 399 É caldamente consigliata una ricerca in questi archivi sul tema che volete 400 400 sollevare, prima di pubblicarlo sulla lista. Molte cose sono già state
+1 -1
Documentation/translations/ja_JP/howto.rst
··· 410 410 このメーリングリストのアーカイブは web 上の多数の場所に存在します。こ 411 411 れらのアーカイブを探すにはサーチエンジンを使いましょう。例えば- 412 412 413 - http://dir.gmane.org/gmane.linux.kernel 413 + https://lore.kernel.org/lkml/ 414 414 415 415 リストに投稿する前にすでにその話題がアーカイブに存在するかどうかを検索 416 416 することを是非やってください。多数の事がすでに詳細に渡って議論されてお
+1 -1
Documentation/translations/ko_KR/howto.rst
··· 386 386 웹상의 많은 다른 곳에도 메일링 리스트의 아카이브들이 있다. 387 387 이러한 아카이브들을 찾으려면 검색 엔진을 사용하라. 예를 들어: 388 388 389 - http://dir.gmane.org/gmane.linux.kernel 389 + https://lore.kernel.org/lkml/ 390 390 391 391 여러분이 새로운 문제에 관해 리스트에 올리기 전에 말하고 싶은 주제에 관한 392 392 것을 아카이브에서 먼저 찾아보기를 강력히 권장한다. 이미 상세하게 토론된 많은
+29
Documentation/translations/zh_CN/arch.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + 处理器体系结构 4 + ============== 5 + 6 + 以下文档提供了具体架构实现的编程细节。 7 + 8 + .. toctree:: 9 + :maxdepth: 2 10 + 11 + mips/index 12 + arm64/index 13 + riscv/index 14 + openrisc/index 15 + parisc/index 16 + loongarch/index 17 + 18 + TODOList: 19 + 20 + * arm/index 21 + * ia64/index 22 + * m68k/index 23 + * nios2/index 24 + * powerpc/index 25 + * s390/index 26 + * sh/index 27 + * sparc/index 28 + * x86/index 29 + * xtensa/index
+1 -1
Documentation/translations/zh_CN/devicetree/changesets.rst
··· 1 1 .. SPDX-License-Identifier: GPL-2.0 2 2 .. include:: ../disclaimer-zh_CN.rst 3 3 4 - :Original: Documentation/Devicetree/changesets.rst 4 + :Original: Documentation/devicetree/changesets.rst 5 5 6 6 :翻译: 7 7
+1 -1
Documentation/translations/zh_CN/devicetree/dynamic-resolution-notes.rst
··· 1 1 .. SPDX-License-Identifier: GPL-2.0 2 2 .. include:: ../disclaimer-zh_CN.rst 3 3 4 - :Original: Documentation/Devicetree/dynamic-resolution-notes.rst 4 + :Original: Documentation/devicetree/dynamic-resolution-notes.rst 5 5 6 6 :翻译: 7 7
+1 -1
Documentation/translations/zh_CN/devicetree/kernel-api.rst
··· 1 1 .. SPDX-License-Identifier: GPL-2.0 2 2 .. include:: ../disclaimer-zh_CN.rst 3 3 4 - :Original: Documentation/Devicetree/kernel-api.rst 4 + :Original: Documentation/devicetree/kernel-api.rst 5 5 6 6 :翻译: 7 7
+1 -1
Documentation/translations/zh_CN/devicetree/overlay-notes.rst
··· 1 1 .. SPDX-License-Identifier: GPL-2.0 2 2 .. include:: ../disclaimer-zh_CN.rst 3 3 4 - :Original: Documentation/Devicetree/overlay-notes.rst 4 + :Original: Documentation/devicetree/overlay-notes.rst 5 5 6 6 :翻译: 7 7
+68 -133
Documentation/translations/zh_CN/index.rst
··· 26 26 顺便说下,中文文档也需要遵守内核编码风格,风格中中文和英文的主要不同就是中文 27 27 的字符标点占用两个英文字符宽度, 所以,当英文要求不要超过每行100个字符时, 28 28 中文就不要超过50个字符。另外,也要注意'-','=' 等符号与相关标题的对齐。在将 29 - 补丁提交到社区之前,一定要进行必要的checkpatch.pl检查和编译测试。 29 + 补丁提交到社区之前,一定要进行必要的 ``checkpatch.pl`` 检查和编译测试。 30 30 31 - 许可证文档 32 - ---------- 31 + 与Linux 内核社区一起工作 32 + ------------------------ 33 33 34 - 下面的文档介绍了Linux内核源代码的许可证(GPLv2)、如何在源代码树中正确标记 35 - 单个文件的许可证、以及指向完整许可证文本的链接。 36 - 37 - * Documentation/translations/zh_CN/process/license-rules.rst 38 - 39 - 用户文档 40 - -------- 41 - 42 - 下面的手册是为内核用户编写的——即那些试图让它在给定系统上以最佳方式工作的 43 - 用户。 34 + 与内核开发社区进行协作并将工作推向上游的基本指南。 44 35 45 36 .. toctree:: 46 - :maxdepth: 2 37 + :maxdepth: 1 47 38 48 - admin-guide/index 39 + process/development-process 40 + process/submitting-patches 41 + 行为准则 <process/code-of-conduct> 42 + maintainer/index 43 + 完整开发流程文档 <process/index> 44 + 45 + 内部API文档 46 + ----------- 47 + 48 + 开发人员使用的内核内部交互接口手册。 49 + 50 + .. toctree:: 51 + :maxdepth: 1 52 + 53 + core-api/index 54 + driver-api/index 55 + 内核中的锁 <locking/index> 49 56 50 57 TODOList: 51 58 52 - * kbuild/index 59 + * subsystem-apis 60 + 61 + 开发工具和流程 62 + -------------- 63 + 64 + 为所有内核开发人员提供有用信息的各种其他手册。 65 + 66 + .. toctree:: 67 + :maxdepth: 1 68 + 69 + process/license-rules 70 + doc-guide/index 71 + dev-tools/index 72 + dev-tools/testing-overview 73 + kernel-hacking/index 74 + 75 + TODOList: 76 + 77 + * trace/index 78 + * fault-injection/index 79 + * livepatch/index 80 + 81 + 面向用户的文档 82 + -------------- 83 + 84 + 下列手册针对 85 + 希望内核在给定系统上以最佳方式工作的*用户*, 86 + 和查找内核用户空间API信息的程序开发人员。 87 + 88 + .. toctree:: 89 + :maxdepth: 1 90 + 91 + admin-guide/index 92 + admin-guide/reporting-issues.rst 93 + 94 + TODOList: 95 + 96 + * 内核构建系统 <kbuild/index> 97 + * 用户空间工具 <tools/index> 98 + * userspace-api/index 99 + 100 + 也可参考独立于内核文档的 `Linux 手册页 <https://www.kernel.org/doc/man-pages/>`_ 。 53 101 54 102 固件相关文档 55 103 ------------ ··· 113 65 114 66 * firmware-guide/index 115 67 116 - 应用程序开发人员文档 117 - -------------------- 118 - 119 - 用户空间API手册涵盖了描述应用程序开发人员可见内核接口方面的文档。 120 - 121 - TODOlist: 122 - 123 - * userspace-api/index 124 - 125 - 内核开发简介 68 + 体系结构文档 126 69 ------------ 127 70 128 - 这些手册包含有关如何开发内核的整体信息。内核社区非常庞大,一年下来有数千名 129 - 开发人员做出贡献。与任何大型社区一样,知道如何完成任务将使得更改合并的过程 130 - 变得更加容易。 131 - 132 71 .. toctree:: 133 72 :maxdepth: 2 134 73 135 - process/index 136 - dev-tools/index 137 - doc-guide/index 138 - kernel-hacking/index 139 - maintainer/index 140 - 141 - TODOList: 142 - 143 - * trace/index 144 - * fault-injection/index 145 - * livepatch/index 146 - * rust/index 147 - 148 - 内核API文档 149 - ----------- 150 - 151 - 以下手册从内核开发人员的角度详细介绍了特定的内核子系统是如何工作的。这里的 152 - 大部分信息都是直接从内核源代码获取的,并根据需要添加补充材料(或者至少是在 153 - 我们设法添加的时候——可能不是所有的都是有需要的)。 154 - 155 - .. toctree:: 156 - :maxdepth: 2 157 - 158 - core-api/index 159 - driver-api/index 160 - locking/index 161 - accounting/index 162 - cpu-freq/index 163 - iio/index 164 - infiniband/index 165 - power/index 166 - virt/index 167 - sound/index 168 - filesystems/index 169 - scheduler/index 170 - mm/index 171 - peci/index 172 - PCI/index 173 - 174 - TODOList: 175 - 176 - * block/index 177 - * cdrom/index 178 - * ide/index 179 - * fb/index 180 - * fpga/index 181 - * hid/index 182 - * i2c/index 183 - * isdn/index 184 - * leds/index 185 - * netlabel/index 186 - * networking/index 187 - * pcmcia/index 188 - * target/index 189 - * timers/index 190 - * spi/index 191 - * w1/index 192 - * watchdog/index 193 - * input/index 194 - * hwmon/index 195 - * gpu/index 196 - * security/index 197 - * crypto/index 198 - * bpf/index 199 - * usb/index 200 - * scsi/index 201 - * misc-devices/index 202 - * mhi/index 203 - 204 - 体系结构无关文档 205 - ---------------- 206 - 207 - TODOList: 208 - 209 - * asm-annotations 210 - 211 - 特定体系结构文档 212 - ---------------- 213 - 214 - .. toctree:: 215 - :maxdepth: 2 216 - 217 - mips/index 218 - arm64/index 219 - riscv/index 220 - openrisc/index 221 - parisc/index 222 - loongarch/index 223 - 224 - TODOList: 225 - 226 - * arm/index 227 - * ia64/index 228 - * m68k/index 229 - * nios2/index 230 - * powerpc/index 231 - * s390/index 232 - * sh/index 233 - * sparc/index 234 - * x86/index 235 - * xtensa/index 74 + arch 236 75 237 76 其他文档 238 77 -------- ··· 130 195 TODOList: 131 196 132 197 * staging/index 133 - * watch_queue 134 198 135 - 目录和表格 199 + 200 + 索引和表格 136 201 ---------- 137 202 138 203 * :ref:`genindex`
+1 -1
Documentation/translations/zh_CN/mm/ksm.rst
··· 30 30 KSM维护着稳定树中的KSM页的逆映射信息。 31 31 32 32 当KSM页面的共享数小于 ``max_page_sharing`` 的虚拟内存区域(VMAs)时,则代表了 33 - KSM页的稳定树其中的节点指向了一个rmap_item结构体类型的列表。同时,这个KSM页 33 + KSM页的稳定树其中的节点指向了一个ksm_rmap_item结构体类型的列表。同时,这个KSM页 34 34 的 ``page->mapping`` 指向了该稳定树节点。 35 35 36 36 如果共享数超过了阈值,KSM将给稳定树添加第二个维度。稳定树就变成链接一个或多
+7 -3
Documentation/translations/zh_CN/mm/page_owner.rst
··· 74 74 cat /sys/kernel/debug/page_owner > page_owner_full.txt 75 75 ./page_owner_sort page_owner_full.txt sorted_page_owner.txt 76 76 77 - ``page_owner_full.txt`` 的一般输出情况如下(输出信息无翻译价值):: 77 + ``page_owner_full.txt`` 的一般输出情况如下:: 78 78 79 79 Page allocated via order XXX, ... 80 80 PFN XXX ... 81 - // Detailed stack 81 + // 栈详情 82 82 83 83 Page allocated via order XXX, ... 84 84 PFN XXX ... 85 - // Detailed stack 85 + // 栈详情 86 + 默认情况下,它将以一个给定的pfn开始,做完整的pfn转储,且page_owner支持fseek。 87 + 88 + FILE *fp = fopen("/sys/kernel/debug/page_owner", "r"); 89 + fseek(fp, pfn_start, SEEK_SET); 86 90 87 91 ``page_owner_sort`` 工具忽略了 ``PFN`` 行,将剩余的行放在buf中,使用regexp提 88 92 取页序值,计算buf的次数和页数,最后根据参数进行排序。
+1 -1
Documentation/translations/zh_CN/process/howto.rst
··· 306 306 网上很多地方都有这个邮件列表的存档(archive)。可以使用搜索引擎来找到这些 307 307 存档。比如: 308 308 309 - http://dir.gmane.org/gmane.linux.kernel 309 + https://lore.kernel.org/lkml/ 310 310 311 311 在发信之前,我们强烈建议你先在存档中搜索你想要讨论的问题。很多已经被详细 312 312 讨论过的问题只在邮件列表的存档中可以找到。
+1
Documentation/translations/zh_CN/process/index.rst
··· 10 10 11 11 .. _cn_process_index: 12 12 13 + ======================== 13 14 与Linux 内核社区一起工作 14 15 ======================== 15 16
+1 -1
Documentation/translations/zh_TW/process/howto.rst
··· 309 309 網上很多地方都有這個郵件列表的存檔(archive)。可以使用搜尋引擎來找到這些 310 310 存檔。比如: 311 311 312 - http://dir.gmane.org/gmane.linux.kernel 312 + https://lore.kernel.org/lkml/ 313 313 314 314 在發信之前,我們強烈建議你先在存檔中搜索你想要討論的問題。很多已經被詳細 315 315 討論過的問題只在郵件列表的存檔中可以找到。