Skip to contentSkip to conversation

Documentation: i2c: Remove obsolete example

PATCH Applied Helia Correia 2 participants 2 messages Nov 28, 2013 – Jan 9, 2014 1 message not in the archive

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: i2c: Remove obsolete example

Documentation/i2c/fault-codes illustrates EINVAL error code as follows:

"One example would be a driver trying an SMBus Block Write with block size outside the range of 1-32 bytes."

However, the actual implementation of i2c subsystem truncates data length to be 32 bytes.
Hence this example cannot happen anymore, and since it's obsolete, let's simply remove it from Documentation/i2c/fault-codes.

---
 Documentation/i2c/fault-codes | 3 ---
 1 file changed, 3 deletions(-)
Documentation/i2c/fault-codes +0 -3
index 045765c0b9b5..47c25abb7d52 100644
@@ -64,9 +64,6 @@ EINVAL
 	detected before any I/O operation was started.  Use a more
 	specific fault code when you can.
 
-	One example would be a driver trying an SMBus Block Write
-	with block size outside the range of 1-32 bytes.
-
 EIO
 	This rather vague error means something went wrong when
 	performing an I/O operation.  Use a more specific fault
Signature · 1 line
1.8.1.2

A message that is not in the archive (sent off-list or not yet received): 52975B11.2090006-VuQAYsv1563Yd54FQh9/[email protected]

Applied
#2 lore raw
Quoted 6 lines · Helia Correia

Documentation/i2c/fault-codes illustrates EINVAL error code as follows:

"One example would be a driver trying an SMBus Block Write with block size outside the range of 1-32 bytes."

Quoted 7 lines

However, the actual implementation of i2c subsystem truncates data length to be 32 bytes.
Hence this example cannot happen anymore, and since it's obsolete, let's simply remove it from Documentation/i2c/fault-codes.

---

Applied to for-next, thanks! Although, it can still happen that length is 0... we should probably check for this in the core, too. Anyway, the example is not the best, so it can go.