forked from Minki/linux
f7ebe6b769
Activating xeCJK in English and Italian-translation documents
results in sub-optimal typesetting with wide-looking apostrophes
and quotation marks.
The xeCJK package provides macros for enabling and disabling its
effect in the middle of a document, namely \makexeCJKactive and
\makexeCJKinactive.
So the goal of this change is to activate xeCJK in the relevant
chapters in translations.
To do this:
o Define custom macros in the preamble depending on the
availability of the "Noto Sans CJK" font so that those
macros can be used regardless of the use of xeCJK package.
o Patch \sphinxtableofcontents so that xeCJK is inactivated
after table of contents.
o Embed those custom macros in each language's index.rst file
as a ".. raw:: latex" construct.
Note: A CJK chapter needs \kerneldocCJKon in front of its chapter
heading, while a non-CJK chapter should have \kerneldocCJKoff
below its chapter heading.
This is to make sure the CJK font is available to CJK chapter's
heading and ending page's footer.
Tested against Sphinx versions 2.4.4 and 4.0.2.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Tested-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/lkml/2061da0a-6ab1-35f3-99c1-dbc415444f37@gmail.com
Link: https://lore.kernel.org/r/83208ddc-5de9-b283-3fd6-92c635348ca0@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
187 lines
3.2 KiB
ReStructuredText
187 lines
3.2 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0
|
||
|
||
.. raw:: latex
|
||
|
||
\renewcommand\thesection*
|
||
\renewcommand\thesubsection*
|
||
\kerneldocCJKon
|
||
|
||
.. _linux_doc_zh:
|
||
|
||
中文翻译
|
||
========
|
||
|
||
|
||
.. note::
|
||
|
||
**翻译计划:**
|
||
内核中文文档欢迎任何翻译投稿，特别是关于内核用户和管理员指南部分。
|
||
|
||
许可证文档
|
||
----------
|
||
|
||
下面的文档介绍了Linux内核源代码的许可证（GPLv2）、如何在源代码树中正确标记
|
||
单个文件的许可证、以及指向完整许可证文本的链接。
|
||
|
||
* Documentation/translations/zh_CN/process/license-rules.rst
|
||
|
||
用户文档
|
||
--------
|
||
|
||
下面的手册是为内核用户编写的——即那些试图让它在给定系统上以最佳方式工作的
|
||
用户。
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
|
||
admin-guide/index
|
||
|
||
TODOList:
|
||
|
||
* kbuild/index
|
||
|
||
固件相关文档
|
||
------------
|
||
|
||
下列文档描述了内核需要的平台固件相关信息。
|
||
|
||
TODOList:
|
||
|
||
* firmware-guide/index
|
||
* devicetree/index
|
||
|
||
应用程序开发人员文档
|
||
--------------------
|
||
|
||
用户空间API手册涵盖了描述应用程序开发人员可见内核接口方面的文档。
|
||
|
||
TODOlist:
|
||
|
||
* userspace-api/index
|
||
|
||
内核开发简介
|
||
------------
|
||
|
||
这些手册包含有关如何开发内核的整体信息。内核社区非常庞大，一年下来有数千名
|
||
开发人员做出贡献。与任何大型社区一样，知道如何完成任务将使得更改合并的过程
|
||
变得更加容易。
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
|
||
process/index
|
||
dev-tools/index
|
||
doc-guide/index
|
||
kernel-hacking/index
|
||
maintainer/index
|
||
|
||
TODOList:
|
||
|
||
* trace/index
|
||
* fault-injection/index
|
||
* livepatch/index
|
||
* rust/index
|
||
|
||
内核API文档
|
||
-----------
|
||
|
||
以下手册从内核开发人员的角度详细介绍了特定的内核子系统是如何工作的。这里的
|
||
大部分信息都是直接从内核源代码获取的，并根据需要添加补充材料（或者至少是在
|
||
我们设法添加的时候——可能不是所有的都是有需要的）。
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
|
||
core-api/index
|
||
cpu-freq/index
|
||
iio/index
|
||
sound/index
|
||
filesystems/index
|
||
|
||
TODOList:
|
||
|
||
* driver-api/index
|
||
* locking/index
|
||
* accounting/index
|
||
* block/index
|
||
* cdrom/index
|
||
* ide/index
|
||
* fb/index
|
||
* fpga/index
|
||
* hid/index
|
||
* i2c/index
|
||
* isdn/index
|
||
* infiniband/index
|
||
* leds/index
|
||
* netlabel/index
|
||
* networking/index
|
||
* pcmcia/index
|
||
* power/index
|
||
* target/index
|
||
* timers/index
|
||
* spi/index
|
||
* w1/index
|
||
* watchdog/index
|
||
* virt/index
|
||
* input/index
|
||
* hwmon/index
|
||
* gpu/index
|
||
* security/index
|
||
* crypto/index
|
||
* vm/index
|
||
* bpf/index
|
||
* usb/index
|
||
* PCI/index
|
||
* scsi/index
|
||
* misc-devices/index
|
||
* scheduler/index
|
||
* mhi/index
|
||
|
||
体系结构无关文档
|
||
----------------
|
||
|
||
TODOList:
|
||
|
||
* asm-annotations
|
||
|
||
特定体系结构文档
|
||
----------------
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
|
||
mips/index
|
||
arm64/index
|
||
riscv/index
|
||
openrisc/index
|
||
parisc/index
|
||
|
||
TODOList:
|
||
|
||
* arm/index
|
||
* ia64/index
|
||
* m68k/index
|
||
* nios2/index
|
||
* powerpc/index
|
||
* s390/index
|
||
* sh/index
|
||
* sparc/index
|
||
* x86/index
|
||
* xtensa/index
|
||
|
||
其他文档
|
||
--------
|
||
|
||
有几份未排序的文档似乎不适合放在文档的其他部分，或者可能需要进行一些调整和/或
|
||
转换为reStructureText格式，也有可能太旧。
|
||
|
||
TODOList:
|
||
|
||
* staging/index
|
||
* watch_queue
|
||
|
||
目录和表格
|
||
----------
|
||
|
||
* :ref:`genindex`
|