On 7/26/19 1:14 PM, Mauro Carvalho Chehab wrote:
Em Fri, 26 Jul 2019 12:55:36 -0700
Atish Patra <atish.patra@xxxxxxx> escreveu:
On 7/26/19 4:47 AM, Mauro Carvalho Chehab wrote:
Solves most of the pending broken references upstream, except for two of
them:
$ ./scripts/documentation-file-ref-check
Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
As written at boot-image-header.txt, it is waiting for the addition of
a future file:
"The complete booting guide will be available at
Documentation/riscv/booting.txt."
Yeah. We don't have complete booting guide defined in RISC-V land.
Documentation/riscv/booting.txt will be available once we have that.
In the mean time, do we need to convert boot-image-header.txt to
boot-image-header.rst and fix the reference to
Documentation/riscv/booting.rst as well ?
Well, in the mean time, every time someone builds the Kernel with
COMPILE_TEST enabled, a warning will be produced.
So, my suggestion would be to write it on a different way, like:
"A complete booting guide is being written and should be
available on future versions."
Or:
TODO:
Write a complete booting guide.
And update this once the guide is finished. This should be enough
to prevent the warning.
Sounds good to me.
With regards to converting it to ReST, that's recommended. I suspect
we could be able to finish the entire doc conversion in a couple
Kernel versions.
Sure.
Also, it should be really trivial to convert this one to ReST.
Yes. Let me know if you prefer to update it along with your series or I
will send the patch.
Thanks,
Mauro
--
Regards,
Atish
