From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Andrea Parri <andrea.parri@amarulasolutions.com>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Alan Stern <stern@rowland.harvard.edu>,
Andrea Parri <parri.andrea@gmail.com>,
Will Deacon <will.deacon@arm.com>,
Peter Zijlstra <peterz@infradead.org>,
Boqun Feng <boqun.feng@gmail.com>,
Nicholas Piggin <npiggin@gmail.com>,
David Howells <dhowells@redhat.com>,
Jade Alglave <j.alglave@ucl.ac.uk>,
Luc Maranget <luc.maranget@inria.fr>,
"Paul E. McKenney" <paulmck@linux.vnet.ibm.com>,
Akira Yokosawa <akiyks@gmail.com>,
Matthew Wilcox <mawilcox@microsoft.com>,
Jeff Layton <jlayton@redhat.com>,
Randy Dunlap <rdunlap@infradead.org>,
Elena Reshetova <elena.reshetova@intel.com>,
"Tobin C. Harding" <me@tobin.cc>
Subject: Re: [PATCH 05/18] docs: core-api: add cachetlb documentation
Date: Tue, 8 May 2018 15:28:51 -0300 [thread overview]
Message-ID: <20180508152851.11f39370@vento.lan> (raw)
In-Reply-To: <20180508150507.284ef477@vento.lan>
Em Tue, 8 May 2018 15:05:07 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> escreveu:
> Em Tue, 08 May 2018 17:40:56 +0300
> Jani Nikula <jani.nikula@linux.intel.com> escreveu:
>
> > On Mon, 07 May 2018, Andrea Parri <andrea.parri@amarulasolutions.com> wrote:
> > > On Mon, May 07, 2018 at 06:35:41AM -0300, Mauro Carvalho Chehab wrote:
> > >> The cachetlb.txt is already in ReST format. So, move it to the
> > >> core-api guide, where it belongs.
> > >>
> > >> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > >> ---
> > >> Documentation/00-INDEX | 2 --
> > >> Documentation/{cachetlb.txt => core-api/cachetlb.rst} | 0
> > >> Documentation/core-api/index.rst | 1 +
> > >> Documentation/memory-barriers.txt | 2 +-
> > >> Documentation/translations/ko_KR/memory-barriers.txt | 2 +-
> > >> 5 files changed, 3 insertions(+), 4 deletions(-)
> > >> rename Documentation/{cachetlb.txt => core-api/cachetlb.rst} (100%)
> > >
> > > I see a few "inline" references to the .txt file in -rc4 (see below):
> > > I am not sure if you managed to update them too.
> >
> > Side note, there's scripts/documentation-file-ref-check to grep the
> > kernel tree for things that look like file references to Documentation/*
> > and complain if they don't exist.
> >
> > I get about 350+ hits with that, patches welcome! ;)
>
> This small script fixes a bunch of such errors:
>
> scripts/documentation-file-ref-check 2>broken_refs
> for i in $(cat broken_refs|cut -d: -f 2|grep -v devicetree|sort|uniq|grep \\.txt); do
> rst=$(basename $i)
> rst=${rst/.txt/.rst}
> f=$(find . -name $rst)
> f=${f#./}
> if [ "$f" != "" ]; then
> echo "Replacing $i to $f"
> for j in $(git grep -l $i); do
> sed "s@$i@$f@g" -i $j
> done
> fi
> done
It follows an improvement to the above script that shows also what
it didn't find as a ReST file, and the ones that have common names
with multiple matches.
I guess we could integrate something like that at
scripts/documentation-file-ref-check, in order to allow auto-correcting
renamed .txt files.
Regards,
Mauro
#!/bin/bash
scripts/documentation-file-ref-check 2>broken_refs
for i in $(cat broken_refs|cut -d: -f 2|grep -v devicetree|sort|uniq|grep \\.txt); do
rst=$(basename $i)
rst=${rst/.txt/.rst}
f=$(find . -name $rst)
if [ "$f" == "" ]; then
echo "ERROR: Didn't find a .rst replacement for $i"
elif [ "$(echo $f | grep ' ')" != "" ]; then
echo "ERROR: Found multiple possible replacements for $i:"
for j in $f; do
echo " $j"
done
else
echo "Replacing $i to $f"
f=${f#./}
for j in $(git grep -l $i); do
sed "s@$i@$f@g" -i $j
done
fi
done
Thanks,
Mauro
next prev parent reply other threads:[~2018-05-08 18:29 UTC|newest]
Thread overview: 87+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-07 9:35 [PATCH 00/18] Fix some build warnings/errors with Sphinx Mauro Carvalho Chehab
2018-05-07 9:35 ` [PATCH 01/18] docs: can.rst: fix a footnote reference Mauro Carvalho Chehab
2018-05-07 18:41 ` Oliver Hartkopp
2018-05-07 9:35 ` [PATCH 02/18] docs: fix location of request_firmware & friends Mauro Carvalho Chehab
2018-05-08 3:07 ` Greg Kroah-Hartman
2018-05-08 15:49 ` Luis R. Rodriguez
2018-05-09 12:26 ` Mauro Carvalho Chehab
2018-05-07 9:35 ` [PATCH 03/18] docs: */index.rst: Add newer documents to their respective index.rst Mauro Carvalho Chehab
2018-05-08 3:07 ` Greg Kroah-Hartman
2018-05-08 15:59 ` Jonathan Corbet
2018-05-07 9:35 ` [PATCH 04/18] docs: admin-guide: add bcache documentation Mauro Carvalho Chehab
2018-05-08 16:01 ` Jonathan Corbet
2018-05-07 9:35 ` [PATCH 05/18] docs: core-api: add cachetlb documentation Mauro Carvalho Chehab
2018-05-07 12:29 ` Andrea Parri
2018-05-08 14:40 ` Jani Nikula
2018-05-08 16:02 ` Andrea Parri
2018-05-08 16:28 ` Andrea Parri
2018-05-08 18:05 ` Mauro Carvalho Chehab
2018-05-08 18:28 ` Mauro Carvalho Chehab [this message]
2018-05-08 19:05 ` Andrea Parri
2018-05-08 16:04 ` Jonathan Corbet
2018-05-08 16:51 ` Andrea Parri
2018-05-07 9:35 ` [PATCH 06/18] docs: core-api: add cgroup-v2 documentation Mauro Carvalho Chehab
2018-05-08 15:51 ` Jonathan Corbet
2018-05-09 12:02 ` Mauro Carvalho Chehab
2018-05-07 9:35 ` [PATCH 07/18] docs: core-api: add circular-buffers documentation Mauro Carvalho Chehab
2018-05-07 12:31 ` Andrea Parri
2018-05-08 16:08 ` Jonathan Corbet
2018-05-07 9:35 ` [PATCH 08/18] docs: driver-api: add clk documentation Mauro Carvalho Chehab
2018-05-08 3:07 ` Greg Kroah-Hartman
2018-05-08 16:10 ` Jonathan Corbet
2018-05-07 9:35 ` [PATCH 09/18] net: mac80211.h: fix a bad comment line Mauro Carvalho Chehab
2018-05-07 12:37 ` Kalle Valo
2018-05-07 12:38 ` Johannes Berg
2018-05-09 12:04 ` Mauro Carvalho Chehab
2018-05-09 12:04 ` Johannes Berg
2018-05-07 9:35 ` [PATCH 10/18] rcu: rcupdate.h: get rid of Sphinx warnings at rcu_pointer_handoff() Mauro Carvalho Chehab
2018-05-07 14:23 ` Paul E. McKenney
2018-05-09 11:55 ` Mauro Carvalho Chehab
2018-05-14 19:40 ` Paul E. McKenney
2018-05-07 9:35 ` [PATCH 11/18] docs: crypto_engine.rst: Fix two parse warnings Mauro Carvalho Chehab
2018-05-07 9:35 ` [PATCH 12/18] time: timer.c: adjust a kernel-doc comment Mauro Carvalho Chehab
2018-05-13 14:00 ` [tip:timers/core] timers: Adjust " tip-bot for Mauro Carvalho Chehab
2018-05-07 9:35 ` [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings Mauro Carvalho Chehab
2018-05-09 8:41 ` Peter Zijlstra
2018-05-09 14:45 ` Jonathan Corbet
2018-05-09 15:20 ` Peter Zijlstra
2018-05-09 18:35 ` Jonathan Corbet
2018-05-09 18:50 ` Markus Heiser
2018-05-09 19:31 ` Peter Zijlstra
2018-05-10 12:23 ` Andrea Parri
2018-05-10 13:15 ` Jonathan Corbet
2018-05-10 16:52 ` Andrea Parri
2018-05-10 17:45 ` Mauro Carvalho Chehab
2018-05-10 8:38 ` Christoph Hellwig
2018-05-10 9:38 ` Mauro Carvalho Chehab
2018-05-10 12:20 ` Peter Zijlstra
2018-05-10 13:04 ` Mauro Carvalho Chehab
2018-05-10 13:30 ` Jonathan Corbet
2018-05-10 13:31 ` Jonathan Corbet
2018-05-10 14:21 ` Mauro Carvalho Chehab
2018-05-10 15:38 ` Jonathan Corbet
2018-05-10 16:42 ` Mauro Carvalho Chehab
2018-05-10 17:14 ` Mauro Carvalho Chehab
2018-05-11 7:06 ` Markus Heiser
2018-05-07 9:35 ` [PATCH 14/18] fbdev: modedb.c: fix a kernel-doc markup Mauro Carvalho Chehab
2018-05-15 10:22 ` Bartlomiej Zolnierkiewicz
2018-05-07 9:35 ` [PATCH 15/18] iio: iio.h: use nested struct support on " Mauro Carvalho Chehab
2018-05-07 17:08 ` Jonathan Cameron
2018-05-09 12:00 ` Mauro Carvalho Chehab
2018-05-07 9:35 ` [PATCH 16/18] mtd: rawnand.h: use nested union kernel-doc markups Mauro Carvalho Chehab
2018-05-07 9:46 ` Boris Brezillon
2018-05-07 11:32 ` Mauro Carvalho Chehab
2018-05-09 12:02 ` Boris Brezillon
2018-05-09 12:10 ` Mauro Carvalho Chehab
2018-05-09 12:22 ` Boris Brezillon
2018-05-09 13:28 ` Mauro Carvalho Chehab
2018-05-09 15:56 ` Boris Brezillon
2018-05-07 9:35 ` [PATCH 17/18] docs: uio-howto.rst: use a code block to solve a warning Mauro Carvalho Chehab
2018-05-08 3:07 ` Greg Kroah-Hartman
2018-05-07 9:35 ` [PATCH 18/18] w1: w1_io.c: fix a kernel-doc warning Mauro Carvalho Chehab
2018-05-08 11:03 ` Evgeniy Polyakov
2018-05-09 12:32 ` Mauro Carvalho Chehab
2018-05-09 13:11 ` Jonathan Corbet
2018-05-10 10:37 ` Evgeniy Polyakov
2018-05-08 16:13 ` [PATCH 00/18] Fix some build warnings/errors with Sphinx Jonathan Corbet
2018-05-08 17:36 ` Luis R. Rodriguez
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=20180508152851.11f39370@vento.lan \
--to=mchehab+samsung@kernel.org \
--cc=akiyks@gmail.com \
--cc=andrea.parri@amarulasolutions.com \
--cc=boqun.feng@gmail.com \
--cc=corbet@lwn.net \
--cc=dhowells@redhat.com \
--cc=elena.reshetova@intel.com \
--cc=j.alglave@ucl.ac.uk \
--cc=jani.nikula@linux.intel.com \
--cc=jlayton@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=luc.maranget@inria.fr \
--cc=mawilcox@microsoft.com \
--cc=me@tobin.cc \
--cc=npiggin@gmail.com \
--cc=parri.andrea@gmail.com \
--cc=paulmck@linux.vnet.ibm.com \
--cc=peterz@infradead.org \
--cc=rdunlap@infradead.org \
--cc=stern@rowland.harvard.edu \
--cc=will.deacon@arm.com \
/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).