Unverified Commit 93d20545 authored by Lukas Bulwahn's avatar Lukas Bulwahn Committed by Mark Brown
Browse files

spi: docs: adjust summary to CONFIG_SYSFS_DEPRECATED removal 



With commit 721da5ce ("driver core: remove CONFIG_SYSFS_DEPRECATED and
CONFIG_SYSFS_DEPRECATED_V2"), ./scripts/checkkconfigsymbols.py indicated
an unresolved reference to the config SYSFS_DEPRECATED in the SPI summary
documentation.

Simply, delete the sentence referring to the removed config there. Also
update the documentation, as these sys/class entries should always be
symlinks, as the commit message of the commit above suggests.

Signed-off-by: default avatarLukas Bulwahn <lukas.bulwahn@gmail.com>
Reviewed-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Link: https://lore.kernel.org/r/20230314075609.5232-1-lukas.bulwahn@gmail.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 4d8ff713

Documentation/spi/spi-summary.rst

+10 −13
Original line number Diff line number Diff line
@@ -178,10 +178,10 @@ shows up in sysfs in several locations:: 


   /sys/bus/spi/drivers/D ... driver for one or more spi*.* devices



   /sys/class/spi_master/spiB ... symlink (or actual device node) to

	a logical node which could hold class related state for the SPI

	master controller managing bus "B".  All spiB.* devices share one

	physical SPI bus segment, with SCLK, MOSI, and MISO.

   /sys/class/spi_master/spiB ... symlink to a logical node which could hold

	class related state for the SPI master controller managing bus "B".

	All spiB.* devices share one physical SPI bus segment, with SCLK,

	MOSI, and MISO.



   /sys/devices/.../CTLR/slave ... virtual file for (un)registering the

	slave device for an SPI slave controller.
@@ -191,16 +191,13 @@ shows up in sysfs in several locations:: 
	Reading from this file shows the name of the slave device ("(null)"

	if not registered).



   /sys/class/spi_slave/spiB ... symlink (or actual device node) to

	a logical node which could hold class related state for the SPI

	slave controller on bus "B".  When registered, a single spiB.*

	device is present here, possible sharing the physical SPI bus

	segment with other SPI slave devices.

   /sys/class/spi_slave/spiB ... symlink to a logical node which could hold

	class related state for the SPI slave controller on bus "B".  When

	registered, a single spiB.* device is present here, possible sharing

	the physical SPI bus segment with other SPI slave devices.



Note that the actual location of the controller's class state depends

on whether you enabled CONFIG_SYSFS_DEPRECATED or not.  At this time,

the only class-specific state is the bus number ("B" in "spiB"), so

those /sys/class entries are only useful to quickly identify busses.

At this time, the only class-specific state is the bus number ("B" in "spiB"),

so those /sys/class entries are only useful to quickly identify busses.





How does board-specific init code declare SPI devices?