[RFC] Documentation clarifications
Commit Message
Not sure about these changes, hence the RFC (some are quite trivial)
Comments
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
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.
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
@@ -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;
@@ -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.