On Thu, Jun 20, 2019 at 11:27:49AM -0300, Mauro Carvalho Chehab wrote:
> Em Wed, 19 Jun 2019 13:14:08 -0300
> Mauro Carvalho Chehab escreveu:
>
> > Em Wed, 19 Jun 2019 17:02:07 +0200
> > Greg Kroah-Hartman escreveu:
> >
> > > On Wed, Jun 19, 2019 at 10:56:33AM -0300, Mauro Carvalho Chehab wrote
Em Fri, 21 Jun 2019 09:21:52 +0200
Greg Kroah-Hartman escreveu:
> On Thu, Jun 20, 2019 at 11:27:49AM -0300, Mauro Carvalho Chehab wrote:
> > Em Wed, 19 Jun 2019 13:14:08 -0300
> > Mauro Carvalho Chehab escreveu:
> >
> > > Em Wed, 19 Jun 2019 17:02:07 +0200
> > > Greg Kroah-Hartman escreveu:
The author of this file should be given an award for creativity:
the What: fields on this file technically fulfills the description
at README. Yet, the way it is, it can't be parsed on a script,
and if someone would try to do something like:
grep hwmon*/jtag_enable
It wouldn't find anythi
On Fri, Jun 21, 2019 at 12:54 PM Mauro Carvalho Chehab
wrote:
>
> The author of this file should be given an award for creativity:
> the What: fields on this file technically fulfills the description
> at README. Yet, the way it is, it can't be parsed on a script,
> and if someone would try to do
On Tue 2019-06-18 17:53:38, Mauro Carvalho Chehab wrote:
> Rename the leds documentation files to ReST, add an
> index for them and adjust in order to produce a nice html
> output via the Sphinx build system.
>
> At its new index.rst, let's add a :orphan: while this is not linked to
> the main ind
As we plan to remove the escaping code from the scripts/get_abi.pl,
specify at the ABI README file that the content of the file should
be ReST compatible.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/ABI/README | 10 +-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git
Hi Greg,
As you proposed to give it a try on removing the escape code from the
script which parses the ReST file, I changed a few things there,
adding the capability of selectively enabling to output an ABI sub-dir
without escaping things that would crash Sphinx.
PS.: As for now this is just a RF
That helps to identify what ABI files are adding titles.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/admin-guide/abi.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/admin-guide/abi.rst
b/Documentation/admin-guide/abi.rst
index 3b9645c77469..bcab3
The author of this file should be given an award for creativity:
the What: fields on this file technically fulfills the description
at README. Yet, the way it is, it can't be parsed on a script,
and if someone would try to do something like:
grep hwmon*/jtag_enable
It wouldn't find anythi
Several entries at the stable ABI files won't parse if we pass
them directly to the ReST output.
Adjust them, in order to allow adding their contents as-is at
the stable ABI book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/ABI/stable/firewire-cdev| 4 +
Documentation/ABI/st
Now that the stable ABI files are compatible with ReST,
parse them without converting complex descriptions as literal
blocks nor escaping special characters.
Please notice that escaping special characters will probably
be needed at descriptions, at least for the asterisk character.
Signed-off-by:
When the source ABI file is using ReST notation, the script
should handle whitespaces and lines with care, as otherwise
the file won't be properly recognized.
Address the bugs that are on such part of the script.
Signed-off-by: Mauro Carvalho Chehab
---
scripts/get_abi.pl | 30 ++---
Em Fri, 21 Jun 2019 09:32:00 -0300
Mauro Carvalho Chehab escreveu:
> Hi Greg,
>
> As you proposed to give it a try on removing the escape code from the
> script which parses the ReST file, I changed a few things there,
> adding the capability of selectively enabling to output an ABI sub-dir
> wi
Em Fri, 21 Jun 2019 09:39:15 -0300
Mauro Carvalho Chehab escreveu:
> Em Fri, 21 Jun 2019 09:32:00 -0300
> Mauro Carvalho Chehab escreveu:
>
> > Hi Greg,
> >
> > As you proposed to give it a try on removing the escape code from the
> > script which parses the ReST file, I changed a few things t
Em Wed, 19 Jun 2019 13:37:39 -0300
Mauro Carvalho Chehab escreveu:
> Em Tue, 18 Jun 2019 11:47:32 +0300
> Jani Nikula escreveu:
>
> > On Mon, 17 Jun 2019, Mauro Carvalho Chehab
> > wrote:
> > > Yeah, I guess it should be possible to do that. How a python script
> > > can identify if it was
There seems to be some confusion surrounding three PHY interface modes,
specifically 1000BASE-X, 2500BASE-X and SGMII. Add some documentation
to phylib detailing precisely what these interface modes refer to.
Signed-off-by: Russell King
---
This is in response to recent discussion, both public
On Thu, Jun 20, 2019 at 02:22:52PM -0300, Mauro Carvalho Chehab wrote:
> This is a rebased version of the scripts with parse
> Documentation/ABI and Documentation/feature files
> and produce a ReST output. Those scripts are added to the
> Kernel building system, in order to output their contents
>
On Tue, Jun 18, 2019 at 02:13:01PM +0100, Kevin Brodsky wrote:
> On 13/06/2019 16:51, Vincenzo Frascino wrote:
> > +The ARM64 Tagged Address ABI is an opt-in feature, and an application can
> > +control it using the following:
> > + - /proc/sys/abi/tagged_addr: a new sysctl interface that can be us
Just like kernel-doc extension, we need to be able to identify
what part of an imported document has issues, as reporting them
as:
get_abi.pl rest --dir $srctree/Documentation/ABI/obsolete
--rst-source:1689: ERROR: Unexpected indentation.
Makes a lot harder for someone to fix.
It should
Reporting an ABI error to the get_abi.pl script is not nice, as it
doesn't maky any easy to fix it.
Instead, just like with kernel-doc, put the fingers to the files
that didn't parse ok:
Documentation/ABI/testing/sysfs-kernel-mm-hugepages:3: WARNING: Definition
list ends without a blank lin
The get_abi.pl reads a lot of files and can join them on a
single output file. Store where each "What:" output came from,
in order to be able to optionally display it.
This is useful for the Sphinx extension, with can now be
able to blame what ABI file has issues, and on what line
the What: descri
Em Fri, 21 Jun 2019 10:04:41 -0300
Mauro Carvalho Chehab escreveu:
> Em Fri, 21 Jun 2019 09:39:15 -0300
> Mauro Carvalho Chehab escreveu:
>
> > Em Fri, 21 Jun 2019 09:32:00 -0300
> > Mauro Carvalho Chehab escreveu:
> >
> > > Hi Greg,
> > >
> > > As you proposed to give it a try on removing
Em Fri, 21 Jun 2019 17:04:45 +0200
Greg KH escreveu:
> On Thu, Jun 20, 2019 at 02:22:52PM -0300, Mauro Carvalho Chehab wrote:
> > This is a rebased version of the scripts with parse
> > Documentation/ABI and Documentation/feature files
> > and produce a ReST output. Those scripts are added to the
On Fri, Jun 21, 2019 at 03:59:09PM +0100, Russell King wrote:
> There seems to be some confusion surrounding three PHY interface modes,
> specifically 1000BASE-X, 2500BASE-X and SGMII. Add some documentation
> to phylib detailing precisely what these interface modes refer to.
>
> Signed-off-by: R
It took me a lng time to get back to this, but here's another crack at
automatically marking up "function()" so we can get rid of all that
unsightly :c:func: gunk in our docs. This time, it's implemented as a pass
over the doctree after everything's read and the references resolved, and
the re
Rather than fill our text files with :c:func:`function()` syntax, just do
the markup via a hook into the sphinx build process.
Signed-off-by: Jonathan Corbet
---
Documentation/conf.py | 3 +-
Documentation/sphinx/automarkup.py | 80 ++
2 files changed, 8
We now have better automarkup in sphinx itself and, besides, this markup
was incorrect and left :c:func: gunk in the processed docs. Sort of
discouraging that nobody ever noticed...:)
As a first step toward the removal of impenetrable regex magic from
kernel-doc it's a tiny one, but you have to s
Now that the build system automatically marks up function references, we
don't have to clutter the source files, so take it out.
[Some paragraphs could now benefit from refilling, but that was left out to
avoid obscuring the real changes.]
Acked-by: Matthew Wilcox
Signed-off-by: Jonathan Corbet
Em Fri, 21 Jun 2019 17:51:57 -0600
Jonathan Corbet escreveu:
> Rather than fill our text files with :c:func:`function()` syntax, just do
> the markup via a hook into the sphinx build process.
Didn't test it, but it sounds a way nicer than the past version!
> Signed-off-by: Jonathan Corbet
> -
29 matches
Mail list logo
