On Fri, Feb 14, 2025 at 12:34 PM Alex Shi <seakeel@xxxxxxxxx> wrote: > > Dongliang Mu <mudongliangabcd@xxxxxxxxx> 于2025年2月14日周五 11:25写道： > > > > On Thu, Feb 13, 2025 at 6:24 PM Yanteng Si <si.yanteng@xxxxxxxxx> wrote: > > > > > > > > > 在 2/13/25 1:42 PM, alexs@xxxxxxxxxx 写道: > > > > From: Alex Shi <alexs@xxxxxxxxxx> > > > > > > > > A good checked summit could save much time for linux-doc maintainer. > > > > > > > > Signed-off-by: Alex Shi <alexs@xxxxxxxxxx> > > > > Cc: Yanteng Si <siyanteng@xxxxxxxxxxx> > > > > Cc: Jonathan Corbet <corbet@xxxxxxx> > > > > Cc: linux-doc@xxxxxxxxxxxxxxx > > > > Cc: linux-kernel@xxxxxxxxxxxxxxx > > > > > > Reviewed-by: Yanteng Si <si.yanteng@xxxxxxxxx> > > > > > > > > > > > > > --- > > > > Documentation/translations/zh_CN/index.rst | 8 +++++++- > > > > 1 file changed, 7 insertions(+), 1 deletion(-) > > > > > > > > diff --git a/Documentation/translations/zh_CN/index.rst b/Documentation/translations/zh_CN/index.rst > > > > index 7574e1673180..cc512ca54172 100644 > > > > --- a/Documentation/translations/zh_CN/index.rst > > > > +++ b/Documentation/translations/zh_CN/index.rst > > > > @@ -26,7 +26,13 @@ > > > > 顺便说下，中文文档也需要遵守内核编码风格，风格中中文和英文的主要不同就是中文 > > > > 的字符标点占用两个英文字符宽度，所以，当英文要求不要超过每行100个字符时， > > > > 中文就不要超过50个字符。另外，也要注意'-'，'='等符号与相关标题的对齐。在将 > > > > -补丁提交到社区之前，一定要进行必要的 ``checkpatch.pl`` 检查和编译测试。 > > > > +补丁提交到社区之前，一定要进行必要的 ``checkpatch.pl`` 检查和编译测试，确保 > > > > +在 ``make htmldocs/pdfdocs`` 中不增加新的告警，最后，安装检查你生成的 > > > > +html/pdf 文件，确认它们看起来是正常的。 > > > > + > > > > +提交之前请确认你的补丁可以正常提交到中文文档维护库: > > > > +https://git.kernel.org/pub/scm/linux/kernel/git/alexs/linux.git/ > > > > > > > +如果你的补丁依赖于其他人的补丁, 可以与其他人商量后由某一个人合并提交。 > > > > > > I think this requires a detailed tutorial. Otherwise, it > > > > > > will increase the difficulty for beginners to get started. > > > > > > How about removing it for now? I have a plan to write > > > > > > a translation guidebook. What's your opinion? > > > > Good idea. I can help contribute. Our Translation Team has a simple > > one to guide team members in kernel document translation. > > > > One issue in my mind is, `make htmldocs` needs much resouce in the compilation. > > Nice doc! Looks very useful. > But it also mentioned 'make htmldocs' is required, so what's your > final suggestion for 'make htmldocs'? My final suggestion is to ask developers to do this as we will check this in the review process. What I mean is to mention that, `make htmldocs` would need lots of time to compile and some tips about this, for example, It takes quite a bit of time to finish running `make htmldocs`. Grab a coffee and relax while you wait! Dongliang Mu > > > > > [1] https://github.com/hust-open-atom-club/TranslateProject/wiki/3.1-%E5%86%85%E6%A0%B8%E6%96%87%E6%A1%A3%E7%BF%BB%E8%AF%91%E6%8C%87%E5%8D%97
