[libcamera-devel] libcamera: thread: Fix typo in comment
diff mbox series

Message ID 20210407053139.8686-1-sebastian.fricke@posteo.net
State Accepted
Commit 41d7810436c54bcdfb364f5490649709798006e1
Headers show
Series
  • [libcamera-devel] libcamera: thread: Fix typo in comment
Related show

Commit Message

Sebastian Fricke April 7, 2021, 5:31 a.m. UTC
s/This method enter/This method enters/

Signed-off-by: Sebastian Fricke <sebastian.fricke@posteo.net>
---
 src/libcamera/thread.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jacopo Mondi April 7, 2021, 8:09 a.m. UTC | #1
Hi Sebastian

On Wed, Apr 07, 2021 at 07:31:40AM +0200, Sebastian Fricke wrote:
> s/This method enter/This method enters/

Thanks
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>


>
> Signed-off-by: Sebastian Fricke <sebastian.fricke@posteo.net>
> ---
>  src/libcamera/thread.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/src/libcamera/thread.cpp b/src/libcamera/thread.cpp
> index f339dab1..f14c433f 100644
> --- a/src/libcamera/thread.cpp
> +++ b/src/libcamera/thread.cpp
> @@ -290,7 +290,7 @@ void Thread::startThread()
>  /**
>   * \brief Enter the event loop
>   *
> - * This method enter an event loop based on the event dispatcher instance for
> + * This method enters an event loop based on the event dispatcher instance for
>   * the thread, and blocks until the exit() method is called. It is meant to be
>   * called within the thread from the run() method and shall not be called
>   * outside of the thread.
> --
> 2.25.1
>
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel
Laurent Pinchart April 7, 2021, 8:56 a.m. UTC | #2
Hi Sebastian,

Thank you for the patch.

On Wed, Apr 07, 2021 at 07:31:40AM +0200, Sebastian Fricke wrote:
> s/This method enter/This method enters/

This duplicates the content of the patch itself, but there's really not
much else that needs to be said. In my opinion this is a valid case
where a commit message could be left empty. It doesn't matter much.

> Signed-off-by: Sebastian Fricke <sebastian.fricke@posteo.net>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  src/libcamera/thread.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/thread.cpp b/src/libcamera/thread.cpp
> index f339dab1..f14c433f 100644
> --- a/src/libcamera/thread.cpp
> +++ b/src/libcamera/thread.cpp
> @@ -290,7 +290,7 @@ void Thread::startThread()
>  /**
>   * \brief Enter the event loop
>   *
> - * This method enter an event loop based on the event dispatcher instance for
> + * This method enters an event loop based on the event dispatcher instance for
>   * the thread, and blocks until the exit() method is called. It is meant to be
>   * called within the thread from the run() method and shall not be called
>   * outside of the thread.
Sebastian Fricke April 7, 2021, 9:01 a.m. UTC | #3
Hey Laurent,

On 07.04.2021 11:56, Laurent Pinchart wrote:
>Hi Sebastian,
>
>Thank you for the patch.
>
>On Wed, Apr 07, 2021 at 07:31:40AM +0200, Sebastian Fricke wrote:
>> s/This method enter/This method enters/
>
>This duplicates the content of the patch itself, but there's really not
>much else that needs to be said. In my opinion this is a valid case
>where a commit message could be left empty. It doesn't matter much.

Thank you for that advice, my intention behind this line is to make clear,
which part of the text was changed. I found this often useful when the
commit diff contains a lot of text and the change is very very small
(like adding a missing letter 's'), because in that case the reviewer
would have to read the whole line again to find that error.
Do you think it is beneficial when the reviewer has to spot the error on his own?

>
>> Signed-off-by: Sebastian Fricke <sebastian.fricke@posteo.net>
>
>Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Greetings,

Sebastian
>
>> ---
>>  src/libcamera/thread.cpp | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/src/libcamera/thread.cpp b/src/libcamera/thread.cpp
>> index f339dab1..f14c433f 100644
>> --- a/src/libcamera/thread.cpp
>> +++ b/src/libcamera/thread.cpp
>> @@ -290,7 +290,7 @@ void Thread::startThread()
>>  /**
>>   * \brief Enter the event loop
>>   *
>> - * This method enter an event loop based on the event dispatcher instance for
>> + * This method enters an event loop based on the event dispatcher instance for
>>   * the thread, and blocks until the exit() method is called. It is meant to be
>>   * called within the thread from the run() method and shall not be called
>>   * outside of the thread.
>
>-- 
>Regards,
>
>Laurent Pinchart
Laurent Pinchart April 7, 2021, 9:03 a.m. UTC | #4
Hi Sebastian,

On Wed, Apr 07, 2021 at 11:01:52AM +0200, Sebastian Fricke wrote:
> On 07.04.2021 11:56, Laurent Pinchart wrote:
> > On Wed, Apr 07, 2021 at 07:31:40AM +0200, Sebastian Fricke wrote:
> >> s/This method enter/This method enters/
> >
> > This duplicates the content of the patch itself, but there's really not
> > much else that needs to be said. In my opinion this is a valid case
> > where a commit message could be left empty. It doesn't matter much.
> 
> Thank you for that advice, my intention behind this line is to make clear,
> which part of the text was changed. I found this often useful when the
> commit diff contains a lot of text and the change is very very small
> (like adding a missing letter 's'), because in that case the reviewer
> would have to read the whole line again to find that error.
> Do you think it is beneficial when the reviewer has to spot the error on his own?

For a single line change, I think it's not too hard to spot :-) But
again, it doesn't matter much.

> >> Signed-off-by: Sebastian Fricke <sebastian.fricke@posteo.net>
> >
> > Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> >
> >> ---
> >>  src/libcamera/thread.cpp | 2 +-
> >>  1 file changed, 1 insertion(+), 1 deletion(-)
> >>
> >> diff --git a/src/libcamera/thread.cpp b/src/libcamera/thread.cpp
> >> index f339dab1..f14c433f 100644
> >> --- a/src/libcamera/thread.cpp
> >> +++ b/src/libcamera/thread.cpp
> >> @@ -290,7 +290,7 @@ void Thread::startThread()
> >>  /**
> >>   * \brief Enter the event loop
> >>   *
> >> - * This method enter an event loop based on the event dispatcher instance for
> >> + * This method enters an event loop based on the event dispatcher instance for
> >>   * the thread, and blocks until the exit() method is called. It is meant to be
> >>   * called within the thread from the run() method and shall not be called
> >>   * outside of the thread.

Patch
diff mbox series

diff --git a/src/libcamera/thread.cpp b/src/libcamera/thread.cpp
index f339dab1..f14c433f 100644
--- a/src/libcamera/thread.cpp
+++ b/src/libcamera/thread.cpp
@@ -290,7 +290,7 @@  void Thread::startThread()
 /**
  * \brief Enter the event loop
  *
- * This method enter an event loop based on the event dispatcher instance for
+ * This method enters an event loop based on the event dispatcher instance for
  * the thread, and blocks until the exit() method is called. It is meant to be
  * called within the thread from the run() method and shall not be called
  * outside of the thread.