[libcamera-devel,v2,1/1] Documentation: guides: introduction: Fixed spelling errors
diff mbox series

Message ID 20220401091359.21194-1-kunalagarwal1072002@gmail.com
State Superseded
Headers show
Series
  • [libcamera-devel,v2,1/1] Documentation: guides: introduction: Fixed spelling errors
Related show

Commit Message

Kunal Agarwal April 1, 2022, 9:13 a.m. UTC
Documentation: guides: introduction: Fixed spelling errors

Fixed two spelling mistakes in introduction.rst
This patch has no functional changes.

Signed-off-by: Kunal Agarwal <kunalagarwal1072002@gmail.com>
---
 Documentation/guides/introduction.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Vedant Paranjape April 1, 2022, 9:32 a.m. UTC | #1
Hello Kunal,

This patch looks good, except this thing.

On Fri, Apr 1, 2022 at 2:45 PM Kunal Agarwal
<kunalagarwal1072002@gmail.com> wrote:
>
> Documentation: guides: introduction: Fixed spelling errors

This shouldn't be there in the commit message, it is the heading.
Please remove it and send a v3. Also, this isn't a patch series, so
1/1 is really not required.

Other than that, everything looks good. You have my R-b tag after you
fix the nitpicks.

>
> Fixed two spelling mistakes in introduction.rst
> This patch has no functional changes.
>
> Signed-off-by: Kunal Agarwal <kunalagarwal1072002@gmail.com>
Reviewed-by: Vedant Paranjape <vedantparanjape160201@gmail.com>

> ---
>  Documentation/guides/introduction.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst
> index e2091797..21880ce7 100644
> --- a/Documentation/guides/introduction.rst
> +++ b/Documentation/guides/introduction.rst
> @@ -9,7 +9,7 @@ collectively as V4L2 (`Video for Linux 2`_) and the `Media Controller`_ API
>  which provide an interface to interact and control media devices.
>
>  Included in this subsystem are drivers for camera sensors, CSI2 (Camera
> -Serial Interface) recievers, and ISPs (Image Signal Processors)
> +Serial Interface) receivers, and ISPs (Image Signal Processors)
>
>  The usage of these drivers to provide a functioning camera stack is a
>  responsibility that lies in userspace which is commonly implemented separately
> @@ -18,7 +18,7 @@ by vendors without a common architecture or API for application developers.
>  libcamera provides a complete camera stack for Linux based systems to abstract
>  functionality desired by camera application developers and process the
>  configuration of hardware and image control algorithms required to obtain
> -desireable results from the camera.
> +desirable results from the camera.
>
>  .. _Video for Linux 2: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/userspace-api/v4l/v4l2.html
>  .. _Media Controller: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/userspace-api/mediactl/media-controller.html
> --
> 2.25.1
>

Regards,
Vedant Paranjape
Kieran Bingham April 1, 2022, 9:32 a.m. UTC | #2
Hi Kuanl,

Quoting Kunal Agarwal via libcamera-devel (2022-04-01 10:13:59)
> Documentation: guides: introduction: Fixed spelling errors

Hrm ... this appears to be duplicated from the title? Have you added the
line twice in your commit message?

(Can easily be dropped when applying, but you only need the title once
in your commit, and git-send-email will put that in the $SUBJECT of the
email).

We normally write subject/commit titles as imperative sentences as in:
  "Fix spelling throughout the guide"

rather than in the past tense as if it has already happened. That is
because the patch is itself actioning the command or instruction set out
by the title.

But the fixes to the document look ok, and is otherwise fine so:

Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> 
> Fixed two spelling mistakes in introduction.rst
> This patch has no functional changes.
> 
> Signed-off-by: Kunal Agarwal <kunalagarwal1072002@gmail.com>
> ---
>  Documentation/guides/introduction.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst
> index e2091797..21880ce7 100644
> --- a/Documentation/guides/introduction.rst
> +++ b/Documentation/guides/introduction.rst
> @@ -9,7 +9,7 @@ collectively as V4L2 (`Video for Linux 2`_) and the `Media Controller`_ API
>  which provide an interface to interact and control media devices.
>  
>  Included in this subsystem are drivers for camera sensors, CSI2 (Camera
> -Serial Interface) recievers, and ISPs (Image Signal Processors)
> +Serial Interface) receivers, and ISPs (Image Signal Processors)
>  
>  The usage of these drivers to provide a functioning camera stack is a
>  responsibility that lies in userspace which is commonly implemented separately
> @@ -18,7 +18,7 @@ by vendors without a common architecture or API for application developers.
>  libcamera provides a complete camera stack for Linux based systems to abstract
>  functionality desired by camera application developers and process the
>  configuration of hardware and image control algorithms required to obtain
> -desireable results from the camera.
> +desirable results from the camera.
>  
>  .. _Video for Linux 2: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/userspace-api/v4l/v4l2.html
>  .. _Media Controller: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/userspace-api/mediactl/media-controller.html
> -- 
> 2.25.1
>

Patch
diff mbox series

diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst
index e2091797..21880ce7 100644
--- a/Documentation/guides/introduction.rst
+++ b/Documentation/guides/introduction.rst
@@ -9,7 +9,7 @@  collectively as V4L2 (`Video for Linux 2`_) and the `Media Controller`_ API
 which provide an interface to interact and control media devices.
 
 Included in this subsystem are drivers for camera sensors, CSI2 (Camera
-Serial Interface) recievers, and ISPs (Image Signal Processors)
+Serial Interface) receivers, and ISPs (Image Signal Processors)
 
 The usage of these drivers to provide a functioning camera stack is a
 responsibility that lies in userspace which is commonly implemented separately
@@ -18,7 +18,7 @@  by vendors without a common architecture or API for application developers.
 libcamera provides a complete camera stack for Linux based systems to abstract
 functionality desired by camera application developers and process the
 configuration of hardware and image control algorithms required to obtain
-desireable results from the camera.
+desirable results from the camera.
 
 .. _Video for Linux 2: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/userspace-api/v4l/v4l2.html
 .. _Media Controller: https://www.linuxtv.org/downloads/v4l-dvb-apis-new/userspace-api/mediactl/media-controller.html