Tested by the command: make htmldocs
During the compiling process, some rendering issues were found and fixed, most of which were due to Chinese characters leading to a syntax failure, such as `` ``, ** **. I have not tested to generate pdf format, but html documents have been checked. Signed-off-by: Andy Deng <theandy.d...@gmail.com> --- Documentation/index.rst | 10 ++- .../zh_CN/{CodingStyle => coding-style.rst} | 84 +++++++++++----------- Documentation/translations/zh_CN/index.rst | 12 ++++ 3 files changed, 64 insertions(+), 42 deletions(-) rename Documentation/translations/zh_CN/{CodingStyle => coding-style.rst} (91%) create mode 100644 Documentation/translations/zh_CN/index.rst diff --git a/Documentation/index.rst b/Documentation/index.rst index cb5d776..f6e641a 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -47,7 +47,7 @@ These books get into the details of how specific kernel subsystems work from the point of view of a kernel developer. Much of the information here is taken directly from the kernel source, with supplemental material added as needed (or at least as we managed to add it ??? probably *not* all that is -needed). +needed). .. toctree:: :maxdepth: 2 @@ -68,6 +68,14 @@ Korean translations translations/ko_KR/index +Chinese translations +-------------------- + +.. toctree:: + :maxdepth: 1 + + translations/zh_CN/index + Indices and tables ================== diff --git a/Documentation/translations/zh_CN/CodingStyle b/Documentation/translations/zh_CN/coding-style.rst similarity index 91% rename from Documentation/translations/zh_CN/CodingStyle rename to Documentation/translations/zh_CN/coding-style.rst index 8e7ae2d..1466aa6 100644 --- a/Documentation/translations/zh_CN/CodingStyle +++ b/Documentation/translations/zh_CN/coding-style.rst @@ -8,6 +8,7 @@ translation is outdated or there is problem with translation. Chinese maintainer: Zhang Le <r0be...@gentoo.org> --------------------------------------------------------------------- + Documentation/process/coding-style.rst ??????????????? ????????????????????????????????????????????????????????????LKML???????????????????????????????????????????????? @@ -21,6 +22,7 @@ Documentation/process/coding-style.rst ??????????????? ????????? Xudong Guan <xudong.g...@gmail.com> Li Zefan <l...@cn.fujitsu.com> Wang Chen <wangc...@cn.fujitsu.com> + ??????????????? --------------------------------------------------------------------- @@ -221,13 +223,13 @@ Linux ??????????????????????????? (??????) ???????????????????????????????????? s = sizeof(struct file); -???????????????????????????????????????????????????????????????**??????**??? +??????????????????????????????????????????????????????????????? **??????** ??? .. code-block:: c s = sizeof( struct file ); -????????????????????????????????????????????????????????????``*`` ????????????????????????????????????????????? +???????????????????????????????????????????????????????????? ``*`` ????????????????????????????????????????????? ?????????????????????????????????????????????????????? .. code-block:: c @@ -269,22 +271,22 @@ Linux ??????????????????????????? (??????) ???????????????????????????????????? C ???????????????????????????????????????????????????????????? Modula-2 ??? Pascal ?????????????????? C ???????????????????????? ThisVariableIsATemporaryCounter ????????????????????????C ???????????? -?????????????????? ``tmp``???????????????????????????????????????????????????????????????????????? +?????????????????? ``tmp`` ???????????????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ????????????????????????????????? ``foo`` ????????????????????????????????? -???????????? (????????????**??????**??????????????????????????????) ?????????????????????????????????????????? +???????????? (???????????? **??????** ??????????????????????????????) ?????????????????????????????????????????? ????????????????????????????????????????????????????????????????????????????????????????????? -``count_active_users()`` ?????????????????????????????????????????? ``cntuser()``??? +``count_active_users()`` ?????????????????????????????????????????? ``cntuser()`` ??? ????????????????????????????????? (???????????????????????????) ??????????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ???????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? -??????????????????????????? ``i``????????? ``loop_counter`` ?????????????????????????????????????????? -???????????????????????????``tmp`` ???????????????????????????????????????????????? +??????????????????????????? ``i`` ????????? ``loop_counter`` ?????????????????????????????????????????? +??????????????????????????? ``tmp`` ???????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ???????????????????????? (??????)??? @@ -295,7 +297,7 @@ C ???????????????????????? ThisVariableIsATemporaryCounter ????????????????????? ?????????????????? ``vps_t`` ?????????????????? -??????????????????????????? typedef ?????????**??????**?????????????????????????????? +??????????????????????????? typedef ????????? **??????** ?????????????????????????????? .. code-block:: c @@ -311,34 +313,34 @@ C ???????????????????????? ThisVariableIsATemporaryCounter ????????????????????? ???????????? ``a`` ??????????????? -??????????????? typedef ``??????????????????``??????????????????????????????????????????????????????????????? +??????????????? typedef ``??????????????????`` ??????????????????????????????????????????????????????????????? - (a) ???????????????????????? (?????????????????????????????? typedef ???**??????**????????????????????? + (a) ???????????????????????? (?????????????????????????????? typedef ??? **??????** ????????????????????? ?????????)??? - ?????????``pte_t`` ???????????????????????????????????????????????????????????????????????? + ????????? ``pte_t`` ???????????????????????????????????????????????????????????????????????? - .. ??????:: + .. note:: ??????????????? "????????????" ????????????????????????????????? pte_t ??????????????????????????? ??????????????????????????????????????????????????? - (b) ??????????????????????????????????????????????????????**??????**??????????????? ``int`` ?????? + (b) ?????????????????????????????????????????????????????? **??????** ??????????????? ``int`` ?????? ``long`` ???????????? u8/u16/u32 ???????????????????????? typedef?????????????????????????????? (d) ?????????????????? - .. ????????????:: + .. note:: - ????????????????????????????????????????????????????????? ``unsigned long``????????????????????? + ????????????????????????????????????????????????????????? ``unsigned long`` ????????????????????? typedef unsigned long myflags_t; ???????????????????????????????????????????????????????????????????????????????????? ``unsigned int`` - ?????????????????????????????? ``unsigned long``?????????????????????????????????????????? + ?????????????????????????????? ``unsigned long`` ?????????????????????????????????????????? typedef??? - (c) ???????????? sparse ????????????????????????**???**???????????????????????????????????? + (c) ???????????? sparse ???????????????????????? **???** ???????????????????????????????????? (d) ????????? C99 ?????????????????????????????????????????????????????? @@ -357,8 +359,8 @@ C ???????????????????????? ThisVariableIsATemporaryCounter ????????????????????? ``u32`` ??????????????????????????????????????????????????????????????????????????? __u32 ????????? ???????????? -??????????????????????????????????????????????????????**????????????**?????? typedef???????????????????????? -?????????????????????????????????????????? +?????????????????????????????????????????????????????? **????????????** ?????? typedef????????????????????? +????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ????????????????????? typedef??? @@ -409,7 +411,7 @@ Linux ???????????????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????? return ????????? ???????????????????????? goto ????????????????????????????????????????????? goto ????????? ``buffer``, -?????????????????????????????? ``out_free_buffer:``?????????????????? ``err1:`` ??? ``err2:`` +?????????????????????????????? ``out_free_buffer:`` ?????????????????? ``err1:`` ??? ``err2:`` ?????????GW_BASIC ?????????????????????????????????????????? (?????????) ???????????????????????????????????? ??????????????????????????????????????????????????? @@ -444,7 +446,7 @@ Linux ???????????????????????????????????????????????????????????????????????? return result; } -???????????????????????????????????? ``?????? err ??????``?????????????????? +???????????????????????????????????? ``?????? err ??????`` ?????????????????? .. code-block:: c @@ -557,16 +559,16 @@ Documentation/doc-guide/ ??? scripts/kernel-doc ???????????????????????? ????????? emacs ??? ``~/src/linux-trees`` ?????? C ????????????????????????????????????????????? ???????????????????????? emacs ????????????????????????????????????????????????????????????????????????????????? -?????? ``indent``??? +?????? ``indent`` ??? ?????????GNU indent ????????? GNU emacs ??????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????? GNU indent ?????????????????? K&R ???????????? (GNU ???????????????????????????????????????????????????????????????????????????)????????????????????? indent -???????????? ``-kr -i8`` (?????? ``K&R???8 ????????????``)???????????? ``scripts/Lindent``??? +???????????? ``-kr -i8`` (?????? ``K&R???8 ????????????``)???????????? ``scripts/Lindent`` ?????????????????????????????????????????????????????? ``indent`` ??????????????????????????????????????????????????????????????????????????????????????????????????? -???????????????``indent`` ????????????????????????????????? +??????????????? ``indent`` ????????????????????????????????? 10) Kconfig ???????????? @@ -607,14 +609,14 @@ Documentation/doc-guide/ ??? scripts/kernel-doc ???????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ???????????????????????????????????? -????????????**??????**?????????????????????????????????????????????????????????????????????????????????????????? +???????????? **??????** ?????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????????????? ?????????????????????????????? 2 ??????????????????????????????????????? ``???`` ?????????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????? -?????? ``??????????????????`` ?????????????????????????????? (``struct mm_struct``???mm_users ??? -mm_count)?????????????????? (``struct super_block``???s_count ??? s_active) ???????????? +?????? ``??????????????????`` ?????????????????????????????? (``struct mm_struct``: mm_users ??? +mm_count)?????????????????? (``struct super_block``: s_count ??? s_active) ???????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? ??????????????????????????? bug??? @@ -657,8 +659,8 @@ mm_count)?????????????????? (``struct super_block``???s_count ??? s_active) ??? return -EBUGGERED; \ } while (0) - **??????**????????????????????????????????????????????????????????? ``??????`` ??????????????????????????? - ?????????????????????????????????????????? +**??????** ????????????????????????????????????????????????????????? ``??????`` ?????????????????????????????? +??????????????????????????????????????? 2) ??????????????????????????????????????????????????? @@ -666,8 +668,8 @@ mm_count)?????????????????? (``struct super_block``???s_count ??? s_active) ??? #define FOO(val) bar(index, val) - ??????????????????????????????????????????????????????????????????????????????????????????????????????????????? - ?????????????????????????????????????????? +????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? +???????????????????????????????????? 3) ????????????????????????????????? FOO(x) = y?????????????????? FOO ???????????????????????????????????? ??????????????????????????? @@ -691,7 +693,7 @@ mm_count)?????????????????? (``struct super_block``???s_count ??? s_active) ??? (ret); \ }) - ret ?????????????????????????????? - __foo_ret ???????????????????????????????????????????????? +ret ?????????????????????????????? - __foo_ret ???????????????????????????????????????????????? cpp ?????????????????????????????????gcc internals ???????????????????????? RTL???????????????????????? ????????????????????? @@ -701,7 +703,7 @@ cpp ?????????????????????????????????gcc internals ???????????????????????? RTL ------------------------------ ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? -????????????????????????????????? ``dont``???????????? ``do not`` ?????? ``don't``?????????????????? +????????????????????????????????? ``dont``???????????? ``do not`` ?????? ``don't`` ?????????????????? ???????????????,???????????? ?????????????????????????????????????????? @@ -762,9 +764,9 @@ kmalloc(), kzalloc(), kmalloc_array(), kcalloc(), vmalloc() ??? vzalloc()??? 15) ???????????? ------------------------------ -???????????????????????????``??????``??? gcc ?????????????????????????????????????????????????????????????????? -????????????????????????????????? (?????????????????????????????????????????????????????????)????????????????????? -??????????????????inline ??????????????????????????????????????????????????????????????????????????????????????? +??????????????????????????? ``??????`` ??? gcc ??????????????????????????????????????????????????????????????? +???????????????????????????????????? (?????????????????????????????????????????????????????????)?????????????????? +?????????????????????inline ?????????????????????????????????????????????????????????????????????????????? ??????????????????????????????????????????????????????????????????????????? pagecache ???????????????????????? ????????????????????? pagecache ??????????????????????????????????????????????????? 5 ?????????5 ????????? ????????? CPU ?????????????????????????????? @@ -783,8 +785,8 @@ inline gcc ????????????????????????????????????????????????????????????????????? 16) ???????????????????????? ------------------------------ -?????????????????????????????????????????????????????????????????????????????????????????????????????????????????? -????????????????????????????????????????????????????????? (-Exxx????????????0?????????) ????????????``??????`` +????????????????????????????????????????????????????????????????????????????????????????????????????????????????????? +??????????????????????????????????????????????????? (-Exxx????????????0?????????) ???????????? ``??????`` ????????? (0???????????????0?????????)??? ??????????????????????????????????????????????????? bug ?????????????????? C ????????????????????????????????? @@ -794,7 +796,7 @@ inline gcc ????????????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????????????????????????????????????????? ?????????????????????????????????????????????????????????????????? "??????" ???????????? -?????????``add work`` ???????????????????????? add_work() ?????????????????? 0????????????????????? +????????? ``add work`` ???????????????????????? add_work() ?????????????????? 0????????????????????? -EBUSY????????????????????? ``PCI device present`` ???????????????????????? pci_dev_present() ??????????????????????????????????????????????????? 1????????????????????????????????? 0??? @@ -828,7 +830,7 @@ inline gcc ????????????????????????????????????????????????????????????????????? 18) ???????????????????????????????????????????????? ------------------------------- +-------------------------------------------------- ????????????????????????????????????????????????????????????????????????????????????????????????????????????emacs ??????????????????????????????????????? @@ -869,7 +871,7 @@ Vim ?????????????????????????????? ???????????????????????????????????????????????????????????????????????? C ????????? ?????????????????????????????????????????????????????? .S ???????????????????????? C ??????????????? C ?????? -???????????????????????? C ?????????????????? ``asmlinkage``??? +???????????????????????? C ?????????????????? ``asmlinkage`` ??? ??????????????????????????????????????? volatile??????????????? GCC ??????????????????????????????????????? ??????????????????????????????????????????????????????????????????????????????????????? diff --git a/Documentation/translations/zh_CN/index.rst b/Documentation/translations/zh_CN/index.rst new file mode 100644 index 0000000..75956d6 --- /dev/null +++ b/Documentation/translations/zh_CN/index.rst @@ -0,0 +1,12 @@ +.. raw:: latex + + \renewcommand\thesection* + \renewcommand\thesubsection* + +Chinese translations +==================== + +.. toctree:: + :maxdepth: 1 + + coding-style -- 2.9.3 -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html