diff mbox series

Docs: Fixes link to I2C specification

Message ID 20211104060018.35570-1-deep@fastmail.in
State Superseded
Headers show
Series Docs: Fixes link to I2C specification | expand

Commit Message

Deep Majumder Nov. 4, 2021, 6 a.m. UTC
The link to the I2C specification is broken and is replaced in this
patch by one that points to Rev 6 (2014) of the specification.
Although `https://www.nxp.com" hosts the Rev 7 (2021) of this
specification, it is behind a login-wall and thus cannot be used.

Signed-off-by: Deep Majumder <deep@fastmail.in>
---
 Documentation/i2c/summary.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Randy Dunlap Nov. 4, 2021, 3:20 p.m. UTC | #1
On 11/3/21 11:00 PM, Deep Majumder wrote:
> The link to the I2C specification is broken and is replaced in this
> patch by one that points to Rev 6 (2014) of the specification.
> Although `https://www.nxp.com" hosts the Rev 7 (2021) of this
> specification, it is behind a login-wall and thus cannot be used.

To be clear, it can be downloaded if one registers first, but it cannot
easily be downloaded by using something like 'wget filename'.

> 
> Signed-off-by: Deep Majumder <deep@fastmail.in>
> ---
>   Documentation/i2c/summary.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst
> index 136c4e333be7..607c72425ca6 100644
> --- a/Documentation/i2c/summary.rst
> +++ b/Documentation/i2c/summary.rst
> @@ -12,7 +12,7 @@ and so are not advertised as being I2C but come under different names,
>   e.g. TWI (Two Wire Interface), IIC.
>   
>   The official I2C specification is the `"I2C-bus specification and user
> -manual" (UM10204) <https://www.nxp.com/docs/en/user-guide/UM10204.pdf>`_
> +manual" (UM10204) <https://www.pololu.com/file/0J435/UM10204.pdf>`_
>   published by NXP Semiconductors.
>   
>   SMBus (System Management Bus) is based on the I2C protocol, and is mostly
>
Wolfram Sang Nov. 5, 2021, 10:03 p.m. UTC | #2
On Thu, Nov 04, 2021 at 11:30:18AM +0530, Deep Majumder wrote:
> The link to the I2C specification is broken and is replaced in this
> patch by one that points to Rev 6 (2014) of the specification.
> Although `https://www.nxp.com" hosts the Rev 7 (2021) of this
> specification, it is behind a login-wall and thus cannot be used.
> 
> Signed-off-by: Deep Majumder <deep@fastmail.in>

Thanks for pointing out this issue!

>  The official I2C specification is the `"I2C-bus specification and user
> -manual" (UM10204) <https://www.nxp.com/docs/en/user-guide/UM10204.pdf>`_
> +manual" (UM10204) <https://www.pololu.com/file/0J435/UM10204.pdf>`_

I'd think we should have two links. One to the latest official specs,
even though it is behind a login wall. And one to the latest free
version. For that, I think the archieve.org address which Wikipedia uses
is more stable thant the pololu address from above:

https://web.archive.org/web/20210813122132/https://www.nxp.com/docs/en/user-guide/UM10204.pdf

What do you think?
Deep Majumder Nov. 11, 2021, 6:43 p.m. UTC | #3
Wolfram Sang wrote:
> On Thu, Nov 04, 2021 at 11:30:18AM +0530, Deep Majumder wrote:
> > The link to the I2C specification is broken and is replaced in this
> > patch by one that points to Rev 6 (2014) of the specification.
> > Although `https://www.nxp.com" hosts the Rev 7 (2021) of this
> > specification, it is behind a login-wall and thus cannot be used.
> > 
> > Signed-off-by: Deep Majumder <deep@fastmail.in>
> 
> Thanks for pointing out this issue!
> 
> >  The official I2C specification is the `"I2C-bus specification and user
> > -manual" (UM10204) <https://www.nxp.com/docs/en/user-guide/UM10204.pdf>`_
> > +manual" (UM10204) <https://www.pololu.com/file/0J435/UM10204.pdf>`_
> 
> I'd think we should have two links. One to the latest official specs,
> even though it is behind a login wall. And one to the latest free
> version. For that, I think the archieve.org address which Wikipedia uses
> is more stable thant the pololu address from above:
> 
> https://web.archive.org/web/20210813122132/https://www.nxp.com/docs/en/user-guide/UM10204.pdf
> 
> What do you think?
> 
Yes, I agree. Should I update the patch and re-send it?
Wolfram Sang Nov. 11, 2021, 7:36 p.m. UTC | #4
> > I'd think we should have two links. One to the latest official specs,
> > even though it is behind a login wall. And one to the latest free
> > version. For that, I think the archieve.org address which Wikipedia uses
> > is more stable thant the pololu address from above:
> > 
> > https://web.archive.org/web/20210813122132/https://www.nxp.com/docs/en/user-guide/UM10204.pdf
> > 
> > What do you think?
> > 
> Yes, I agree. Should I update the patch and re-send it?

Yes, please.
diff mbox series

Patch

diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst
index 136c4e333be7..607c72425ca6 100644
--- a/Documentation/i2c/summary.rst
+++ b/Documentation/i2c/summary.rst
@@ -12,7 +12,7 @@  and so are not advertised as being I2C but come under different names,
 e.g. TWI (Two Wire Interface), IIC.
 
 The official I2C specification is the `"I2C-bus specification and user
-manual" (UM10204) <https://www.nxp.com/docs/en/user-guide/UM10204.pdf>`_
+manual" (UM10204) <https://www.pololu.com/file/0J435/UM10204.pdf>`_
 published by NXP Semiconductors.
 
 SMBus (System Management Bus) is based on the I2C protocol, and is mostly