Translation order of documents
4 views
Skip to first unread message
Dongliang Mu
Oct 18, 2024, 1:33:24 AM10/18/24
to Alex Shi, YanTeng Si, Jonathan Corbet, open list:DOCUMENTATION, HUST OS Kernel Contribution
Hi guys,
when I translate kbuild/llvm.rst, I find this document seems depends
on the reproducible-build.html. The depenency means, A will refer to
B, like the following contents.
``ccache`` 可以与 ``clang`` 一起使用，以改善后续构建（尽管在不同构建之间
KBUILD_BUILD_TIMESTAMP_ 应设置为同一确定值，以避免 100% 的缓存未命中，
详见 Reproducible_builds_ 获取更多信息）::
KBUILD_BUILD_TIMESTAMP='' make LLVM=1 CC="ccache clang"
.. _KBUILD_BUILD_TIMESTAMP: kbuild.html#kbuild-build-timestamp
.. _Reproducible_builds: reproducible-builds.html#timestamps
I have several questions in mind:
1. Should we show this dependency graph for translators? This may help
improve translation. Otherwise, it may occur that A has been
translated, but it depends on B. And B needs translated so that the
translation of A can be merged.
2. Would there exist the loop? A depends on B and B depends on A
directly or indirectly.
If we only need to keep the documents in the mainline ready for
reading, it seems not a problem.
P.S., it seems current docs building cannot detect invalid URL in the
documentation tree.
--
My best regards to you.
No System Is Safe!
Dongliang Mu
when I translate kbuild/llvm.rst, I find this document seems depends
on the reproducible-build.html. The depenency means, A will refer to
B, like the following contents.
``ccache`` 可以与 ``clang`` 一起使用，以改善后续构建（尽管在不同构建之间
KBUILD_BUILD_TIMESTAMP_ 应设置为同一确定值，以避免 100% 的缓存未命中，
详见 Reproducible_builds_ 获取更多信息）::
KBUILD_BUILD_TIMESTAMP='' make LLVM=1 CC="ccache clang"
.. _KBUILD_BUILD_TIMESTAMP: kbuild.html#kbuild-build-timestamp
.. _Reproducible_builds: reproducible-builds.html#timestamps
I have several questions in mind:
1. Should we show this dependency graph for translators? This may help
improve translation. Otherwise, it may occur that A has been
translated, but it depends on B. And B needs translated so that the
translation of A can be merged.
2. Would there exist the loop? A depends on B and B depends on A
directly or indirectly.
If we only need to keep the documents in the mainline ready for
reading, it seems not a problem.
P.S., it seems current docs building cannot detect invalid URL in the
documentation tree.
--
My best regards to you.
No System Is Safe!
Dongliang Mu
Randy Dunlap
Oct 23, 2024, 1:17:17 AM10/23/24
to Dongliang Mu, Alex Shi, YanTeng Si, Jonathan Corbet, open list:DOCUMENTATION, HUST OS Kernel Contribution, Nick Desaulniers
[adding Nick D. as author]
On 10/17/24 10:32 PM, Dongliang Mu wrote:
> Hi guys,
>
> when I translate kbuild/llvm.rst, I find this document seems depends
> on the reproducible-build.html. The depenency means, A will refer to
builds
> B, like the following contents.
>
> ``ccache`` 可以与 ``clang`` 一起使用，以改善后续构建（尽管在不同构建之间
> KBUILD_BUILD_TIMESTAMP_ 应设置为同一确定值，以避免 100% 的缓存未命中，
> 详见 Reproducible_builds_ 获取更多信息）::
>
> KBUILD_BUILD_TIMESTAMP='' make LLVM=1 CC="ccache clang"
>
> .. _KBUILD_BUILD_TIMESTAMP: kbuild.html#kbuild-build-timestamp
> .. _Reproducible_builds: reproducible-builds.html#timestamps
>
> I have several questions in mind:
>
> 1. Should we show this dependency graph for translators? This may help
> improve translation. Otherwise, it may occur that A has been
> translated, but it depends on B. And B needs translated so that the
> translation of A can be merged.
>
Yes. (IMHO)
> 2. Would there exist the loop? A depends on B and B depends on A
> directly or indirectly.
>
> If we only need to keep the documents in the mainline ready for
> reading, it seems not a problem.
>
> P.S., it seems current docs building cannot detect invalid URL in the
> documentation tree.
Hm, I thought that there was a script in scripts/ for that but I don't see it...
--
~Randy
On 10/17/24 10:32 PM, Dongliang Mu wrote:
> Hi guys,
>
> when I translate kbuild/llvm.rst, I find this document seems depends
> on the reproducible-build.html. The depenency means, A will refer to
> B, like the following contents.
>
> ``ccache`` 可以与 ``clang`` 一起使用，以改善后续构建（尽管在不同构建之间
> KBUILD_BUILD_TIMESTAMP_ 应设置为同一确定值，以避免 100% 的缓存未命中，
> 详见 Reproducible_builds_ 获取更多信息）::
>
> KBUILD_BUILD_TIMESTAMP='' make LLVM=1 CC="ccache clang"
>
> .. _KBUILD_BUILD_TIMESTAMP: kbuild.html#kbuild-build-timestamp
> .. _Reproducible_builds: reproducible-builds.html#timestamps
>
> I have several questions in mind:
>
> 1. Should we show this dependency graph for translators? This may help
> improve translation. Otherwise, it may occur that A has been
> translated, but it depends on B. And B needs translated so that the
> translation of A can be merged.
>
> 2. Would there exist the loop? A depends on B and B depends on A
> directly or indirectly.
>
> If we only need to keep the documents in the mainline ready for
> reading, it seems not a problem.
>
> P.S., it seems current docs building cannot detect invalid URL in the
> documentation tree.
--
~Randy
Dongliang Mu
Oct 23, 2024, 1:33:07 AM10/23/24
to Randy Dunlap, Alex Shi, YanTeng Si, Jonathan Corbet, open list:DOCUMENTATION, HUST OS Kernel Contribution, Nick Desaulniers
On Wed, Oct 23, 2024 at 1:17 PM Randy Dunlap <rdu...@infradead.org> wrote:
>
> [adding Nick D. as author]
>
> On 10/17/24 10:32 PM, Dongliang Mu wrote:
> > Hi guys,
> >
> > when I translate kbuild/llvm.rst, I find this document seems depends
> > on the reproducible-build.html. The depenency means, A will refer to
>
> builds
>
> > B, like the following contents.
> >
> > ``ccache`` 可以与 ``clang`` 一起使用，以改善后续构建（尽管在不同构建之间
> > KBUILD_BUILD_TIMESTAMP_ 应设置为同一确定值，以避免 100% 的缓存未命中，
> > 详见 Reproducible_builds_ 获取更多信息）::
> >
> > KBUILD_BUILD_TIMESTAMP='' make LLVM=1 CC="ccache clang"
> >
> > .. _KBUILD_BUILD_TIMESTAMP: kbuild.html#kbuild-build-timestamp
> > .. _Reproducible_builds: reproducible-builds.html#timestamps
> >
> > I have several questions in mind:
> >
> > 1. Should we show this dependency graph for translators? This may help
> > improve translation. Otherwise, it may occur that A has been
> > translated, but it depends on B. And B needs translated so that the
> > translation of A can be merged.
> >
>
> Yes. (IMHO)
If no one write code to collect this graph, our hust openatom club
>
> [adding Nick D. as author]
>
> On 10/17/24 10:32 PM, Dongliang Mu wrote:
> > Hi guys,
> >
> > when I translate kbuild/llvm.rst, I find this document seems depends
> > on the reproducible-build.html. The depenency means, A will refer to
>
> builds
>
> > B, like the following contents.
> >
> > ``ccache`` 可以与 ``clang`` 一起使用，以改善后续构建（尽管在不同构建之间
> > KBUILD_BUILD_TIMESTAMP_ 应设置为同一确定值，以避免 100% 的缓存未命中，
> > 详见 Reproducible_builds_ 获取更多信息）::
> >
> > KBUILD_BUILD_TIMESTAMP='' make LLVM=1 CC="ccache clang"
> >
> > .. _KBUILD_BUILD_TIMESTAMP: kbuild.html#kbuild-build-timestamp
> > .. _Reproducible_builds: reproducible-builds.html#timestamps
> >
> > I have several questions in mind:
> >
> > 1. Should we show this dependency graph for translators? This may help
> > improve translation. Otherwise, it may occur that A has been
> > translated, but it depends on B. And B needs translated so that the
> > translation of A can be merged.
> >
>
> Yes. (IMHO)
could help contribute this script.
>
> > 2. Would there exist the loop? A depends on B and B depends on A
> > directly or indirectly.
> >
> > If we only need to keep the documents in the mainline ready for
> > reading, it seems not a problem.
> >
> > P.S., it seems current docs building cannot detect invalid URL in the
> > documentation tree.
>
> Hm, I thought that there was a script in scripts/ for that but I don't see it...
the mainline tree.
This script seems useful. It could help prune old/invalid link and
prevent invalid links into documentation tree.
Dongliang Mu
>
>
> --
> ~Randy
>
Randy Dunlap
Oct 23, 2024, 10:28:17 AM10/23/24
to Dongliang Mu, Alex Shi, YanTeng Si, Jonathan Corbet, open list:DOCUMENTATION, HUST OS Kernel Contribution, Nick Desaulniers
On 10/22/24 10:32 PM, Dongliang Mu wrote:
> On Wed, Oct 23, 2024 at 1:17 PM Randy Dunlap <rdu...@infradead.org> wrote:
>>
>> [adding Nick D. as author]
>>
>> On 10/17/24 10:32 PM, Dongliang Mu wrote:
>>> Hi guys,
>>>
>>> when I translate kbuild/llvm.rst, I find this document seems depends
>>> on the reproducible-build.html. The depenency means, A will refer to
>>
>> builds
>>
>>> B, like the following contents.
>>>
>>> ``ccache`` 可以与 ``clang`` 一起使用，以改善后续构建（尽管在不同构建之间
>>> KBUILD_BUILD_TIMESTAMP_ 应设置为同一确定值，以避免 100% 的缓存未命中，
>>> 详见 Reproducible_builds_ 获取更多信息）::
>>>
>>> KBUILD_BUILD_TIMESTAMP='' make LLVM=1 CC="ccache clang"
>>>
>>> .. _KBUILD_BUILD_TIMESTAMP: kbuild.html#kbuild-build-timestamp
>>> .. _Reproducible_builds: reproducible-builds.html#timestamps
>>>
>>> I have several questions in mind:
>>>
>>> 1. Should we show this dependency graph for translators? This may help
>>> improve translation. Otherwise, it may occur that A has been
>>> translated, but it depends on B. And B needs translated so that the
>>> translation of A can be merged.
>>>
>>
>> Yes. (IMHO)
>
> If no one write code to collect this graph, our hust openatom club
> could help contribute this script.
>
There are a few Makefiles in the Documentation tree.
>>
>>> 2. Would there exist the loop? A depends on B and B depends on A
>>> directly or indirectly.
>>>
>>> If we only need to keep the documents in the mainline ready for
>>> reading, it seems not a problem.
>>>
>>> P.S., it seems current docs building cannot detect invalid URL in the
>>> documentation tree.
>>
>> Hm, I thought that there was a script in scripts/ for that but I don't see it...
>
> I asked this question because I did not find this tool or script in
> the mainline tree.
>
> This script seems useful. It could help prune old/invalid link and
> prevent invalid links into documentation tree.
'linkcheckdocs'.
--
~Randy
Reply all
Reply to author
Forward
0 new messages