Somehow, this file ended with Documentation/ twice.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/translations/zh_CN/process/submitting-drivers.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/translations/zh_CN/process/submitting-drivers.rst
b/Docu
Em Sat, 22 Jun 2019 08:43:46 -0600
Jonathan Corbet escreveu:
> On Fri, 21 Jun 2019 22:00:46 -0300
> Mauro Carvalho Chehab wrote:
>
> > > +#
> > > +# The DVB docs create references for these basic system calls, leading
> > > +# to lots of confusing links. So just don't link them.
> > > +#
> > >
Hi Greg,
It turns out that fixing ABI/testing for it to be parsed transparently
was easy :-)
This series goes on top of the series I pasted early today:
Subject: [PATCH 00/12] Add the ABI documentation to the admin guide
It basically change the ABI parser to not try to escape Re
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:
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
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
With just a single fix, the contents there can be parsed properly
without the need to escape any ReST incompatible stuff.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/ABI/obsolete/sysfs-gpio | 2 ++
Documentation/admin-guide/abi-obsolete.rst | 1 +
Documentation/admin-guide/abi-re
The files under Documentation/ABI should follow the syntax
as defined at Documentation/ABI/README.
Allow checking if they're following the syntax by running
the ABI parser script on COMPILE_TEST.
With that, when there's a problem with a file under
Documentation/ABI, it would produce a warning lik
Now that ABI/testing documents were fixed, add --rst-sources to
the ABI/testing too.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/admin-guide/abi-testing.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/admin-guide/abi-testing.rst
b/Documentation/admin-guide/abi-t
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
Add a feature list matrix at the admin-guide and a x86-specific
feature list to the respective Kernel books.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/admin-guide/features.rst | 3 +++
Documentation/admin-guide/index.rst| 1 +
Documentation/conf.py | 2 +-
Docum
The feature files have a special well-defined format. Add
a script that parses them, allowing to search for a feature
and/or by an architecture and to produce ReST-compatible
outputs.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/sphinx/kernel_feat.py | 169
Jon, Greg & all:
Not sure what tree this would fit better.
The first 2 patches on this series reimplement the logic at:
Documentation/features/list-arch.sh
I opted to not remove the old script, as someone could depend on
its specific format. The new script does the same with:
.
The status ".." Means that the feature can't be implemented
on a given architecture.
The problem is that this doesn't show anything at the
output, so replace it by "---", with is a markup for a long
hyphen.
Signed-off-by: Mauro Carvalho Chehab
---
scripts/get_feat.pl | 2 ++
1 file changed, 2 i
The Documentation/features contains a set of parseable files.
It is not worth converting them to ReST format, as they're
useful the way it is. It is, however, interesting to parse
them and produce output on different formats:
1) Output the contents of a feature in ReST format;
2) Output what feat
Right now, several ABI files won't parse as ReST, as they
contain severe violations to the spec, with makes the script
to crash.
So, the code has a sanity logic with escapes bad code and
cleans tags that can cause Sphinx to crash.
Add support for disabling this mode.
Right now, as enabling rst-m
The ABI documentation is special: it is not plain text files,
but, instead, files with an strict format, as specified by
Documentation/ABI/README.
Add a parser for it.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/sphinx/kernel_abi.py | 155 +
1 file changed
The Sphinx docutils parser is lazy: if the content is bigger than
a certain number of lines, it silenlty stops parsing it,
producing an incomplete content. This seems to be worse on newer
Sphinx versions, like 2.0.
So, change the logic to parse the contents per input file.
Signed-off-by: Mauro Ca
This file is released under GPL v2.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/sphinx/kernel_abi.py | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/sphinx/kernel_abi.py
b/Documentation/sphinx/kernel_abi.py
index ef91b1e1ff4b..5d43cac73d0a 100644
--- a/Documentation
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
An extension may want to just inform about something. So, add
support for it.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/sphinx/kernellog.py | 6 +-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/Documentation/sphinx/kernellog.py
b/Documentation/sphinx/kernellog.py
The parser breaks with UTF-8 characters with Sphinx 1.4.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/sphinx/kernel_abi.py | 20 +++-
1 file changed, 7 insertions(+), 13 deletions(-)
diff --git a/Documentation/sphinx/kernel_abi.py
b/Documentation/sphinx/kernel_abi.py
As we don't want a generic Sphinx extension to execute commands,
change the one proposed to Markus to call the abi_book.pl
script.
Use a script to parse the Documentation/ABI directory and output
it at the admin-guide.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/admin-guide/abi-obsol
The same way kerneldoc.py needed changes to work with newer
Sphinx, this script needs the same changes.
While here, reorganize the include order to match kerneldoc.py.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/sphinx/kernel_abi.py | 39 +-
1 file changed
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
As Markus doesn't want to maintain ths file, update it to
put me as its maintainer.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/sphinx/kernel_abi.py | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/sphinx/kernel_abi.py
b/Documentation/sphinx/kernel_
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 ++---
Hi Greg/Jon,
That's the rebased patches with add the ABI documentation to the
admin-guide. It is rebased on the top of driver-core/driver-core-next,
and it can work both on the "old" mode, where the scripts will
avoid codes that would cause troubles for ReST, or at the new mode,
with parses the de
Hi,
I'll make a V13 of this patchset on top of -rc6, any feedback
for this IRQ driver? It's been already one month.
Thanks,
-Paul
Le mar. 21 mai 2019 à 16:51, Paul Cercueil a
écrit :
This driver handles the interrupt controller built in the
Timer/Counter
Unit (TCU) of the JZ47xx SoCs from
Hi,
I'll make a V13 of this patchset on top of -rc6, any feedback
for this clocksource driver? It's been already one month.
Thanks,
-Paul
Le mar. 21 mai 2019 à 16:51, Paul Cercueil a
écrit :
This driver handles the TCU (Timer Counter Unit) present on the
Ingenic
JZ47xx SoCs, and provides t
On Fri, 21 Jun 2019 22:00:46 -0300
Mauro Carvalho Chehab wrote:
> > +#
> > +# The DVB docs create references for these basic system calls, leading
> > +# to lots of confusing links. So just don't link them.
> > +#
> > +Skipfuncs = [ 'open', 'close', 'write' ]
>
> and yeah, of course, if there
Hi,
I'll make a V13 of this patchset on top of -rc6, any feedback
for this MFD driver? It's been already one month.
Thanks,
-Paul
Le mar. 21 mai 2019 à 16:51, Paul Cercueil a
écrit :
This driver will provide a regmap that can be retrieved very early in
the boot process through the API func
On Tue, 18 Jun 2019 17:53:40 -0300
Mauro Carvalho Chehab wrote:
> Rename the iio 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
33 matches
Mail list logo