| Message ID | 20190710205802.2204-1-kieran.bingham@ideasonboard.com |
|---|---|
| State | Accepted |
| Headers | show |
| Series |
|
| Related | show |
Hi Kieran, Thanks for the patch. On Wed, Jul 10, 2019 at 09:58:02PM +0100, Kieran Bingham wrote: > Fix a number of spelling errors and word duplications throughout the comments > within libcamera. > > These were picked up with spellintian. > > Also one capitalisation of the first word of a \return statement picked > up by checkstyle.py while creating this patch. > > Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com> Looks good to me. Reviewed-by: Paul Elder <paul.elder@ideasonboard.com> > --- > src/libcamera/buffer.cpp | 2 +- > src/libcamera/camera.cpp | 2 +- > src/libcamera/controls.cpp | 2 +- > src/libcamera/ipa_module.cpp | 2 +- > src/libcamera/pipeline_handler.cpp | 2 +- > src/libcamera/stream.cpp | 2 +- > src/libcamera/v4l2_device.cpp | 2 +- > 7 files changed, 7 insertions(+), 7 deletions(-) > > diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp > index d86278a8a90a..f9e62c218f39 100644 > --- a/src/libcamera/buffer.cpp > +++ b/src/libcamera/buffer.cpp > @@ -222,7 +222,7 @@ Buffer::Buffer() > * \fn Buffer::timestamp() > * \brief Retrieve the time when the buffer was processed > * > - * The timestamp is expressed as a number number of nanoseconds since the epoch. > + * The timestamp is expressed as a number of nanoseconds since the epoch. > * > * \return Timestamp when the buffer was processed > */ > diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp > index 592dfd39eacc..c74c4e4b8450 100644 > --- a/src/libcamera/camera.cpp > +++ b/src/libcamera/camera.cpp > @@ -759,7 +759,7 @@ int Camera::freeBuffers() > * \brief Create a request object for the camera > * > * This method creates an empty request for the application to fill with > - * buffers and paramaters, and queue for capture. > + * buffers and parameters, and queue for capture. > * > * The ownership of the returned request is passed to the caller, which is > * responsible for either queueing the request or deleting it. > diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp > index d9fbd46d81c9..727fdbd9450d 100644 > --- a/src/libcamera/controls.cpp > +++ b/src/libcamera/controls.cpp > @@ -204,7 +204,7 @@ std::string ControlValue::toString() const > * \var Contrast > * ControlType: Integer > * > - * Specify a fixed constrast parameter. > + * Specify a fixed contrast parameter. > */ > > /** > diff --git a/src/libcamera/ipa_module.cpp b/src/libcamera/ipa_module.cpp > index d2e3c366dc04..baf3c5719229 100644 > --- a/src/libcamera/ipa_module.cpp > +++ b/src/libcamera/ipa_module.cpp > @@ -322,7 +322,7 @@ close: > * the IPA module information it contains was successfully retrieved and > * validated. > * > - * \return true if the the IPAModule is valid, false otherwise > + * \return True if the IPAModule is valid, false otherwise > */ > bool IPAModule::isValid() const > { > diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp > index 0283e4e5ad51..26f619ea736b 100644 > --- a/src/libcamera/pipeline_handler.cpp > +++ b/src/libcamera/pipeline_handler.cpp > @@ -149,7 +149,7 @@ PipelineHandler::~PipelineHandler() > * return false. > * > * If multiple instances of a pipeline are available in the system, the > - * PipelineHandler class will be instanciated once per instance, and its match() > + * PipelineHandler class will be instantiated once per instance, and its match() > * function called for every instance. Each call shall acquire media devices for > * one pipeline instance, until all compatible media devices are exhausted. > * > diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp > index d8e87c62281c..9dbb6633c9ce 100644 > --- a/src/libcamera/stream.cpp > +++ b/src/libcamera/stream.cpp > @@ -428,7 +428,7 @@ Stream::Stream() > * \var Stream::bufferPool_ > * \brief The pool of buffers associated with the stream > * > - * The stream buffer pool is populated by the Camera class after a succesfull > + * The stream buffer pool is populated by the Camera class after a successful > * stream configuration. > */ > > diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp > index e3ec44a7f156..9a00566a532b 100644 > --- a/src/libcamera/v4l2_device.cpp > +++ b/src/libcamera/v4l2_device.cpp > @@ -30,7 +30,7 @@ LOG_DEFINE_CATEGORY(V4L2) > * > * The V4L2Device class groups together the methods and fields common to > * both the V4L2VideoDevice and V4L2Subdevice classes, and provides a base > - * class whith methods to open and close the device node associated with the > + * class with methods to open and close the device node associated with the > * device and to perform IOCTL system calls on it. > * > * The V4L2Device class cannot be instantiated directly, as its constructor > -- > 2.20.1 > > _______________________________________________ > libcamera-devel mailing list > libcamera-devel@lists.libcamera.org > https://lists.libcamera.org/listinfo/libcamera-devel
On 11/07/2019 04:36, Paul Elder wrote: > Hi Kieran, > > Thanks for the patch. > > On Wed, Jul 10, 2019 at 09:58:02PM +0100, Kieran Bingham wrote: >> Fix a number of spelling errors and word duplications throughout the comments >> within libcamera. >> >> These were picked up with spellintian. >> >> Also one capitalisation of the first word of a \return statement picked >> up by checkstyle.py while creating this patch. >> >> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com> > > Looks good to me. > > Reviewed-by: Paul Elder <paul.elder@ideasonboard.com> Thanks, pushed with your tag. -- Kieran > >> --- >> src/libcamera/buffer.cpp | 2 +- >> src/libcamera/camera.cpp | 2 +- >> src/libcamera/controls.cpp | 2 +- >> src/libcamera/ipa_module.cpp | 2 +- >> src/libcamera/pipeline_handler.cpp | 2 +- >> src/libcamera/stream.cpp | 2 +- >> src/libcamera/v4l2_device.cpp | 2 +- >> 7 files changed, 7 insertions(+), 7 deletions(-) >> >> diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp >> index d86278a8a90a..f9e62c218f39 100644 >> --- a/src/libcamera/buffer.cpp >> +++ b/src/libcamera/buffer.cpp >> @@ -222,7 +222,7 @@ Buffer::Buffer() >> * \fn Buffer::timestamp() >> * \brief Retrieve the time when the buffer was processed >> * >> - * The timestamp is expressed as a number number of nanoseconds since the epoch. >> + * The timestamp is expressed as a number of nanoseconds since the epoch. >> * >> * \return Timestamp when the buffer was processed >> */ >> diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp >> index 592dfd39eacc..c74c4e4b8450 100644 >> --- a/src/libcamera/camera.cpp >> +++ b/src/libcamera/camera.cpp >> @@ -759,7 +759,7 @@ int Camera::freeBuffers() >> * \brief Create a request object for the camera >> * >> * This method creates an empty request for the application to fill with >> - * buffers and paramaters, and queue for capture. >> + * buffers and parameters, and queue for capture. >> * >> * The ownership of the returned request is passed to the caller, which is >> * responsible for either queueing the request or deleting it. >> diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp >> index d9fbd46d81c9..727fdbd9450d 100644 >> --- a/src/libcamera/controls.cpp >> +++ b/src/libcamera/controls.cpp >> @@ -204,7 +204,7 @@ std::string ControlValue::toString() const >> * \var Contrast >> * ControlType: Integer >> * >> - * Specify a fixed constrast parameter. >> + * Specify a fixed contrast parameter. >> */ >> >> /** >> diff --git a/src/libcamera/ipa_module.cpp b/src/libcamera/ipa_module.cpp >> index d2e3c366dc04..baf3c5719229 100644 >> --- a/src/libcamera/ipa_module.cpp >> +++ b/src/libcamera/ipa_module.cpp >> @@ -322,7 +322,7 @@ close: >> * the IPA module information it contains was successfully retrieved and >> * validated. >> * >> - * \return true if the the IPAModule is valid, false otherwise >> + * \return True if the IPAModule is valid, false otherwise >> */ >> bool IPAModule::isValid() const >> { >> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp >> index 0283e4e5ad51..26f619ea736b 100644 >> --- a/src/libcamera/pipeline_handler.cpp >> +++ b/src/libcamera/pipeline_handler.cpp >> @@ -149,7 +149,7 @@ PipelineHandler::~PipelineHandler() >> * return false. >> * >> * If multiple instances of a pipeline are available in the system, the >> - * PipelineHandler class will be instanciated once per instance, and its match() >> + * PipelineHandler class will be instantiated once per instance, and its match() >> * function called for every instance. Each call shall acquire media devices for >> * one pipeline instance, until all compatible media devices are exhausted. >> * >> diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp >> index d8e87c62281c..9dbb6633c9ce 100644 >> --- a/src/libcamera/stream.cpp >> +++ b/src/libcamera/stream.cpp >> @@ -428,7 +428,7 @@ Stream::Stream() >> * \var Stream::bufferPool_ >> * \brief The pool of buffers associated with the stream >> * >> - * The stream buffer pool is populated by the Camera class after a succesfull >> + * The stream buffer pool is populated by the Camera class after a successful >> * stream configuration. >> */ >> >> diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp >> index e3ec44a7f156..9a00566a532b 100644 >> --- a/src/libcamera/v4l2_device.cpp >> +++ b/src/libcamera/v4l2_device.cpp >> @@ -30,7 +30,7 @@ LOG_DEFINE_CATEGORY(V4L2) >> * >> * The V4L2Device class groups together the methods and fields common to >> * both the V4L2VideoDevice and V4L2Subdevice classes, and provides a base >> - * class whith methods to open and close the device node associated with the >> + * class with methods to open and close the device node associated with the >> * device and to perform IOCTL system calls on it. >> * >> * The V4L2Device class cannot be instantiated directly, as its constructor >> -- >> 2.20.1 >> >> _______________________________________________ >> libcamera-devel mailing list >> libcamera-devel@lists.libcamera.org >> https://lists.libcamera.org/listinfo/libcamera-devel
diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp index d86278a8a90a..f9e62c218f39 100644 --- a/src/libcamera/buffer.cpp +++ b/src/libcamera/buffer.cpp @@ -222,7 +222,7 @@ Buffer::Buffer() * \fn Buffer::timestamp() * \brief Retrieve the time when the buffer was processed * - * The timestamp is expressed as a number number of nanoseconds since the epoch. + * The timestamp is expressed as a number of nanoseconds since the epoch. * * \return Timestamp when the buffer was processed */ diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp index 592dfd39eacc..c74c4e4b8450 100644 --- a/src/libcamera/camera.cpp +++ b/src/libcamera/camera.cpp @@ -759,7 +759,7 @@ int Camera::freeBuffers() * \brief Create a request object for the camera * * This method creates an empty request for the application to fill with - * buffers and paramaters, and queue for capture. + * buffers and parameters, and queue for capture. * * The ownership of the returned request is passed to the caller, which is * responsible for either queueing the request or deleting it. diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp index d9fbd46d81c9..727fdbd9450d 100644 --- a/src/libcamera/controls.cpp +++ b/src/libcamera/controls.cpp @@ -204,7 +204,7 @@ std::string ControlValue::toString() const * \var Contrast * ControlType: Integer * - * Specify a fixed constrast parameter. + * Specify a fixed contrast parameter. */ /** diff --git a/src/libcamera/ipa_module.cpp b/src/libcamera/ipa_module.cpp index d2e3c366dc04..baf3c5719229 100644 --- a/src/libcamera/ipa_module.cpp +++ b/src/libcamera/ipa_module.cpp @@ -322,7 +322,7 @@ close: * the IPA module information it contains was successfully retrieved and * validated. * - * \return true if the the IPAModule is valid, false otherwise + * \return True if the IPAModule is valid, false otherwise */ bool IPAModule::isValid() const { diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp index 0283e4e5ad51..26f619ea736b 100644 --- a/src/libcamera/pipeline_handler.cpp +++ b/src/libcamera/pipeline_handler.cpp @@ -149,7 +149,7 @@ PipelineHandler::~PipelineHandler() * return false. * * If multiple instances of a pipeline are available in the system, the - * PipelineHandler class will be instanciated once per instance, and its match() + * PipelineHandler class will be instantiated once per instance, and its match() * function called for every instance. Each call shall acquire media devices for * one pipeline instance, until all compatible media devices are exhausted. * diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp index d8e87c62281c..9dbb6633c9ce 100644 --- a/src/libcamera/stream.cpp +++ b/src/libcamera/stream.cpp @@ -428,7 +428,7 @@ Stream::Stream() * \var Stream::bufferPool_ * \brief The pool of buffers associated with the stream * - * The stream buffer pool is populated by the Camera class after a succesfull + * The stream buffer pool is populated by the Camera class after a successful * stream configuration. */ diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp index e3ec44a7f156..9a00566a532b 100644 --- a/src/libcamera/v4l2_device.cpp +++ b/src/libcamera/v4l2_device.cpp @@ -30,7 +30,7 @@ LOG_DEFINE_CATEGORY(V4L2) * * The V4L2Device class groups together the methods and fields common to * both the V4L2VideoDevice and V4L2Subdevice classes, and provides a base - * class whith methods to open and close the device node associated with the + * class with methods to open and close the device node associated with the * device and to perform IOCTL system calls on it. * * The V4L2Device class cannot be instantiated directly, as its constructor
Fix a number of spelling errors and word duplications throughout the comments within libcamera. These were picked up with spellintian. Also one capitalisation of the first word of a \return statement picked up by checkstyle.py while creating this patch. Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com> --- src/libcamera/buffer.cpp | 2 +- src/libcamera/camera.cpp | 2 +- src/libcamera/controls.cpp | 2 +- src/libcamera/ipa_module.cpp | 2 +- src/libcamera/pipeline_handler.cpp | 2 +- src/libcamera/stream.cpp | 2 +- src/libcamera/v4l2_device.cpp | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-)