[PATCH] fixed typo in onewire generic doc

[PATCH] fixed typo in onewire generic doc

[Gergo Huszty]

Signed-off-by: Gergo Huszty <huszty.gergo@digitaltrip.hu>
---
 Documentation/w1/w1.generic | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/w1/w1.generic b/Documentation/w1/w1.generic
index b3ffaf8cfab2..9e5b542305f0 100644
--- a/Documentation/w1/w1.generic
+++ b/Documentation/w1/w1.generic
@@ -76,7 +76,7 @@ See struct w1_bus_master definition in w1.h for details.
 
 w1 master sysfs interface
 ------------------------------------------------------------------
-<xx-xxxxxxxxxxxxx> - A directory for a found device. The format is family-serial
+<xx-xxxxxxxxxxxx> - A directory for a found device. The format is family-serial
 bus                - (standard) symlink to the w1 bus
 driver             - (standard) symlink to the w1 driver
 w1_master_add      - (rw) manually register a slave device
-- 
2.15.1

Re: [PATCH] fixed typo in onewire generic doc

[Jonathan Corbet]

On Tue, 19 Dec 2017 22:33:32 +0100
Gergo Huszty <huszty.gergo@digitaltrip.hu> wrote:

> Signed-off-by: Gergo Huszty <huszty.gergo@digitaltrip.hu>
> ---
>  Documentation/w1/w1.generic | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/w1/w1.generic b/Documentation/w1/w1.generic
> index b3ffaf8cfab2..9e5b542305f0 100644
> --- a/Documentation/w1/w1.generic
> +++ b/Documentation/w1/w1.generic
> @@ -76,7 +76,7 @@ See struct w1_bus_master definition in w1.h for details.
>  
>  w1 master sysfs interface
>  ------------------------------------------------------------------
> -<xx-xxxxxxxxxxxxx> - A directory for a found device. The format is family-serial
> +<xx-xxxxxxxxxxxx> - A directory for a found device. The format is family-serial
>  bus                - (standard) symlink to the w1 bus
>  driver             - (standard) symlink to the w1 driver
>  w1_master_add      - (rw) manually register a slave device


I hate to be picky, but...could I ask you to resubmit this with:

- A changelog describing the nature of the problem you're fixing

- An added space preserving the alignment of the description with the
  following lines?

Thanks,

jon

[PATCH] Fixed typo in onewire generic doc

[Gergo Huszty]

Onewire devices has 6 byte long unique serial numbers, 1 byte family
code and 1 byte CRC. Linux sysfs presents the device folder in the
form of familyID-deviceID, so CRC is not shown. The consequence is
that the device serial number is always a 12 long hex-string, but
doc says 13 in one place. This is corrected by this change.
Reference: https://en.wikipedia.org/wiki/1-Wire

Signed-off-by: Gergo Huszty <huszty.gergo@digitaltrip.hu>
---
 Documentation/w1/w1.generic | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/w1/w1.generic b/Documentation/w1/w1.generic
index b3ffaf8cfab2..c51b1ab012d0 100644
--- a/Documentation/w1/w1.generic
+++ b/Documentation/w1/w1.generic
@@ -76,7 +76,7 @@ See struct w1_bus_master definition in w1.h for details.
 
 w1 master sysfs interface
 ------------------------------------------------------------------
-<xx-xxxxxxxxxxxxx> - A directory for a found device. The format is family-serial
+<xx-xxxxxxxxxxxx>  - A directory for a found device. The format is family-serial
 bus                - (standard) symlink to the w1 bus
 driver             - (standard) symlink to the w1 driver
 w1_master_add      - (rw) manually register a slave device
-- 
2.15.1

Re: [PATCH] Fixed typo in onewire generic doc

[Evgeniy Polyakov]

Hi everyone

I'm really sorry for that long delay.

Was this patch accepted or should I push it upstream?

20.12.2017, 22:09, "Gergo Huszty" <huszty.gergo@digitaltrip.hu>:
> Onewire devices has 6 byte long unique serial numbers, 1 byte family
> code and 1 byte CRC. Linux sysfs presents the device folder in the
> form of familyID-deviceID, so CRC is not shown. The consequence is
> that the device serial number is always a 12 long hex-string, but
> doc says 13 in one place. This is corrected by this change.
> Reference: https://en.wikipedia.org/wiki/1-Wire
>
> Signed-off-by: Gergo Huszty <huszty.gergo@digitaltrip.hu>
> ---
>  Documentation/w1/w1.generic | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/w1/w1.generic b/Documentation/w1/w1.generic
> index b3ffaf8cfab2..c51b1ab012d0 100644
> --- a/Documentation/w1/w1.generic
> +++ b/Documentation/w1/w1.generic
> @@ -76,7 +76,7 @@ See struct w1_bus_master definition in w1.h for details.
>
>  w1 master sysfs interface
>  ------------------------------------------------------------------
> -<xx-xxxxxxxxxxxxx> - A directory for a found device. The format is family-serial
> +<xx-xxxxxxxxxxxx> - A directory for a found device. The format is family-serial
>  bus - (standard) symlink to the w1 bus
>  driver - (standard) symlink to the w1 driver
>  w1_master_add - (rw) manually register a slave device
> --
> 2.15.1

Re: [PATCH] Fixed typo in onewire generic doc

[Jonathan Corbet]

On Mon, 09 Apr 2018 02:56:49 +0300
Evgeniy Polyakov <zbr@ioremap.net> wrote:

> Hi everyone
> 
> I'm really sorry for that long delay.
> 
> Was this patch accepted or should I push it upstream?
> 
> 20.12.2017, 22:09, "Gergo Huszty" <huszty.gergo@digitaltrip.hu>:
> > Onewire devices has 6 byte long unique serial numbers, 1 byte family
> > code and 1 byte CRC. Linux sysfs presents the device folder in the
> > form of familyID-deviceID, so CRC is not shown. The consequence is
> > that the device serial number is always a 12 long hex-string, but
> > doc says 13 in one place. This is corrected by this change.
> > Reference: https://en.wikipedia.org/wiki/1-Wire

Commit d6f44b3bd870ff5946fcd4293b4c07029d8d93c9, merged for 4.16.

jon