[RFC] Documentation clarifications

[RFC] Documentation clarifications

[Marc Gonzalez]

Not sure about these changes, hence the RFC (some are quite trivial)

diff --git a/Documentation/media/kapi/dtv-core.rst b/Documentation/media/kapi/dtv-core.rst
index ac005b46f23e..9a74b8ba64b7 100644
--- a/Documentation/media/kapi/dtv-core.rst
+++ b/Documentation/media/kapi/dtv-core.rst
@@ -11,8 +11,8 @@ Digital TV devices are implemented by several different drivers:
 
 - Frontend drivers that are usually implemented as two separate drivers:
 
-  - A tuner driver that implements the logic with commands the part of the
-    hardware with is responsible to tune into a digital TV transponder or
+  - A tuner driver that implements the logic which commands the part of
+    the hardware responsible for tuning into a digital TV transponder or
     physical channel. The output of a tuner is usually a baseband or
     Intermediate Frequency (IF) signal;
 
diff --git a/include/media/dvbdev.h b/include/media/dvbdev.h
index 881ca461b7bb..8e47411cf1d9 100644
--- a/include/media/dvbdev.h
+++ b/include/media/dvbdev.h
@@ -86,8 +86,8 @@ struct dvb_frontend;
  * @priv:		private data
  * @device:		pointer to struct device
  * @module:		pointer to struct module
- * @mfe_shared:		mfe shared: indicates mutually exclusive frontends
- *			Thie usage of this flag is currently deprecated
+ * @mfe_shared:		indicates mutually exclusive frontends.
+ *			Use of this flag is currently deprecated.
  * @mfe_dvbdev:		Frontend device in use, in the case of MFE
  * @mfe_lock:		Lock to prevent using the other frontends when MFE is
  *			used.

Re: [RFC] Documentation clarifications

[Mauro Carvalho Chehab]

Em Tue, 4 Jun 2019 18:41:44 +0200
Marc Gonzalez <marc.w.gonzalez@free.fr> escreveu:

> Not sure about these changes, hence the RFC (some are quite trivial)

Looks ok to me. You should submit it as a patch, though, with your SOB.

See https://linuxtv.org/wiki/index.php/Development:_How_to_submit_patches.

> 
> diff --git a/Documentation/media/kapi/dtv-core.rst b/Documentation/media/kapi/dtv-core.rst
> index ac005b46f23e..9a74b8ba64b7 100644
> --- a/Documentation/media/kapi/dtv-core.rst
> +++ b/Documentation/media/kapi/dtv-core.rst
> @@ -11,8 +11,8 @@ Digital TV devices are implemented by several different drivers:
>  
>  - Frontend drivers that are usually implemented as two separate drivers:
>  
> -  - A tuner driver that implements the logic with commands the part of the
> -    hardware with is responsible to tune into a digital TV transponder or
> +  - A tuner driver that implements the logic which commands the part of
> +    the hardware responsible for tuning into a digital TV transponder or
>      physical channel. The output of a tuner is usually a baseband or
>      Intermediate Frequency (IF) signal;
>  
> diff --git a/include/media/dvbdev.h b/include/media/dvbdev.h
> index 881ca461b7bb..8e47411cf1d9 100644
> --- a/include/media/dvbdev.h
> +++ b/include/media/dvbdev.h
> @@ -86,8 +86,8 @@ struct dvb_frontend;
>   * @priv:		private data
>   * @device:		pointer to struct device
>   * @module:		pointer to struct module
> - * @mfe_shared:		mfe shared: indicates mutually exclusive frontends
> - *			Thie usage of this flag is currently deprecated
> + * @mfe_shared:		indicates mutually exclusive frontends.
> + *			Use of this flag is currently deprecated.
>   * @mfe_dvbdev:		Frontend device in use, in the case of MFE
>   * @mfe_lock:		Lock to prevent using the other frontends when MFE is
>   *			used.



Thanks,
Mauro

Re: [RFC] Documentation clarifications

[Marc Gonzalez]

On 04/06/2019 19:26, Mauro Carvalho Chehab wrote:

> Em Tue, 4 Jun 2019 18:41:44 +0200, Marc Gonzalez escreveu:
> 
>> Not sure about these changes, hence the RFC (some are quite trivial)
> 
> Looks ok to me. You should submit it as a patch, though, with your SOB.

I thought that since these were trivial changes, and you were the original
author, you might want to patch them yourself (to keep git "ownership").

If you prefer that I send a formal patch, I can do that instead.

Regards.

Re: [RFC] Documentation clarifications

[Mauro Carvalho Chehab]

Em Wed, 5 Jun 2019 10:08:31 +0200
Marc Gonzalez <marc.w.gonzalez@free.fr> escreveu:

> On 04/06/2019 19:26, Mauro Carvalho Chehab wrote:
> 
> > Em Tue, 4 Jun 2019 18:41:44 +0200, Marc Gonzalez escreveu:
> >   
> >> Not sure about these changes, hence the RFC (some are quite trivial)  
> > 
> > Looks ok to me. You should submit it as a patch, though, with your SOB.  
> 
> I thought that since these were trivial changes, and you were the original
> author, you might want to patch them yourself (to keep git "ownership").
> 
> If you prefer that I send a formal patch, I can do that instead.

I prefer to receive it as a formal patch and give you credits for
this :-)

Thanks,
Mauro

[PATCH] media: docs: fix minor typos

[Marc Gonzalez]

Fix minor typos in the DVB demux documentation.

Signed-off-by: Marc Gonzalez <marc.w.gonzalez@free.fr>
---
 Documentation/media/kapi/dtv-core.rst | 6 +++---
 include/media/dvbdev.h                | 4 ++--
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/media/kapi/dtv-core.rst b/Documentation/media/kapi/dtv-core.rst
index ac005b46f23e..82c5b85ed9b1 100644
--- a/Documentation/media/kapi/dtv-core.rst
+++ b/Documentation/media/kapi/dtv-core.rst
@@ -11,12 +11,12 @@ Digital TV devices are implemented by several different drivers:
 
 - Frontend drivers that are usually implemented as two separate drivers:
 
-  - A tuner driver that implements the logic with commands the part of the
-    hardware with is responsible to tune into a digital TV transponder or
+  - A tuner driver that implements the logic which commands the part of
+    the hardware responsible for tuning into a digital TV transponder or
     physical channel. The output of a tuner is usually a baseband or
     Intermediate Frequency (IF) signal;
 
-  - A demodulator driver (a.k.a "demod") that implements the logic with
+  - A demodulator driver (a.k.a "demod") that implements the logic which
     commands the digital TV decoding hardware. The output of a demod is
     a digital stream, with multiple audio, video and data channels typically
     multiplexed using MPEG Transport Stream [#f1]_.
diff --git a/include/media/dvbdev.h b/include/media/dvbdev.h
index 881ca461b7bb..551325858de3 100644
--- a/include/media/dvbdev.h
+++ b/include/media/dvbdev.h
@@ -86,8 +86,8 @@ struct dvb_frontend;
  * @priv:		private data
  * @device:		pointer to struct device
  * @module:		pointer to struct module
- * @mfe_shared:		mfe shared: indicates mutually exclusive frontends
- *			Thie usage of this flag is currently deprecated
+ * @mfe_shared:		indicates mutually exclusive frontends.
+ *			Use of this flag is currently deprecated.
  * @mfe_dvbdev:		Frontend device in use, in the case of MFE
  * @mfe_lock:		Lock to prevent using the other frontends when MFE is
  *			used.
-- 
2.17.1