linux-toradex.git/scripts, branch v5.10-rc2

scripts: get_abi.pl: assume ReST format by default

2020-10-30T12:16:03+00:00

All ABI files are now compatible with ReST format. So, change
the script default to assume that the ABI source files
are compatible with ReST.

Acked-by: Jonathan Corbet 
Signed-off-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/4b0af257010570e0e917d82498e42992bec5e173.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman

docs: ABI: cleanup several ABI documents

2020-10-30T12:14:29+00:00

There are some ABI documents that, while they don't generate
any warnings, they have issues when parsed by get_abi.pl script
on its output result.

Address them, in order to provide a clean output.

Reviewed-by: Tom Rix  # for fpga-manager
Reviewed-By: Kajol Jain # for sysfs-bus-event_source-devices-hv_gpci and sysfs-bus-event_source-devices-hv_24x7
Acked-by: Jonathan Cameron  #for IIO
Acked-by: Oded Gabbay  # for Habanalabs
Acked-by: Vaibhav Jain  # for sysfs-bus-papr-pmem
Acked-by: Cezary Rojewski  # for catpt
Acked-by: Suzuki K Poulose 
Acked-by: Ilya Dryomov  # for rbd
Acked-by: Jonathan Corbet 
Signed-off-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman

docs: Kconfig/Makefile: add a check for broken ABI files

2020-10-30T12:08:07+00:00

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 like:

	Warning: file ./Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats#14:
		What '/sys/bus/pci/devices//aer_stats/aer_rootport_total_err_cor' doesn't have a description
	Warning: file ./Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats#21:
		What '/sys/bus/pci/devices//aer_stats/aer_rootport_total_err_fatal' doesn't have a description

Acked-by: Jonathan Corbet 
Signed-off-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/57a38de85cb4b548857207cf1fc1bf1ee08613c9.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman

scripts: get_abi.pl: auto-generate cross references

2020-10-30T12:02:26+00:00

There are several cross-references that can be automatically
generated:

	- References to .rst files inside Documentation/
	- References to other ABI files;
	- References to ABI symbols at /sys/*.

Add a logic to automatically parse them and convert into
cross references.

Acked-by: Jonathan Corbet 
Signed-off-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/abe756d4f94fb6ffcc3dd3902a766c7c3990ea89.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman

scripts: get_abi.pl: use bold font for ABI definitions

2020-10-30T12:02:26+00:00

As we're using tables, let's distinguish the ones used by ABI
by using a bold font.

Acked-by: Jonathan Corbet 
Signed-off-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/9ed645c2519169817379c1df5b8cf03828e92520.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman

scripts: get_abi.pl: prevent duplicated file names

2020-10-30T12:02:26+00:00

The same filename may exist on multiple directories within
ABI. Create separate entries at the internal database for
each of them.

Acked-by: Jonathan Corbet 
Signed-off-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/ef760f68f54e132c4be52f0027189b4ba31554ec.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman

scripts: get_abi.pl: output users in ReST format

2020-10-30T12:02:26+00:00

Right now, the script only outputs Users on search. Print it
also in ReST format.

Acked-by: Jonathan Corbet 
Signed-off-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/83def2a692c4c678f21ee6e76b66a54d2be1e796.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman

scripts: get_abi.pl: detect duplicated ABI definitions

2020-10-30T12:02:26+00:00

The ABI should define only once each What. The current script
logic assumes that.

However, that's not the case, currently: there are several
symbols with a generic definition, and per-driver ones.

Better handle such cases, by preserving the cross-references
with the files that define them, but also track such
cases, producing warnings, as they should be fixed.

Acked-by: Jonathan Corbet 
Signed-off-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/d7a73b8b3aae5b2bff9279996ff9ca4cdfc89196.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman

scripts: get_abi.pl: cleanup ABI cross-reference logic

2020-10-30T12:02:25+00:00

Right now, the cross-references are generated on a single
step, when doing ReST output.

While this is nice optimization, it prevents auto-creating
cross-references for ABI symbols.

So, split it into a separate logic.

While here, turn on Perl warnings, as it helps to debug
problems inside the script.

Acked-by: Jonathan Corbet 
Signed-off-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/dbc97c8c2dfd877921f058134c35b2a8b1f8414b.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman

scripts: get_abi.pl: improve its parser to better catch up indentation

2020-10-30T12:02:25+00:00

The original parser for indentation were relying on having
just one description for each "what". However, that's not
the case: there are a number of ABI symbols that got defined
multiple times.

Improve the parser for it to better handle descriptions
if entries are duplicated.

Acked-by: Jonathan Corbet 
Signed-off-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/eb458bb30be0e5a89192d6057b2e8a7e910dbcb8.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman