[libcamera-devel] libcamera: pipeline_handler: Fix trivial spelling

Message ID 20191018153920.13394-1-kieran.bingham@ideasonboard.com
State Accepted
Commit 3774f23f8eaeb5a303539081938533381862dfe1
Headers show
Series
  • [libcamera-devel] libcamera: pipeline_handler: Fix trivial spelling
Related show

Commit Message

Kieran Bingham Oct. 18, 2019, 3:39 p.m. UTC
Signaled is an American spelling.

  s/signaled/signalled/

Fixes: b2c06cf40975 ("libcamera: Handle request completion explicitly in pipeline handlers")
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 src/libcamera/pipeline_handler.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Laurent Pinchart Oct. 20, 2019, 7:13 a.m. UTC | #1
Hi Kieran,

Thank you for the patch.

On Fri, Oct 18, 2019 at 04:39:20PM +0100, Kieran Bingham wrote:
> Signaled is an American spelling.
> 
>   s/signaled/signalled/

You know that's a lost fight, right ? :-) I however value consistency,
and as with started with UK spelling, we can continue with it. Care to
implement support for spell checking in checkstyle.py ? :-)

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

> Fixes: b2c06cf40975 ("libcamera: Handle request completion explicitly in pipeline handlers")
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> ---
>  src/libcamera/pipeline_handler.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
> index cb4337e50eb6..bf8c86d35c4f 100644
> --- a/src/libcamera/pipeline_handler.cpp
> +++ b/src/libcamera/pipeline_handler.cpp
> @@ -353,7 +353,7 @@ const ControlInfoMap &PipelineHandler::controls(Camera *camera)
>   * Pipeline handlers shall override this method. The base implementation in the
>   * PipelineHandler class keeps track of queued requests in order to ensure
>   * completion of all requests when the pipeline handler is stopped with stop().
> - * Requests completion shall be signaled by the pipeline handler using the
> + * Requests completion shall be signalled by the pipeline handler using the
>   * completeRequest() method.
>   *
>   * \return 0 on success or a negative error code otherwise
Kieran Bingham Oct. 21, 2019, 10:34 a.m. UTC | #2
Hi Laurent,

On 20/10/2019 08:13, Laurent Pinchart wrote:
> Hi Kieran,
> 
> Thank you for the patch.
> 
> On Fri, Oct 18, 2019 at 04:39:20PM +0100, Kieran Bingham wrote:
>> Signaled is an American spelling.
>>
>>   s/signaled/signalled/
> 
> You know that's a lost fight, right ? :-)

Yes, but we already have a usage of signalled in the code base, so this
is consistent with our existing code base IMO.

(but we also have imported headers from google with signaled which cause
me despair, but they are external imports, so can be ignored somewhat :D)

> I however value consistency,
> and as with started with UK spelling, we can continue with it. Care to
> implement support for spell checking in checkstyle.py ? :-)

I hope to some time... yes...

> Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> 
>> Fixes: b2c06cf40975 ("libcamera: Handle request completion explicitly in pipeline handlers")
>> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
>> ---
>>  src/libcamera/pipeline_handler.cpp | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
>> index cb4337e50eb6..bf8c86d35c4f 100644
>> --- a/src/libcamera/pipeline_handler.cpp
>> +++ b/src/libcamera/pipeline_handler.cpp
>> @@ -353,7 +353,7 @@ const ControlInfoMap &PipelineHandler::controls(Camera *camera)
>>   * Pipeline handlers shall override this method. The base implementation in the
>>   * PipelineHandler class keeps track of queued requests in order to ensure
>>   * completion of all requests when the pipeline handler is stopped with stop().
>> - * Requests completion shall be signaled by the pipeline handler using the
>> + * Requests completion shall be signalled by the pipeline handler using the
>>   * completeRequest() method.
>>   *
>>   * \return 0 on success or a negative error code otherwise
>

Patch

diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
index cb4337e50eb6..bf8c86d35c4f 100644
--- a/src/libcamera/pipeline_handler.cpp
+++ b/src/libcamera/pipeline_handler.cpp
@@ -353,7 +353,7 @@  const ControlInfoMap &PipelineHandler::controls(Camera *camera)
  * Pipeline handlers shall override this method. The base implementation in the
  * PipelineHandler class keeps track of queued requests in order to ensure
  * completion of all requests when the pipeline handler is stopped with stop().
- * Requests completion shall be signaled by the pipeline handler using the
+ * Requests completion shall be signalled by the pipeline handler using the
  * completeRequest() method.
  *
  * \return 0 on success or a negative error code otherwise