diff mbox

Documentation: i2c: Remove obsolete example

Message ID 52975B11.2090006@linux.intel.com
State Accepted
Headers show

Commit Message

Helia Correia Nov. 28, 2013, 3:02 p.m. UTC
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.

Signed-off-by: Helia Correia <helia.correia@intel.com>
---
 Documentation/i2c/fault-codes | 3 ---
 1 file changed, 3 deletions(-)

Comments

Wolfram Sang Jan. 9, 2014, 10 p.m. UTC | #1
On Thu, Nov 28, 2013 at 04:02:41PM +0100, Helia Correia wrote:
> 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.
> 
> Signed-off-by: Helia Correia <helia.correia@intel.com>
> ---

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.
diff mbox

Patch

diff --git a/Documentation/i2c/fault-codes b/Documentation/i2c/fault-codes
index 045765c0b9b5..47c25abb7d52 100644
--- a/Documentation/i2c/fault-codes
+++ b/Documentation/i2c/fault-codes
@@ -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