From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Atish Patra <atish.patra@wdc.com>
Cc: "linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
"Łukasz Stelmach" <l.stelmach@samsung.com>,
"Rob Herring" <robh+dt@kernel.org>
Subject: Re: [PATCH 0/7] Fix broken references to files under Documentation/*
Date: Fri, 26 Jul 2019 17:13:52 -0300 [thread overview]
Message-ID: <20190726171352.5eaa4d83@coco.lan> (raw)
In-Reply-To: <04794d40-0b39-0223-c91e-03b46cb6e2db@wdc.com>
Em Fri, 26 Jul 2019 12:55:36 -0700
Atish Patra <atish.patra@wdc.com> 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.
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.
Also, it should be really trivial to convert this one to ReST.
Thanks,
Mauro
next prev parent reply other threads:[~2019-07-26 20:13 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-26 11:47 [PATCH 0/7] Fix broken references to files under Documentation/* Mauro Carvalho Chehab
2019-07-26 19:55 ` Atish Patra
2019-07-26 20:13 ` Mauro Carvalho Chehab [this message]
2019-07-26 20:18 ` Atish Patra
2019-07-26 21:01 ` Mauro Carvalho Chehab
2019-07-26 22:16 ` Atish Patra
2019-07-26 21:01 ` [PATCH] docs: riscv: convert boot-image-header.txt to ReST Mauro Carvalho Chehab
2019-07-26 22:24 ` Atish Patra
2019-07-31 19:02 ` Jonathan Corbet
[not found] ` <CGME20190809101313eucas1p1363a5f60c06081bd9b2ef9b45248414f@eucas1p1.samsung.com>
2019-08-09 10:13 ` [PATCH 0/7] Fix broken references to files under Documentation/* Łukasz Stelmach
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190726171352.5eaa4d83@coco.lan \
--to=mchehab+samsung@kernel.org \
--cc=atish.patra@wdc.com \
--cc=l.stelmach@samsung.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=robh+dt@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).