[PATCH 0/2] i2c: gpio: fault-injector: minor updates

[PATCH 0/2] i2c: gpio: fault-injector: minor updates

[Wolfram Sang]

While working on a new fault injector, I came up with these two small
improvements. They hopefully make reading docs/source easier when we add more
and more stuff.

Wolfram Sang (2):
  i2c: gpio: fault-injector: sort debugfs files alphabetically
  i2c: gpio: fault-injector: better SPHINX style in docs

 Documentation/i2c/gpio-fault-injection | 10 +++++++---
 drivers/i2c/busses/i2c-gpio.c          |  4 ++--
 2 files changed, 9 insertions(+), 5 deletions(-)

-- 
2.11.0

[PATCH 1/2] i2c: gpio: fault-injector: sort debugfs files alphabetically

[Wolfram Sang]

There is no value in chronological sorting. Make it easier to follow for
humans.

Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
 drivers/i2c/busses/i2c-gpio.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/i2c/busses/i2c-gpio.c b/drivers/i2c/busses/i2c-gpio.c
index d8205b56f243..ca04fa25a141 100644
--- a/drivers/i2c/busses/i2c-gpio.c
+++ b/drivers/i2c/busses/i2c-gpio.c
@@ -181,12 +181,12 @@ static void i2c_gpio_fault_injector_init(struct platform_device *pdev)
 	if (!priv->debug_dir)
 		return;
 
-	debugfs_create_file_unsafe("scl", 0600, priv->debug_dir, priv, &fops_scl);
-	debugfs_create_file_unsafe("sda", 0600, priv->debug_dir, priv, &fops_sda);
 	debugfs_create_file_unsafe("incomplete_address_phase", 0200, priv->debug_dir,
 				   priv, &fops_incomplete_addr_phase);
 	debugfs_create_file_unsafe("incomplete_write_byte", 0200, priv->debug_dir,
 				   priv, &fops_incomplete_write_byte);
+	debugfs_create_file_unsafe("scl", 0600, priv->debug_dir, priv, &fops_scl);
+	debugfs_create_file_unsafe("sda", 0600, priv->debug_dir, priv, &fops_sda);
 }
 
 static void i2c_gpio_fault_injector_exit(struct platform_device *pdev)
-- 
2.11.0

[PATCH 2/2] i2c: gpio: fault-injector: better SPHINX style in docs

[Wolfram Sang]

We don't use SPHINX currently in I2C documentation; but preparing the
I2C fault injector docs already is a good idea since it makes it easier
to read. Especially as new stuff is going to be added soon.

Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
 Documentation/i2c/gpio-fault-injection | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/Documentation/i2c/gpio-fault-injection b/Documentation/i2c/gpio-fault-injection
index a4ce62090fd5..1a44e3edc0c4 100644
--- a/Documentation/i2c/gpio-fault-injection
+++ b/Documentation/i2c/gpio-fault-injection
@@ -1,3 +1,4 @@
+=========================
 Linux I2C fault injection
 =========================
 
@@ -13,6 +14,9 @@ mounted at /sys/kernel/debug. There will be a separate subdirectory per GPIO
 driven I2C bus. Each subdirectory will contain files to trigger the fault
 injection. They will be described now along with their intended use-cases.
 
+Wire states
+===========
+
 "scl"
 -----
 
@@ -34,10 +38,10 @@ I2C specification version 4, section 3.1.16) using the helpers of the Linux I2C
 core (see 'struct bus_recovery_info'). However, the bus recovery will not
 succeed because SDA is still pinned low until you manually release it again
 with "echo 1 > sda". A test with an automatic release can be done with the
-following class of fault injectors.
+"incomplete transfers" class of fault injectors.
 
-Introduction to incomplete transfers
-------------------------------------
+Incomplete transfers
+====================
 
 The following fault injectors create situations where SDA will be held low by a
 device. Bus recovery should be able to fix these situations. But please note:
-- 
2.11.0

Re: [PATCH 0/2] i2c: gpio: fault-injector: minor updates

[Wolfram Sang]

[-- Attachment #1: Type: text/plain, Size: 421 bytes --]

On Mon, Jan 21, 2019 at 03:16:55PM +0100, Wolfram Sang wrote:
> While working on a new fault injector, I came up with these two small
> improvements. They hopefully make reading docs/source easier when we add more
> and more stuff.
> 
> Wolfram Sang (2):
>   i2c: gpio: fault-injector: sort debugfs files alphabetically
>   i2c: gpio: fault-injector: better SPHINX style in docs

Applied to for-next, thanks!


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]