[{"id":888,"web_url":"https://patchwork.libcamera.org/comment/888/","msgid":"<20190226164823.t7vg5okv24f5knnh@uno.localdomain>","date":"2019-02-26T16:48:23","subject":"Re: [libcamera-devel] [PATCH 2/8] libcamera: align the\n\tdocumentation for numeric error codes","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Niklas,\n thanks for doing this nice standardization work\n\nOn Tue, Feb 26, 2019 at 03:18:51AM +0100, Niklas Söderlund wrote:\n> Rapid growth of the library have resulted in slightly different wording\n> to document that a function returns 0 on success or a negative error\n> code. Align all different variations.\n>\n\nI would have kept the \"negative error code otherwise\", but it's fine..\n\nReviewed-by: Jacopo Mondi \n\nThanks\n j\n\n> Signed-off-by: Niklas Söderlund \n> ---\n> src/libcamera/buffer.cpp | 6 +++---\n> src/libcamera/camera.cpp | 12 ++++++------\n> src/libcamera/camera_manager.cpp | 2 +-\n> src/libcamera/device_enumerator.cpp | 7 +++----\n> src/libcamera/media_device.cpp | 8 ++++----\n> src/libcamera/media_object.cpp | 5 ++---\n> src/libcamera/pipeline_handler.cpp | 10 +++++-----\n> src/libcamera/request.cpp | 2 +-\n> src/libcamera/v4l2_device.cpp | 16 ++++++++--------\n> src/libcamera/v4l2_subdevice.cpp | 10 +++++-----\n> 10 files changed, 38 insertions(+), 40 deletions(-)\n>\n> diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp\n> index 9ec372c2981b5b02..f7c5f0e6a3fe0e55 100644\n> --- a/src/libcamera/buffer.cpp\n> +++ b/src/libcamera/buffer.cpp\n> @@ -71,7 +71,7 @@ Plane::~Plane()\n> * The \\a fd dmabuf file handle is duplicated and stored. The caller may close\n> * the original file handle.\n> *\n> - * \\return 0 on success or a negative error value otherwise.\n> + * \\return 0 on success or a negative error code\n> */\n> int Plane::setDmabuf(int fd, unsigned int length)\n> {\n> @@ -106,7 +106,7 @@ int Plane::setDmabuf(int fd, unsigned int length)\n> *\n> * \\sa setDmaBuf()\n> *\n> - * \\return 0 on success or a negative error value otherwise.\n> + * \\return 0 on success or a negative error code\n> */\n> int Plane::mmap()\n> {\n> @@ -133,7 +133,7 @@ int Plane::mmap()\n> *\n> * Unmap the memory mapped by an earlier call to mmap().\n> *\n> - * \\return 0 on success or a negative error value otherwise.\n> + * \\return 0 on success or a negative error code\n> */\n> int Plane::munmap()\n> {\n> diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp\n> index 6409d10ff88b2189..e2372fea31e2921a 100644\n> --- a/src/libcamera/camera.cpp\n> +++ b/src/libcamera/camera.cpp\n> @@ -157,7 +157,7 @@ void Camera::disconnect()\n> *\n> * \\todo Implement exclusive access across processes.\n> *\n> - * \\return 0 on success or a negative error code on error.\n> + * \\return 0 on success or a negative error code\n> */\n> int Camera::acquire()\n> {\n> @@ -235,7 +235,7 @@ Camera::streamConfiguration(std::vector &streams)\n> * Exclusive access to the camera shall be ensured by a call to acquire() prior\n> * to calling this function, otherwise an -EACCES error will be returned.\n> *\n> - * \\return 0 on success or a negative error code on error.\n> + * \\return 0 on success or a negative error code\n> * \\retval -ENODEV The camera is not connected to any hardware\n> * \\retval -EACCES The user has not acquired exclusive access to the camera\n> * \\retval -EINVAL The configuration is not valid\n> @@ -278,7 +278,7 @@ int Camera::configureStreams(std::map &config)\n>\n> /**\n> * \\brief Allocate buffers for all configured streams\n> - * \\return 0 on success or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int Camera::allocateBuffers()\n> {\n> @@ -350,7 +350,7 @@ Request *Camera::createRequest()\n> * Ownership of the request is transferred to the camera. It will be deleted\n> * automatically after it completes.\n> *\n> - * \\return 0 on success or a negative error code on error\n> + * \\return 0 on success or a negative error code\n> */\n> int Camera::queueRequest(Request *request)\n> {\n> @@ -376,7 +376,7 @@ int Camera::queueRequest(Request *request)\n> * can queue requests to the camera to process and return to the application\n> * until the capture session is terminated with \\a stop().\n> *\n> - * \\return 0 on success or a negative error code on error\n> + * \\return 0 on success or a negative error code\n> */\n> int Camera::start()\n> {\n> @@ -395,7 +395,7 @@ int Camera::start()\n> * This method stops capturing and processing requests immediately. All pending\n> * requests are cancelled and complete synchronously in an error state.\n> *\n> - * \\return 0 on success or a negative error code on error\n> + * \\return 0 on success or a negative error code\n> */\n> int Camera::stop()\n> {\n> diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp\n> index f90201ade18b61dd..6878cc7e26b24ca4 100644\n> --- a/src/libcamera/camera_manager.cpp\n> +++ b/src/libcamera/camera_manager.cpp\n> @@ -74,7 +74,7 @@ CameraManager::~CameraManager()\n> * interact with cameras in the system until either the camera manager\n> * is stopped or the camera is unplugged from the system.\n> *\n> - * \\return 0 on successful start, or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int CameraManager::start()\n> {\n> diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp\n> index 66819f077c16c721..b35ac2bb626ec3c6 100644\n> --- a/src/libcamera/device_enumerator.cpp\n> +++ b/src/libcamera/device_enumerator.cpp\n> @@ -178,7 +178,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> /**\n> * \\fn DeviceEnumerator::init()\n> * \\brief Initialize the enumerator\n> - * \\return 0 on success, or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> * \\retval -EBUSY the enumerator has already been initialized\n> * \\retval -ENODEV the enumerator can't enumerate devices\n> */\n> @@ -195,7 +195,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> * with a warning message logged, without returning an error. Only errors that\n> * prevent enumeration altogether shall be fatal.\n> *\n> - * \\return 0 on success, or a negative error code on fatal errors.\n> + * \\return 0 on success or a negative error code\n> */\n>\n> /**\n> @@ -206,8 +206,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> * and look up device nodes associated with all entities. Store the media device\n> * in the internal list for later matching with pipeline handlers.\n> *\n> - * \\return 0 on success, or a negative error code if the media device can't be\n> - * created or populated\n> + * \\return 0 on success or a negative error code\n> */\n> int DeviceEnumerator::addDevice(const std::string &deviceNode)\n> {\n> diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp\n> index 800ed330fe6d8d6f..4f494e316867a55c 100644\n> --- a/src/libcamera/media_device.cpp\n> +++ b/src/libcamera/media_device.cpp\n> @@ -136,7 +136,7 @@ bool MediaDevice::acquire()\n> *\n> * If the device is already open the function returns -EBUSY.\n> *\n> - * \\return 0 on success or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int MediaDevice::open()\n> {\n> @@ -206,7 +206,7 @@ void MediaDevice::close()\n> * while pads are accessible from the entity they belong to and links from the\n> * pads they connect.\n> *\n> - * \\return 0 on success, a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int MediaDevice::populate()\n> {\n> @@ -405,7 +405,7 @@ MediaLink *MediaDevice::link(const MediaPad *source, const MediaPad *sink)\n> * Disable all the media device links, clearing the MEDIA_LNK_FL_ENABLED flag\n> * on links which are not flagged as IMMUTABLE.\n> *\n> - * \\return 0 on success, or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int MediaDevice::disableLinks()\n> {\n> @@ -705,7 +705,7 @@ void MediaDevice::fixupEntityFlags(struct media_v2_entity *entity)\n> *\n> * \\sa MediaLink::setEnabled(bool enable)\n> *\n> - * \\return 0 on success, or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int MediaDevice::setupLink(const MediaLink *link, unsigned int flags)\n> {\n> diff --git a/src/libcamera/media_object.cpp b/src/libcamera/media_object.cpp\n> index f6abcd8676a3866d..79126124caf98497 100644\n> --- a/src/libcamera/media_object.cpp\n> +++ b/src/libcamera/media_object.cpp\n> @@ -111,7 +111,7 @@ LOG_DECLARE_CATEGORY(MediaDevice)\n> * Enabling a link establishes a data connection between two pads, while\n> * disabling it interrupts that connection.\n> *\n> - * \\return 0 on success, or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int MediaLink::setEnabled(bool enable)\n> {\n> @@ -337,8 +337,7 @@ const MediaPad *MediaEntity::getPadById(unsigned int id) const\n> /**\n> * \\brief Set the path to the device node for the associated interface\n> * \\param deviceNode The interface device node path associated with this entity\n> - * \\return 0 on success, or a negative error code if the device node can't be\n> - * accessed\n> + * \\return 0 on success or a negative error code\n> */\n> int MediaEntity::setDeviceNode(const std::string &deviceNode)\n> {\n> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\n> index dad0a2964486c5d4..0a858fbe13257c7f 100644\n> --- a/src/libcamera/pipeline_handler.cpp\n> +++ b/src/libcamera/pipeline_handler.cpp\n> @@ -144,7 +144,7 @@ PipelineHandler::~PipelineHandler()\n> * configuration of a subset of the streams can't be satisfied, the\n> * whole configuration is considered invalid.\n> *\n> - * \\return 0 on success or a negative error code on error.\n> + * \\return 0 on success or a negative error code\n> */\n>\n> /**\n> @@ -158,7 +158,7 @@ PipelineHandler::~PipelineHandler()\n> *\n> * The intended caller of this method is the Camera class.\n> *\n> - * \\return 0 on success or a negative error code on error\n> + * \\return 0 on success or a negative error code\n> */\n>\n> /**\n> @@ -172,7 +172,7 @@ PipelineHandler::~PipelineHandler()\n> *\n> * The intended caller of this method is the Camera class.\n> *\n> - * \\return 0 on success or a negative error code on error\n> + * \\return 0 on success or a negative error code\n> */\n>\n> /**\n> @@ -185,7 +185,7 @@ PipelineHandler::~PipelineHandler()\n> * class which will in turn be called from the application to indicate that it\n> * has configured the streams and is ready to capture.\n> *\n> - * \\return 0 on success or a negative error code on error\n> + * \\return 0 on success or a negative error code\n> */\n>\n> /**\n> @@ -211,7 +211,7 @@ PipelineHandler::~PipelineHandler()\n> * parameters will be applied to the frames captured in the buffers provided in\n> * the request.\n> *\n> - * \\return 0 on success or a negative error code on error\n> + * \\return 0 on success or a negative error code\n> */\n>\n> /**\n> diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp\n> index d76db24de0e279e5..a219b061d8814001 100644\n> --- a/src/libcamera/request.cpp\n> +++ b/src/libcamera/request.cpp\n> @@ -43,7 +43,7 @@ Request::Request(Camera *camera)\n> /**\n> * \\brief Set the streams to capture with associated buffers\n> * \\param[in] streamMap The map of streams to buffers\n> - * \\return 0 on success or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> * \\retval -EBUSY Buffers have already been set\n> */\n> int Request::setBuffers(const std::map &streamMap)\n> diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp\n> index 24e115554a997325..8024e041f9b8124a 100644\n> --- a/src/libcamera/v4l2_device.cpp\n> +++ b/src/libcamera/v4l2_device.cpp\n> @@ -247,7 +247,7 @@ V4L2Device::~V4L2Device()\n>\n> /**\n> * \\brief Open a V4L2 device and query its capabilities\n> - * \\return 0 on success, or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Device::open()\n> {\n> @@ -365,7 +365,7 @@ std::string V4L2Device::logPrefix() const\n> * \\brief Retrieve the image format set on the V4L2 device\n> * \\param[out] format The image format applied on the device\n> *\n> - * \\return 0 for success, a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Device::getFormat(V4L2DeviceFormat *format)\n> {\n> @@ -380,7 +380,7 @@ int V4L2Device::getFormat(V4L2DeviceFormat *format)\n> * Apply the supplied \\a format to the device, and return the actually\n> * applied format parameters, as \\ref V4L2Device::getFormat would do.\n> *\n> - * \\return 0 for success, a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Device::setFormat(V4L2DeviceFormat *format)\n> {\n> @@ -541,7 +541,7 @@ int V4L2Device::requestBuffers(unsigned int count)\n> * \\brief Request buffers to be allocated from the device and stored in the\n> * buffer pool provided.\n> * \\param[out] pool BufferPool to populate with buffers\n> - * \\return 0 on success or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Device::exportBuffers(BufferPool *pool)\n> {\n> @@ -645,7 +645,7 @@ int V4L2Device::createPlane(Buffer *buffer, unsigned int planeIndex,\n> /**\n> * \\brief Import the externally allocated \\a pool of buffers\n> * \\param[in] pool BufferPool of buffers to import\n> - * \\return 0 on success or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Device::importBuffers(BufferPool *pool)\n> {\n> @@ -697,7 +697,7 @@ int V4L2Device::releaseBuffers()\n> * \\todo Support output devices (bytesused, ...)\n> * \\todo Support imported buffers (dmabuf fd)\n> *\n> - * \\return 0 on success or a negative error number otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Device::queueBuffer(Buffer *buffer)\n> {\n> @@ -830,7 +830,7 @@ void V4L2Device::bufferAvailable(EventNotifier *notifier)\n> /**\n> * \\brief Start the video stream\n> *\n> - * \\return 0 on success or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Device::streamOn()\n> {\n> @@ -852,7 +852,7 @@ int V4L2Device::streamOn()\n> *\n> * \\todo Ensure completion notifications are sent for all queued buffers\n> *\n> - * \\return 0 on success or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Device::streamOff()\n> {\n> diff --git a/src/libcamera/v4l2_subdevice.cpp b/src/libcamera/v4l2_subdevice.cpp\n> index b436f73cc75fe307..b31eac2ed9bd2502 100644\n> --- a/src/libcamera/v4l2_subdevice.cpp\n> +++ b/src/libcamera/v4l2_subdevice.cpp\n> @@ -95,7 +95,7 @@ V4L2Subdevice::V4L2Subdevice(const MediaEntity *entity)\n> /**\n> * \\brief Open a V4L2 subdevice\n> *\n> - * \\return 0 on success, a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Subdevice::open()\n> {\n> @@ -152,7 +152,7 @@ void V4L2Subdevice::close()\n> * \\param[in] pad The 0-indexed pad number the rectangle is to be applied to\n> * \\param[inout] rect The rectangle describing crop target area\n> *\n> - * \\return 0 on success, or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect)\n> {\n> @@ -164,7 +164,7 @@ int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect)\n> * \\param[in] pad The 0-indexed pad number the rectangle is to be applied to\n> * \\param[inout] rect The rectangle describing the compose target area\n> *\n> - * \\return 0 on success, or a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Subdevice::setCompose(unsigned int pad, Rectangle *rect)\n> {\n> @@ -176,7 +176,7 @@ int V4L2Subdevice::setCompose(unsigned int pad, Rectangle *rect)\n> * \\param[in] pad The 0-indexed pad number the format is to be retrieved from\n> * \\param[out] format The image bus format\n> *\n> - * \\return 0 for success, a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> {\n> @@ -209,7 +209,7 @@ int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> * actually applied format parameters, as \\ref V4L2Subdevice::getFormat would\n> * do.\n> *\n> - * \\return 0 for success, a negative error code otherwise\n> + * \\return 0 on success or a negative error code\n> */\n> int V4L2Subdevice::setFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> {\n> --\n> 2.20.1\n>\n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"","Received":["from relay10.mail.gandi.net (relay10.mail.gandi.net\n\t[217.70.178.230])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 2C59C610B2\n\tfor ;\n\tTue, 26 Feb 2019 17:47:55 +0100 (CET)","from uno.localdomain (2-224-242-101.ip172.fastwebnet.it\n\t[2.224.242.101]) (Authenticated sender: jacopo@jmondi.org)\n\tby relay10.mail.gandi.net (Postfix) with ESMTPSA id 8BB4A24000D;\n\tTue, 26 Feb 2019 16:47:54 +0000 (UTC)"],"Date":"Tue, 26 Feb 2019 17:48:23 +0100","From":"Jacopo Mondi ","To":"Niklas =?utf-8?q?S=C3=B6derlund?= ","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20190226164823.t7vg5okv24f5knnh@uno.localdomain>","References":"<20190226021857.28255-1-niklas.soderlund@ragnatech.se>\n\t<20190226021857.28255-3-niklas.soderlund@ragnatech.se>","MIME-Version":"1.0","Content-Type":"multipart/signed; micalg=pgp-sha256;\n\tprotocol=\"application/pgp-signature\"; boundary=\"6qr4ueyfz5ixvess\"","Content-Disposition":"inline","In-Reply-To":"<20190226021857.28255-3-niklas.soderlund@ragnatech.se>","User-Agent":"NeoMutt/20180716","Subject":"Re: [libcamera-devel] [PATCH 2/8] libcamera: align the\n\tdocumentation for numeric error codes","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Tue, 26 Feb 2019 16:47:55 -0000"}},{"id":918,"web_url":"https://patchwork.libcamera.org/comment/918/","msgid":"<20190227125546.GC4813@pendragon.ideasonboard.com>","date":"2019-02-27T12:55:46","subject":"Re: [libcamera-devel] [PATCH 2/8] libcamera: align the\n\tdocumentation for numeric error codes","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hello,\n\nOn Tue, Feb 26, 2019 at 05:48:23PM +0100, Jacopo Mondi wrote:\n> On Tue, Feb 26, 2019 at 03:18:51AM +0100, Niklas Söderlund wrote:\n> > Rapid growth of the library have resulted in slightly different wording\n> > to document that a function returns 0 on success or a negative error\n> > code. Align all different variations.\n> \n> I would have kept the \"negative error code otherwise\", but it's fine..\n\nI was about to mention the same :-) Apart from that,\n\nAcked-by: Laurent Pinchart \n\n> Reviewed-by: Jacopo Mondi \n> \n> > Signed-off-by: Niklas Söderlund \n> > ---\n> > src/libcamera/buffer.cpp | 6 +++---\n> > src/libcamera/camera.cpp | 12 ++++++------\n> > src/libcamera/camera_manager.cpp | 2 +-\n> > src/libcamera/device_enumerator.cpp | 7 +++----\n> > src/libcamera/media_device.cpp | 8 ++++----\n> > src/libcamera/media_object.cpp | 5 ++---\n> > src/libcamera/pipeline_handler.cpp | 10 +++++-----\n> > src/libcamera/request.cpp | 2 +-\n> > src/libcamera/v4l2_device.cpp | 16 ++++++++--------\n> > src/libcamera/v4l2_subdevice.cpp | 10 +++++-----\n> > 10 files changed, 38 insertions(+), 40 deletions(-)\n> >\n> > diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp\n> > index 9ec372c2981b5b02..f7c5f0e6a3fe0e55 100644\n> > --- a/src/libcamera/buffer.cpp\n> > +++ b/src/libcamera/buffer.cpp\n> > @@ -71,7 +71,7 @@ Plane::~Plane()\n> > * The \\a fd dmabuf file handle is duplicated and stored. The caller may close\n> > * the original file handle.\n> > *\n> > - * \\return 0 on success or a negative error value otherwise.\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int Plane::setDmabuf(int fd, unsigned int length)\n> > {\n> > @@ -106,7 +106,7 @@ int Plane::setDmabuf(int fd, unsigned int length)\n> > *\n> > * \\sa setDmaBuf()\n> > *\n> > - * \\return 0 on success or a negative error value otherwise.\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int Plane::mmap()\n> > {\n> > @@ -133,7 +133,7 @@ int Plane::mmap()\n> > *\n> > * Unmap the memory mapped by an earlier call to mmap().\n> > *\n> > - * \\return 0 on success or a negative error value otherwise.\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int Plane::munmap()\n> > {\n> > diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp\n> > index 6409d10ff88b2189..e2372fea31e2921a 100644\n> > --- a/src/libcamera/camera.cpp\n> > +++ b/src/libcamera/camera.cpp\n> > @@ -157,7 +157,7 @@ void Camera::disconnect()\n> > *\n> > * \\todo Implement exclusive access across processes.\n> > *\n> > - * \\return 0 on success or a negative error code on error.\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int Camera::acquire()\n> > {\n> > @@ -235,7 +235,7 @@ Camera::streamConfiguration(std::vector &streams)\n> > * Exclusive access to the camera shall be ensured by a call to acquire() prior\n> > * to calling this function, otherwise an -EACCES error will be returned.\n> > *\n> > - * \\return 0 on success or a negative error code on error.\n> > + * \\return 0 on success or a negative error code\n> > * \\retval -ENODEV The camera is not connected to any hardware\n> > * \\retval -EACCES The user has not acquired exclusive access to the camera\n> > * \\retval -EINVAL The configuration is not valid\n> > @@ -278,7 +278,7 @@ int Camera::configureStreams(std::map &config)\n> >\n> > /**\n> > * \\brief Allocate buffers for all configured streams\n> > - * \\return 0 on success or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int Camera::allocateBuffers()\n> > {\n> > @@ -350,7 +350,7 @@ Request *Camera::createRequest()\n> > * Ownership of the request is transferred to the camera. It will be deleted\n> > * automatically after it completes.\n> > *\n> > - * \\return 0 on success or a negative error code on error\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int Camera::queueRequest(Request *request)\n> > {\n> > @@ -376,7 +376,7 @@ int Camera::queueRequest(Request *request)\n> > * can queue requests to the camera to process and return to the application\n> > * until the capture session is terminated with \\a stop().\n> > *\n> > - * \\return 0 on success or a negative error code on error\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int Camera::start()\n> > {\n> > @@ -395,7 +395,7 @@ int Camera::start()\n> > * This method stops capturing and processing requests immediately. All pending\n> > * requests are cancelled and complete synchronously in an error state.\n> > *\n> > - * \\return 0 on success or a negative error code on error\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int Camera::stop()\n> > {\n> > diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp\n> > index f90201ade18b61dd..6878cc7e26b24ca4 100644\n> > --- a/src/libcamera/camera_manager.cpp\n> > +++ b/src/libcamera/camera_manager.cpp\n> > @@ -74,7 +74,7 @@ CameraManager::~CameraManager()\n> > * interact with cameras in the system until either the camera manager\n> > * is stopped or the camera is unplugged from the system.\n> > *\n> > - * \\return 0 on successful start, or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int CameraManager::start()\n> > {\n> > diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp\n> > index 66819f077c16c721..b35ac2bb626ec3c6 100644\n> > --- a/src/libcamera/device_enumerator.cpp\n> > +++ b/src/libcamera/device_enumerator.cpp\n> > @@ -178,7 +178,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> > /**\n> > * \\fn DeviceEnumerator::init()\n> > * \\brief Initialize the enumerator\n> > - * \\return 0 on success, or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > * \\retval -EBUSY the enumerator has already been initialized\n> > * \\retval -ENODEV the enumerator can't enumerate devices\n> > */\n> > @@ -195,7 +195,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> > * with a warning message logged, without returning an error. Only errors that\n> > * prevent enumeration altogether shall be fatal.\n> > *\n> > - * \\return 0 on success, or a negative error code on fatal errors.\n> > + * \\return 0 on success or a negative error code\n> > */\n> >\n> > /**\n> > @@ -206,8 +206,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> > * and look up device nodes associated with all entities. Store the media device\n> > * in the internal list for later matching with pipeline handlers.\n> > *\n> > - * \\return 0 on success, or a negative error code if the media device can't be\n> > - * created or populated\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int DeviceEnumerator::addDevice(const std::string &deviceNode)\n> > {\n> > diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp\n> > index 800ed330fe6d8d6f..4f494e316867a55c 100644\n> > --- a/src/libcamera/media_device.cpp\n> > +++ b/src/libcamera/media_device.cpp\n> > @@ -136,7 +136,7 @@ bool MediaDevice::acquire()\n> > *\n> > * If the device is already open the function returns -EBUSY.\n> > *\n> > - * \\return 0 on success or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int MediaDevice::open()\n> > {\n> > @@ -206,7 +206,7 @@ void MediaDevice::close()\n> > * while pads are accessible from the entity they belong to and links from the\n> > * pads they connect.\n> > *\n> > - * \\return 0 on success, a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int MediaDevice::populate()\n> > {\n> > @@ -405,7 +405,7 @@ MediaLink *MediaDevice::link(const MediaPad *source, const MediaPad *sink)\n> > * Disable all the media device links, clearing the MEDIA_LNK_FL_ENABLED flag\n> > * on links which are not flagged as IMMUTABLE.\n> > *\n> > - * \\return 0 on success, or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int MediaDevice::disableLinks()\n> > {\n> > @@ -705,7 +705,7 @@ void MediaDevice::fixupEntityFlags(struct media_v2_entity *entity)\n> > *\n> > * \\sa MediaLink::setEnabled(bool enable)\n> > *\n> > - * \\return 0 on success, or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int MediaDevice::setupLink(const MediaLink *link, unsigned int flags)\n> > {\n> > diff --git a/src/libcamera/media_object.cpp b/src/libcamera/media_object.cpp\n> > index f6abcd8676a3866d..79126124caf98497 100644\n> > --- a/src/libcamera/media_object.cpp\n> > +++ b/src/libcamera/media_object.cpp\n> > @@ -111,7 +111,7 @@ LOG_DECLARE_CATEGORY(MediaDevice)\n> > * Enabling a link establishes a data connection between two pads, while\n> > * disabling it interrupts that connection.\n> > *\n> > - * \\return 0 on success, or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int MediaLink::setEnabled(bool enable)\n> > {\n> > @@ -337,8 +337,7 @@ const MediaPad *MediaEntity::getPadById(unsigned int id) const\n> > /**\n> > * \\brief Set the path to the device node for the associated interface\n> > * \\param deviceNode The interface device node path associated with this entity\n> > - * \\return 0 on success, or a negative error code if the device node can't be\n> > - * accessed\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int MediaEntity::setDeviceNode(const std::string &deviceNode)\n> > {\n> > diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\n> > index dad0a2964486c5d4..0a858fbe13257c7f 100644\n> > --- a/src/libcamera/pipeline_handler.cpp\n> > +++ b/src/libcamera/pipeline_handler.cpp\n> > @@ -144,7 +144,7 @@ PipelineHandler::~PipelineHandler()\n> > * configuration of a subset of the streams can't be satisfied, the\n> > * whole configuration is considered invalid.\n> > *\n> > - * \\return 0 on success or a negative error code on error.\n> > + * \\return 0 on success or a negative error code\n> > */\n> >\n> > /**\n> > @@ -158,7 +158,7 @@ PipelineHandler::~PipelineHandler()\n> > *\n> > * The intended caller of this method is the Camera class.\n> > *\n> > - * \\return 0 on success or a negative error code on error\n> > + * \\return 0 on success or a negative error code\n> > */\n> >\n> > /**\n> > @@ -172,7 +172,7 @@ PipelineHandler::~PipelineHandler()\n> > *\n> > * The intended caller of this method is the Camera class.\n> > *\n> > - * \\return 0 on success or a negative error code on error\n> > + * \\return 0 on success or a negative error code\n> > */\n> >\n> > /**\n> > @@ -185,7 +185,7 @@ PipelineHandler::~PipelineHandler()\n> > * class which will in turn be called from the application to indicate that it\n> > * has configured the streams and is ready to capture.\n> > *\n> > - * \\return 0 on success or a negative error code on error\n> > + * \\return 0 on success or a negative error code\n> > */\n> >\n> > /**\n> > @@ -211,7 +211,7 @@ PipelineHandler::~PipelineHandler()\n> > * parameters will be applied to the frames captured in the buffers provided in\n> > * the request.\n> > *\n> > - * \\return 0 on success or a negative error code on error\n> > + * \\return 0 on success or a negative error code\n> > */\n> >\n> > /**\n> > diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp\n> > index d76db24de0e279e5..a219b061d8814001 100644\n> > --- a/src/libcamera/request.cpp\n> > +++ b/src/libcamera/request.cpp\n> > @@ -43,7 +43,7 @@ Request::Request(Camera *camera)\n> > /**\n> > * \\brief Set the streams to capture with associated buffers\n> > * \\param[in] streamMap The map of streams to buffers\n> > - * \\return 0 on success or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > * \\retval -EBUSY Buffers have already been set\n> > */\n> > int Request::setBuffers(const std::map &streamMap)\n> > diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp\n> > index 24e115554a997325..8024e041f9b8124a 100644\n> > --- a/src/libcamera/v4l2_device.cpp\n> > +++ b/src/libcamera/v4l2_device.cpp\n> > @@ -247,7 +247,7 @@ V4L2Device::~V4L2Device()\n> >\n> > /**\n> > * \\brief Open a V4L2 device and query its capabilities\n> > - * \\return 0 on success, or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Device::open()\n> > {\n> > @@ -365,7 +365,7 @@ std::string V4L2Device::logPrefix() const\n> > * \\brief Retrieve the image format set on the V4L2 device\n> > * \\param[out] format The image format applied on the device\n> > *\n> > - * \\return 0 for success, a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Device::getFormat(V4L2DeviceFormat *format)\n> > {\n> > @@ -380,7 +380,7 @@ int V4L2Device::getFormat(V4L2DeviceFormat *format)\n> > * Apply the supplied \\a format to the device, and return the actually\n> > * applied format parameters, as \\ref V4L2Device::getFormat would do.\n> > *\n> > - * \\return 0 for success, a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Device::setFormat(V4L2DeviceFormat *format)\n> > {\n> > @@ -541,7 +541,7 @@ int V4L2Device::requestBuffers(unsigned int count)\n> > * \\brief Request buffers to be allocated from the device and stored in the\n> > * buffer pool provided.\n> > * \\param[out] pool BufferPool to populate with buffers\n> > - * \\return 0 on success or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Device::exportBuffers(BufferPool *pool)\n> > {\n> > @@ -645,7 +645,7 @@ int V4L2Device::createPlane(Buffer *buffer, unsigned int planeIndex,\n> > /**\n> > * \\brief Import the externally allocated \\a pool of buffers\n> > * \\param[in] pool BufferPool of buffers to import\n> > - * \\return 0 on success or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Device::importBuffers(BufferPool *pool)\n> > {\n> > @@ -697,7 +697,7 @@ int V4L2Device::releaseBuffers()\n> > * \\todo Support output devices (bytesused, ...)\n> > * \\todo Support imported buffers (dmabuf fd)\n> > *\n> > - * \\return 0 on success or a negative error number otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Device::queueBuffer(Buffer *buffer)\n> > {\n> > @@ -830,7 +830,7 @@ void V4L2Device::bufferAvailable(EventNotifier *notifier)\n> > /**\n> > * \\brief Start the video stream\n> > *\n> > - * \\return 0 on success or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Device::streamOn()\n> > {\n> > @@ -852,7 +852,7 @@ int V4L2Device::streamOn()\n> > *\n> > * \\todo Ensure completion notifications are sent for all queued buffers\n> > *\n> > - * \\return 0 on success or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Device::streamOff()\n> > {\n> > diff --git a/src/libcamera/v4l2_subdevice.cpp b/src/libcamera/v4l2_subdevice.cpp\n> > index b436f73cc75fe307..b31eac2ed9bd2502 100644\n> > --- a/src/libcamera/v4l2_subdevice.cpp\n> > +++ b/src/libcamera/v4l2_subdevice.cpp\n> > @@ -95,7 +95,7 @@ V4L2Subdevice::V4L2Subdevice(const MediaEntity *entity)\n> > /**\n> > * \\brief Open a V4L2 subdevice\n> > *\n> > - * \\return 0 on success, a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Subdevice::open()\n> > {\n> > @@ -152,7 +152,7 @@ void V4L2Subdevice::close()\n> > * \\param[in] pad The 0-indexed pad number the rectangle is to be applied to\n> > * \\param[inout] rect The rectangle describing crop target area\n> > *\n> > - * \\return 0 on success, or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect)\n> > {\n> > @@ -164,7 +164,7 @@ int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect)\n> > * \\param[in] pad The 0-indexed pad number the rectangle is to be applied to\n> > * \\param[inout] rect The rectangle describing the compose target area\n> > *\n> > - * \\return 0 on success, or a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Subdevice::setCompose(unsigned int pad, Rectangle *rect)\n> > {\n> > @@ -176,7 +176,7 @@ int V4L2Subdevice::setCompose(unsigned int pad, Rectangle *rect)\n> > * \\param[in] pad The 0-indexed pad number the format is to be retrieved from\n> > * \\param[out] format The image bus format\n> > *\n> > - * \\return 0 for success, a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> > {\n> > @@ -209,7 +209,7 @@ int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> > * actually applied format parameters, as \\ref V4L2Subdevice::getFormat would\n> > * do.\n> > *\n> > - * \\return 0 for success, a negative error code otherwise\n> > + * \\return 0 on success or a negative error code\n> > */\n> > int V4L2Subdevice::setFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> > {","headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4DF65600FD\n\tfor ;\n\tWed, 27 Feb 2019 13:55:52 +0100 (CET)","from pendragon.ideasonboard.com (unknown [185.25.200.246])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 964AB49;\n\tWed, 27 Feb 2019 13:55:51 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1551272151;\n\tbh=wyA5KbRn5bJHmXxqoWaSZhNltUF7r0xVdjnb4xZJTWU=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=iPRrYfuVdgoVbQ1iNWRuOONZ1Vb4QE3//7jcWdh7gojSFpVqulXub5eoM/1ge0qT7\n\tiFoZHZcKafqInahWEWxIvXYy+i5LCluHg50txTO1NMbuxpb9cgLrNnNwpmWlDpSa+z\n\tWjvtpoQGzm20ass6fEmxB0FvqycPYtqPanXHVPxA=","Date":"Wed, 27 Feb 2019 14:55:46 +0200","From":"Laurent Pinchart ","To":"Jacopo Mondi ","Cc":"Niklas =?utf-8?q?S=C3=B6derlund?= ,\n\tlibcamera-devel@lists.libcamera.org","Message-ID":"<20190227125546.GC4813@pendragon.ideasonboard.com>","References":"<20190226021857.28255-1-niklas.soderlund@ragnatech.se>\n\t<20190226021857.28255-3-niklas.soderlund@ragnatech.se>\n\t<20190226164823.t7vg5okv24f5knnh@uno.localdomain>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20190226164823.t7vg5okv24f5knnh@uno.localdomain>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH 2/8] libcamera: align the\n\tdocumentation for numeric error codes","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Wed, 27 Feb 2019 12:55:52 -0000"}},{"id":922,"web_url":"https://patchwork.libcamera.org/comment/922/","msgid":"<20190227163623.GT899@bigcity.dyn.berto.se>","date":"2019-02-27T16:36:23","subject":"Re: [libcamera-devel] [PATCH 2/8] libcamera: align the\n\tdocumentation for numeric error codes","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/people/5/","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"content":"Hi Jacopo and Laurent,\n\nThanks for your feedback.\n\nOn 2019-02-27 14:55:46 +0200, Laurent Pinchart wrote:\n> Hello,\n> \n> On Tue, Feb 26, 2019 at 05:48:23PM +0100, Jacopo Mondi wrote:\n> > On Tue, Feb 26, 2019 at 03:18:51AM +0100, Niklas Söderlund wrote:\n> > > Rapid growth of the library have resulted in slightly different wording\n> > > to document that a function returns 0 on success or a negative error\n> > > code. Align all different variations.\n> > \n> > I would have kept the \"negative error code otherwise\", but it's fine..\n> \n> I was about to mention the same :-) Apart from that,\n\nBy popular demand I have changed it to\n\n \\return 0 on success or a negative error code otherwise\n\nAnd collected your tags, thanks!\n\n> \n> Acked-by: Laurent Pinchart \n> \n> > Reviewed-by: Jacopo Mondi \n> > \n> > > Signed-off-by: Niklas Söderlund \n> > > ---\n> > > src/libcamera/buffer.cpp | 6 +++---\n> > > src/libcamera/camera.cpp | 12 ++++++------\n> > > src/libcamera/camera_manager.cpp | 2 +-\n> > > src/libcamera/device_enumerator.cpp | 7 +++----\n> > > src/libcamera/media_device.cpp | 8 ++++----\n> > > src/libcamera/media_object.cpp | 5 ++---\n> > > src/libcamera/pipeline_handler.cpp | 10 +++++-----\n> > > src/libcamera/request.cpp | 2 +-\n> > > src/libcamera/v4l2_device.cpp | 16 ++++++++--------\n> > > src/libcamera/v4l2_subdevice.cpp | 10 +++++-----\n> > > 10 files changed, 38 insertions(+), 40 deletions(-)\n> > >\n> > > diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp\n> > > index 9ec372c2981b5b02..f7c5f0e6a3fe0e55 100644\n> > > --- a/src/libcamera/buffer.cpp\n> > > +++ b/src/libcamera/buffer.cpp\n> > > @@ -71,7 +71,7 @@ Plane::~Plane()\n> > > * The \\a fd dmabuf file handle is duplicated and stored. The caller may close\n> > > * the original file handle.\n> > > *\n> > > - * \\return 0 on success or a negative error value otherwise.\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int Plane::setDmabuf(int fd, unsigned int length)\n> > > {\n> > > @@ -106,7 +106,7 @@ int Plane::setDmabuf(int fd, unsigned int length)\n> > > *\n> > > * \\sa setDmaBuf()\n> > > *\n> > > - * \\return 0 on success or a negative error value otherwise.\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int Plane::mmap()\n> > > {\n> > > @@ -133,7 +133,7 @@ int Plane::mmap()\n> > > *\n> > > * Unmap the memory mapped by an earlier call to mmap().\n> > > *\n> > > - * \\return 0 on success or a negative error value otherwise.\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int Plane::munmap()\n> > > {\n> > > diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp\n> > > index 6409d10ff88b2189..e2372fea31e2921a 100644\n> > > --- a/src/libcamera/camera.cpp\n> > > +++ b/src/libcamera/camera.cpp\n> > > @@ -157,7 +157,7 @@ void Camera::disconnect()\n> > > *\n> > > * \\todo Implement exclusive access across processes.\n> > > *\n> > > - * \\return 0 on success or a negative error code on error.\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int Camera::acquire()\n> > > {\n> > > @@ -235,7 +235,7 @@ Camera::streamConfiguration(std::vector &streams)\n> > > * Exclusive access to the camera shall be ensured by a call to acquire() prior\n> > > * to calling this function, otherwise an -EACCES error will be returned.\n> > > *\n> > > - * \\return 0 on success or a negative error code on error.\n> > > + * \\return 0 on success or a negative error code\n> > > * \\retval -ENODEV The camera is not connected to any hardware\n> > > * \\retval -EACCES The user has not acquired exclusive access to the camera\n> > > * \\retval -EINVAL The configuration is not valid\n> > > @@ -278,7 +278,7 @@ int Camera::configureStreams(std::map &config)\n> > >\n> > > /**\n> > > * \\brief Allocate buffers for all configured streams\n> > > - * \\return 0 on success or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int Camera::allocateBuffers()\n> > > {\n> > > @@ -350,7 +350,7 @@ Request *Camera::createRequest()\n> > > * Ownership of the request is transferred to the camera. It will be deleted\n> > > * automatically after it completes.\n> > > *\n> > > - * \\return 0 on success or a negative error code on error\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int Camera::queueRequest(Request *request)\n> > > {\n> > > @@ -376,7 +376,7 @@ int Camera::queueRequest(Request *request)\n> > > * can queue requests to the camera to process and return to the application\n> > > * until the capture session is terminated with \\a stop().\n> > > *\n> > > - * \\return 0 on success or a negative error code on error\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int Camera::start()\n> > > {\n> > > @@ -395,7 +395,7 @@ int Camera::start()\n> > > * This method stops capturing and processing requests immediately. All pending\n> > > * requests are cancelled and complete synchronously in an error state.\n> > > *\n> > > - * \\return 0 on success or a negative error code on error\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int Camera::stop()\n> > > {\n> > > diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp\n> > > index f90201ade18b61dd..6878cc7e26b24ca4 100644\n> > > --- a/src/libcamera/camera_manager.cpp\n> > > +++ b/src/libcamera/camera_manager.cpp\n> > > @@ -74,7 +74,7 @@ CameraManager::~CameraManager()\n> > > * interact with cameras in the system until either the camera manager\n> > > * is stopped or the camera is unplugged from the system.\n> > > *\n> > > - * \\return 0 on successful start, or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int CameraManager::start()\n> > > {\n> > > diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp\n> > > index 66819f077c16c721..b35ac2bb626ec3c6 100644\n> > > --- a/src/libcamera/device_enumerator.cpp\n> > > +++ b/src/libcamera/device_enumerator.cpp\n> > > @@ -178,7 +178,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> > > /**\n> > > * \\fn DeviceEnumerator::init()\n> > > * \\brief Initialize the enumerator\n> > > - * \\return 0 on success, or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > * \\retval -EBUSY the enumerator has already been initialized\n> > > * \\retval -ENODEV the enumerator can't enumerate devices\n> > > */\n> > > @@ -195,7 +195,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> > > * with a warning message logged, without returning an error. Only errors that\n> > > * prevent enumeration altogether shall be fatal.\n> > > *\n> > > - * \\return 0 on success, or a negative error code on fatal errors.\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > >\n> > > /**\n> > > @@ -206,8 +206,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> > > * and look up device nodes associated with all entities. Store the media device\n> > > * in the internal list for later matching with pipeline handlers.\n> > > *\n> > > - * \\return 0 on success, or a negative error code if the media device can't be\n> > > - * created or populated\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int DeviceEnumerator::addDevice(const std::string &deviceNode)\n> > > {\n> > > diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp\n> > > index 800ed330fe6d8d6f..4f494e316867a55c 100644\n> > > --- a/src/libcamera/media_device.cpp\n> > > +++ b/src/libcamera/media_device.cpp\n> > > @@ -136,7 +136,7 @@ bool MediaDevice::acquire()\n> > > *\n> > > * If the device is already open the function returns -EBUSY.\n> > > *\n> > > - * \\return 0 on success or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int MediaDevice::open()\n> > > {\n> > > @@ -206,7 +206,7 @@ void MediaDevice::close()\n> > > * while pads are accessible from the entity they belong to and links from the\n> > > * pads they connect.\n> > > *\n> > > - * \\return 0 on success, a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int MediaDevice::populate()\n> > > {\n> > > @@ -405,7 +405,7 @@ MediaLink *MediaDevice::link(const MediaPad *source, const MediaPad *sink)\n> > > * Disable all the media device links, clearing the MEDIA_LNK_FL_ENABLED flag\n> > > * on links which are not flagged as IMMUTABLE.\n> > > *\n> > > - * \\return 0 on success, or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int MediaDevice::disableLinks()\n> > > {\n> > > @@ -705,7 +705,7 @@ void MediaDevice::fixupEntityFlags(struct media_v2_entity *entity)\n> > > *\n> > > * \\sa MediaLink::setEnabled(bool enable)\n> > > *\n> > > - * \\return 0 on success, or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int MediaDevice::setupLink(const MediaLink *link, unsigned int flags)\n> > > {\n> > > diff --git a/src/libcamera/media_object.cpp b/src/libcamera/media_object.cpp\n> > > index f6abcd8676a3866d..79126124caf98497 100644\n> > > --- a/src/libcamera/media_object.cpp\n> > > +++ b/src/libcamera/media_object.cpp\n> > > @@ -111,7 +111,7 @@ LOG_DECLARE_CATEGORY(MediaDevice)\n> > > * Enabling a link establishes a data connection between two pads, while\n> > > * disabling it interrupts that connection.\n> > > *\n> > > - * \\return 0 on success, or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int MediaLink::setEnabled(bool enable)\n> > > {\n> > > @@ -337,8 +337,7 @@ const MediaPad *MediaEntity::getPadById(unsigned int id) const\n> > > /**\n> > > * \\brief Set the path to the device node for the associated interface\n> > > * \\param deviceNode The interface device node path associated with this entity\n> > > - * \\return 0 on success, or a negative error code if the device node can't be\n> > > - * accessed\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int MediaEntity::setDeviceNode(const std::string &deviceNode)\n> > > {\n> > > diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\n> > > index dad0a2964486c5d4..0a858fbe13257c7f 100644\n> > > --- a/src/libcamera/pipeline_handler.cpp\n> > > +++ b/src/libcamera/pipeline_handler.cpp\n> > > @@ -144,7 +144,7 @@ PipelineHandler::~PipelineHandler()\n> > > * configuration of a subset of the streams can't be satisfied, the\n> > > * whole configuration is considered invalid.\n> > > *\n> > > - * \\return 0 on success or a negative error code on error.\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > >\n> > > /**\n> > > @@ -158,7 +158,7 @@ PipelineHandler::~PipelineHandler()\n> > > *\n> > > * The intended caller of this method is the Camera class.\n> > > *\n> > > - * \\return 0 on success or a negative error code on error\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > >\n> > > /**\n> > > @@ -172,7 +172,7 @@ PipelineHandler::~PipelineHandler()\n> > > *\n> > > * The intended caller of this method is the Camera class.\n> > > *\n> > > - * \\return 0 on success or a negative error code on error\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > >\n> > > /**\n> > > @@ -185,7 +185,7 @@ PipelineHandler::~PipelineHandler()\n> > > * class which will in turn be called from the application to indicate that it\n> > > * has configured the streams and is ready to capture.\n> > > *\n> > > - * \\return 0 on success or a negative error code on error\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > >\n> > > /**\n> > > @@ -211,7 +211,7 @@ PipelineHandler::~PipelineHandler()\n> > > * parameters will be applied to the frames captured in the buffers provided in\n> > > * the request.\n> > > *\n> > > - * \\return 0 on success or a negative error code on error\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > >\n> > > /**\n> > > diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp\n> > > index d76db24de0e279e5..a219b061d8814001 100644\n> > > --- a/src/libcamera/request.cpp\n> > > +++ b/src/libcamera/request.cpp\n> > > @@ -43,7 +43,7 @@ Request::Request(Camera *camera)\n> > > /**\n> > > * \\brief Set the streams to capture with associated buffers\n> > > * \\param[in] streamMap The map of streams to buffers\n> > > - * \\return 0 on success or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > * \\retval -EBUSY Buffers have already been set\n> > > */\n> > > int Request::setBuffers(const std::map &streamMap)\n> > > diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp\n> > > index 24e115554a997325..8024e041f9b8124a 100644\n> > > --- a/src/libcamera/v4l2_device.cpp\n> > > +++ b/src/libcamera/v4l2_device.cpp\n> > > @@ -247,7 +247,7 @@ V4L2Device::~V4L2Device()\n> > >\n> > > /**\n> > > * \\brief Open a V4L2 device and query its capabilities\n> > > - * \\return 0 on success, or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Device::open()\n> > > {\n> > > @@ -365,7 +365,7 @@ std::string V4L2Device::logPrefix() const\n> > > * \\brief Retrieve the image format set on the V4L2 device\n> > > * \\param[out] format The image format applied on the device\n> > > *\n> > > - * \\return 0 for success, a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Device::getFormat(V4L2DeviceFormat *format)\n> > > {\n> > > @@ -380,7 +380,7 @@ int V4L2Device::getFormat(V4L2DeviceFormat *format)\n> > > * Apply the supplied \\a format to the device, and return the actually\n> > > * applied format parameters, as \\ref V4L2Device::getFormat would do.\n> > > *\n> > > - * \\return 0 for success, a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Device::setFormat(V4L2DeviceFormat *format)\n> > > {\n> > > @@ -541,7 +541,7 @@ int V4L2Device::requestBuffers(unsigned int count)\n> > > * \\brief Request buffers to be allocated from the device and stored in the\n> > > * buffer pool provided.\n> > > * \\param[out] pool BufferPool to populate with buffers\n> > > - * \\return 0 on success or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Device::exportBuffers(BufferPool *pool)\n> > > {\n> > > @@ -645,7 +645,7 @@ int V4L2Device::createPlane(Buffer *buffer, unsigned int planeIndex,\n> > > /**\n> > > * \\brief Import the externally allocated \\a pool of buffers\n> > > * \\param[in] pool BufferPool of buffers to import\n> > > - * \\return 0 on success or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Device::importBuffers(BufferPool *pool)\n> > > {\n> > > @@ -697,7 +697,7 @@ int V4L2Device::releaseBuffers()\n> > > * \\todo Support output devices (bytesused, ...)\n> > > * \\todo Support imported buffers (dmabuf fd)\n> > > *\n> > > - * \\return 0 on success or a negative error number otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Device::queueBuffer(Buffer *buffer)\n> > > {\n> > > @@ -830,7 +830,7 @@ void V4L2Device::bufferAvailable(EventNotifier *notifier)\n> > > /**\n> > > * \\brief Start the video stream\n> > > *\n> > > - * \\return 0 on success or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Device::streamOn()\n> > > {\n> > > @@ -852,7 +852,7 @@ int V4L2Device::streamOn()\n> > > *\n> > > * \\todo Ensure completion notifications are sent for all queued buffers\n> > > *\n> > > - * \\return 0 on success or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Device::streamOff()\n> > > {\n> > > diff --git a/src/libcamera/v4l2_subdevice.cpp b/src/libcamera/v4l2_subdevice.cpp\n> > > index b436f73cc75fe307..b31eac2ed9bd2502 100644\n> > > --- a/src/libcamera/v4l2_subdevice.cpp\n> > > +++ b/src/libcamera/v4l2_subdevice.cpp\n> > > @@ -95,7 +95,7 @@ V4L2Subdevice::V4L2Subdevice(const MediaEntity *entity)\n> > > /**\n> > > * \\brief Open a V4L2 subdevice\n> > > *\n> > > - * \\return 0 on success, a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Subdevice::open()\n> > > {\n> > > @@ -152,7 +152,7 @@ void V4L2Subdevice::close()\n> > > * \\param[in] pad The 0-indexed pad number the rectangle is to be applied to\n> > > * \\param[inout] rect The rectangle describing crop target area\n> > > *\n> > > - * \\return 0 on success, or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect)\n> > > {\n> > > @@ -164,7 +164,7 @@ int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect)\n> > > * \\param[in] pad The 0-indexed pad number the rectangle is to be applied to\n> > > * \\param[inout] rect The rectangle describing the compose target area\n> > > *\n> > > - * \\return 0 on success, or a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Subdevice::setCompose(unsigned int pad, Rectangle *rect)\n> > > {\n> > > @@ -176,7 +176,7 @@ int V4L2Subdevice::setCompose(unsigned int pad, Rectangle *rect)\n> > > * \\param[in] pad The 0-indexed pad number the format is to be retrieved from\n> > > * \\param[out] format The image bus format\n> > > *\n> > > - * \\return 0 for success, a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> > > {\n> > > @@ -209,7 +209,7 @@ int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> > > * actually applied format parameters, as \\ref V4L2Subdevice::getFormat would\n> > > * do.\n> > > *\n> > > - * \\return 0 for success, a negative error code otherwise\n> > > + * \\return 0 on success or a negative error code\n> > > */\n> > > int V4L2Subdevice::setFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> > > {\n> \n> -- \n> Regards,\n> \n> Laurent Pinchart","headers":{"Return-Path":"","Received":["from mail-lj1-x242.google.com (mail-lj1-x242.google.com\n\t[IPv6:2a00:1450:4864:20::242])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 71DE1610B3\n\tfor ;\n\tWed, 27 Feb 2019 17:36:25 +0100 (CET)","by mail-lj1-x242.google.com with SMTP id j19so14548170ljg.5\n\tfor ;\n\tWed, 27 Feb 2019 08:36:25 -0800 (PST)","from localhost (89-233-230-99.cust.bredband2.com. [89.233.230.99])\n\tby smtp.gmail.com with ESMTPSA id\n\tu15sm2708267lja.73.2019.02.27.08.36.23\n\t(version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256);\n\tWed, 27 Feb 2019 08:36:23 -0800 (PST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=ragnatech-se.20150623.gappssmtp.com; s=20150623;\n\th=date:from:to:cc:subject:message-id:references:mime-version\n\t:content-disposition:content-transfer-encoding:in-reply-to\n\t:user-agent; bh=/WPdfDg62tEHR2IBlfgebvbyDFSmAqlN+c2N6dW58k8=;\n\tb=kaNu7r0KaGceAGMoRCmZKHvgdHe4mIaawjizWdYjOQfOW+49I830x3wMTZvy/zRKTY\n\tu2Nw4gxonDy/Wh+2eu+iQoGAw1TIp3L3DpW2FnGt6mkEWBRQKRMoMDXz74+SnaisSmcW\n\tnEeBfm4aqNNpnMuxxCcIx1HSTog7vzIj8LS03y2xmHxSkTikivDYyqHF0YTpp+oN3IkW\n\tTZoQTGbGSRkh1xTXFJlN769lnfmNKn3R1F6ShlgLAlfeUJ1kplrIwD34gPeEiekmSeNI\n\tZ+plG92C6navw8/CE0Veb92UJ0hBD/v6tVTew2QWSWRnWc8FSP953w6L6I2O0HAFTvVl\n\tML4w==","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:date:from:to:cc:subject:message-id:references\n\t:mime-version:content-disposition:content-transfer-encoding\n\t:in-reply-to:user-agent;\n\tbh=/WPdfDg62tEHR2IBlfgebvbyDFSmAqlN+c2N6dW58k8=;\n\tb=arhG7HEJbPibgVkA7Qcv0fcPZI1Bf1Mc/9s5VT19EoRMKssyDGdk/YGQinU0I4xIjG\n\tJ8KJZ1nxgy9AploR8qqQRq9AKcpY/VEFVCqeu06xaOfBoCfET5cR0ImS1QMOHjVTj65J\n\tUQChEqWzlLqWVee9Dlvr3k0kXrK1JxoPybkGjqlcZMaTGjx2wLJp3WufASjUR1/XPFce\n\tHH2aspBZn8ZQ3M2F2YwAEnzEeBtgRzghgIPeBVLHloordwOPYtuOq2lHvz353IGald8D\n\tw1kCGD+a7YhTXQa9fX4LV9C1ARz9FfJWkQDsRaSi2NkAA80ytTW05NeeOZUqPwSaG5F/\n\tLXlQ==","X-Gm-Message-State":"AHQUAubJ3UQq6yf5rHgA39R6hdo1buCr2pTLMaw57gpYYJ5YvMjuCvgp\n\tvVqYofSKth+LlIN6qKfHYFatYff/i8E=","X-Google-Smtp-Source":"AHgI3IZ1xS83e5OX+DwFhAmd3lc9qpWYJPIYN3JLSU5SQ2lV34u7zByPTagPWsoa0S2LD08Nnlvsdg==","X-Received":"by 2002:a2e:4942:: with SMTP id\n\tb2-v6mr1827250ljd.168.1551285384618; \n\tWed, 27 Feb 2019 08:36:24 -0800 (PST)","Date":"Wed, 27 Feb 2019 17:36:23 +0100","From":"Niklas =?iso-8859-1?q?S=F6derlund?= ","To":"Laurent Pinchart ","Cc":"Jacopo Mondi , libcamera-devel@lists.libcamera.org","Message-ID":"<20190227163623.GT899@bigcity.dyn.berto.se>","References":"<20190226021857.28255-1-niklas.soderlund@ragnatech.se>\n\t<20190226021857.28255-3-niklas.soderlund@ragnatech.se>\n\t<20190226164823.t7vg5okv24f5knnh@uno.localdomain>\n\t<20190227125546.GC4813@pendragon.ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=iso-8859-1","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20190227125546.GC4813@pendragon.ideasonboard.com>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH 2/8] libcamera: align the\n\tdocumentation for numeric error codes","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Wed, 27 Feb 2019 16:36:25 -0000"}},{"id":936,"web_url":"https://patchwork.libcamera.org/comment/936/","msgid":"<20190227185721.GV899@bigcity.dyn.berto.se>","date":"2019-02-27T18:57:21","subject":"Re: [libcamera-devel] [PATCH 2/8] libcamera: align the\n\tdocumentation for numeric error codes","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/people/5/","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"content":"On 2019-02-27 17:36:23 +0100, Niklas Söderlund wrote:\n> Hi Jacopo and Laurent,\n> \n> Thanks for your feedback.\n> \n> On 2019-02-27 14:55:46 +0200, Laurent Pinchart wrote:\n> > Hello,\n> > \n> > On Tue, Feb 26, 2019 at 05:48:23PM +0100, Jacopo Mondi wrote:\n> > > On Tue, Feb 26, 2019 at 03:18:51AM +0100, Niklas Söderlund wrote:\n> > > > Rapid growth of the library have resulted in slightly different wording\n> > > > to document that a function returns 0 on success or a negative error\n> > > > code. Align all different variations.\n> > > \n> > > I would have kept the \"negative error code otherwise\", but it's fine..\n> > \n> > I was about to mention the same :-) Apart from that,\n> \n> By popular demand I have changed it to\n> \n> \\return 0 on success or a negative error code otherwise\n> \n> And collected your tags, thanks!\n\nAnd this single patch is pushed to master.\n\n> \n> > \n> > Acked-by: Laurent Pinchart \n> > \n> > > Reviewed-by: Jacopo Mondi \n> > > \n> > > > Signed-off-by: Niklas Söderlund \n> > > > ---\n> > > > src/libcamera/buffer.cpp | 6 +++---\n> > > > src/libcamera/camera.cpp | 12 ++++++------\n> > > > src/libcamera/camera_manager.cpp | 2 +-\n> > > > src/libcamera/device_enumerator.cpp | 7 +++----\n> > > > src/libcamera/media_device.cpp | 8 ++++----\n> > > > src/libcamera/media_object.cpp | 5 ++---\n> > > > src/libcamera/pipeline_handler.cpp | 10 +++++-----\n> > > > src/libcamera/request.cpp | 2 +-\n> > > > src/libcamera/v4l2_device.cpp | 16 ++++++++--------\n> > > > src/libcamera/v4l2_subdevice.cpp | 10 +++++-----\n> > > > 10 files changed, 38 insertions(+), 40 deletions(-)\n> > > >\n> > > > diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp\n> > > > index 9ec372c2981b5b02..f7c5f0e6a3fe0e55 100644\n> > > > --- a/src/libcamera/buffer.cpp\n> > > > +++ b/src/libcamera/buffer.cpp\n> > > > @@ -71,7 +71,7 @@ Plane::~Plane()\n> > > > * The \\a fd dmabuf file handle is duplicated and stored. The caller may close\n> > > > * the original file handle.\n> > > > *\n> > > > - * \\return 0 on success or a negative error value otherwise.\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int Plane::setDmabuf(int fd, unsigned int length)\n> > > > {\n> > > > @@ -106,7 +106,7 @@ int Plane::setDmabuf(int fd, unsigned int length)\n> > > > *\n> > > > * \\sa setDmaBuf()\n> > > > *\n> > > > - * \\return 0 on success or a negative error value otherwise.\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int Plane::mmap()\n> > > > {\n> > > > @@ -133,7 +133,7 @@ int Plane::mmap()\n> > > > *\n> > > > * Unmap the memory mapped by an earlier call to mmap().\n> > > > *\n> > > > - * \\return 0 on success or a negative error value otherwise.\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int Plane::munmap()\n> > > > {\n> > > > diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp\n> > > > index 6409d10ff88b2189..e2372fea31e2921a 100644\n> > > > --- a/src/libcamera/camera.cpp\n> > > > +++ b/src/libcamera/camera.cpp\n> > > > @@ -157,7 +157,7 @@ void Camera::disconnect()\n> > > > *\n> > > > * \\todo Implement exclusive access across processes.\n> > > > *\n> > > > - * \\return 0 on success or a negative error code on error.\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int Camera::acquire()\n> > > > {\n> > > > @@ -235,7 +235,7 @@ Camera::streamConfiguration(std::vector &streams)\n> > > > * Exclusive access to the camera shall be ensured by a call to acquire() prior\n> > > > * to calling this function, otherwise an -EACCES error will be returned.\n> > > > *\n> > > > - * \\return 0 on success or a negative error code on error.\n> > > > + * \\return 0 on success or a negative error code\n> > > > * \\retval -ENODEV The camera is not connected to any hardware\n> > > > * \\retval -EACCES The user has not acquired exclusive access to the camera\n> > > > * \\retval -EINVAL The configuration is not valid\n> > > > @@ -278,7 +278,7 @@ int Camera::configureStreams(std::map &config)\n> > > >\n> > > > /**\n> > > > * \\brief Allocate buffers for all configured streams\n> > > > - * \\return 0 on success or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int Camera::allocateBuffers()\n> > > > {\n> > > > @@ -350,7 +350,7 @@ Request *Camera::createRequest()\n> > > > * Ownership of the request is transferred to the camera. It will be deleted\n> > > > * automatically after it completes.\n> > > > *\n> > > > - * \\return 0 on success or a negative error code on error\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int Camera::queueRequest(Request *request)\n> > > > {\n> > > > @@ -376,7 +376,7 @@ int Camera::queueRequest(Request *request)\n> > > > * can queue requests to the camera to process and return to the application\n> > > > * until the capture session is terminated with \\a stop().\n> > > > *\n> > > > - * \\return 0 on success or a negative error code on error\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int Camera::start()\n> > > > {\n> > > > @@ -395,7 +395,7 @@ int Camera::start()\n> > > > * This method stops capturing and processing requests immediately. All pending\n> > > > * requests are cancelled and complete synchronously in an error state.\n> > > > *\n> > > > - * \\return 0 on success or a negative error code on error\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int Camera::stop()\n> > > > {\n> > > > diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp\n> > > > index f90201ade18b61dd..6878cc7e26b24ca4 100644\n> > > > --- a/src/libcamera/camera_manager.cpp\n> > > > +++ b/src/libcamera/camera_manager.cpp\n> > > > @@ -74,7 +74,7 @@ CameraManager::~CameraManager()\n> > > > * interact with cameras in the system until either the camera manager\n> > > > * is stopped or the camera is unplugged from the system.\n> > > > *\n> > > > - * \\return 0 on successful start, or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int CameraManager::start()\n> > > > {\n> > > > diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp\n> > > > index 66819f077c16c721..b35ac2bb626ec3c6 100644\n> > > > --- a/src/libcamera/device_enumerator.cpp\n> > > > +++ b/src/libcamera/device_enumerator.cpp\n> > > > @@ -178,7 +178,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> > > > /**\n> > > > * \\fn DeviceEnumerator::init()\n> > > > * \\brief Initialize the enumerator\n> > > > - * \\return 0 on success, or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > * \\retval -EBUSY the enumerator has already been initialized\n> > > > * \\retval -ENODEV the enumerator can't enumerate devices\n> > > > */\n> > > > @@ -195,7 +195,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> > > > * with a warning message logged, without returning an error. Only errors that\n> > > > * prevent enumeration altogether shall be fatal.\n> > > > *\n> > > > - * \\return 0 on success, or a negative error code on fatal errors.\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > >\n> > > > /**\n> > > > @@ -206,8 +206,7 @@ DeviceEnumerator::~DeviceEnumerator()\n> > > > * and look up device nodes associated with all entities. Store the media device\n> > > > * in the internal list for later matching with pipeline handlers.\n> > > > *\n> > > > - * \\return 0 on success, or a negative error code if the media device can't be\n> > > > - * created or populated\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int DeviceEnumerator::addDevice(const std::string &deviceNode)\n> > > > {\n> > > > diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp\n> > > > index 800ed330fe6d8d6f..4f494e316867a55c 100644\n> > > > --- a/src/libcamera/media_device.cpp\n> > > > +++ b/src/libcamera/media_device.cpp\n> > > > @@ -136,7 +136,7 @@ bool MediaDevice::acquire()\n> > > > *\n> > > > * If the device is already open the function returns -EBUSY.\n> > > > *\n> > > > - * \\return 0 on success or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int MediaDevice::open()\n> > > > {\n> > > > @@ -206,7 +206,7 @@ void MediaDevice::close()\n> > > > * while pads are accessible from the entity they belong to and links from the\n> > > > * pads they connect.\n> > > > *\n> > > > - * \\return 0 on success, a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int MediaDevice::populate()\n> > > > {\n> > > > @@ -405,7 +405,7 @@ MediaLink *MediaDevice::link(const MediaPad *source, const MediaPad *sink)\n> > > > * Disable all the media device links, clearing the MEDIA_LNK_FL_ENABLED flag\n> > > > * on links which are not flagged as IMMUTABLE.\n> > > > *\n> > > > - * \\return 0 on success, or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int MediaDevice::disableLinks()\n> > > > {\n> > > > @@ -705,7 +705,7 @@ void MediaDevice::fixupEntityFlags(struct media_v2_entity *entity)\n> > > > *\n> > > > * \\sa MediaLink::setEnabled(bool enable)\n> > > > *\n> > > > - * \\return 0 on success, or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int MediaDevice::setupLink(const MediaLink *link, unsigned int flags)\n> > > > {\n> > > > diff --git a/src/libcamera/media_object.cpp b/src/libcamera/media_object.cpp\n> > > > index f6abcd8676a3866d..79126124caf98497 100644\n> > > > --- a/src/libcamera/media_object.cpp\n> > > > +++ b/src/libcamera/media_object.cpp\n> > > > @@ -111,7 +111,7 @@ LOG_DECLARE_CATEGORY(MediaDevice)\n> > > > * Enabling a link establishes a data connection between two pads, while\n> > > > * disabling it interrupts that connection.\n> > > > *\n> > > > - * \\return 0 on success, or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int MediaLink::setEnabled(bool enable)\n> > > > {\n> > > > @@ -337,8 +337,7 @@ const MediaPad *MediaEntity::getPadById(unsigned int id) const\n> > > > /**\n> > > > * \\brief Set the path to the device node for the associated interface\n> > > > * \\param deviceNode The interface device node path associated with this entity\n> > > > - * \\return 0 on success, or a negative error code if the device node can't be\n> > > > - * accessed\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int MediaEntity::setDeviceNode(const std::string &deviceNode)\n> > > > {\n> > > > diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\n> > > > index dad0a2964486c5d4..0a858fbe13257c7f 100644\n> > > > --- a/src/libcamera/pipeline_handler.cpp\n> > > > +++ b/src/libcamera/pipeline_handler.cpp\n> > > > @@ -144,7 +144,7 @@ PipelineHandler::~PipelineHandler()\n> > > > * configuration of a subset of the streams can't be satisfied, the\n> > > > * whole configuration is considered invalid.\n> > > > *\n> > > > - * \\return 0 on success or a negative error code on error.\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > >\n> > > > /**\n> > > > @@ -158,7 +158,7 @@ PipelineHandler::~PipelineHandler()\n> > > > *\n> > > > * The intended caller of this method is the Camera class.\n> > > > *\n> > > > - * \\return 0 on success or a negative error code on error\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > >\n> > > > /**\n> > > > @@ -172,7 +172,7 @@ PipelineHandler::~PipelineHandler()\n> > > > *\n> > > > * The intended caller of this method is the Camera class.\n> > > > *\n> > > > - * \\return 0 on success or a negative error code on error\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > >\n> > > > /**\n> > > > @@ -185,7 +185,7 @@ PipelineHandler::~PipelineHandler()\n> > > > * class which will in turn be called from the application to indicate that it\n> > > > * has configured the streams and is ready to capture.\n> > > > *\n> > > > - * \\return 0 on success or a negative error code on error\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > >\n> > > > /**\n> > > > @@ -211,7 +211,7 @@ PipelineHandler::~PipelineHandler()\n> > > > * parameters will be applied to the frames captured in the buffers provided in\n> > > > * the request.\n> > > > *\n> > > > - * \\return 0 on success or a negative error code on error\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > >\n> > > > /**\n> > > > diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp\n> > > > index d76db24de0e279e5..a219b061d8814001 100644\n> > > > --- a/src/libcamera/request.cpp\n> > > > +++ b/src/libcamera/request.cpp\n> > > > @@ -43,7 +43,7 @@ Request::Request(Camera *camera)\n> > > > /**\n> > > > * \\brief Set the streams to capture with associated buffers\n> > > > * \\param[in] streamMap The map of streams to buffers\n> > > > - * \\return 0 on success or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > * \\retval -EBUSY Buffers have already been set\n> > > > */\n> > > > int Request::setBuffers(const std::map &streamMap)\n> > > > diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp\n> > > > index 24e115554a997325..8024e041f9b8124a 100644\n> > > > --- a/src/libcamera/v4l2_device.cpp\n> > > > +++ b/src/libcamera/v4l2_device.cpp\n> > > > @@ -247,7 +247,7 @@ V4L2Device::~V4L2Device()\n> > > >\n> > > > /**\n> > > > * \\brief Open a V4L2 device and query its capabilities\n> > > > - * \\return 0 on success, or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Device::open()\n> > > > {\n> > > > @@ -365,7 +365,7 @@ std::string V4L2Device::logPrefix() const\n> > > > * \\brief Retrieve the image format set on the V4L2 device\n> > > > * \\param[out] format The image format applied on the device\n> > > > *\n> > > > - * \\return 0 for success, a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Device::getFormat(V4L2DeviceFormat *format)\n> > > > {\n> > > > @@ -380,7 +380,7 @@ int V4L2Device::getFormat(V4L2DeviceFormat *format)\n> > > > * Apply the supplied \\a format to the device, and return the actually\n> > > > * applied format parameters, as \\ref V4L2Device::getFormat would do.\n> > > > *\n> > > > - * \\return 0 for success, a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Device::setFormat(V4L2DeviceFormat *format)\n> > > > {\n> > > > @@ -541,7 +541,7 @@ int V4L2Device::requestBuffers(unsigned int count)\n> > > > * \\brief Request buffers to be allocated from the device and stored in the\n> > > > * buffer pool provided.\n> > > > * \\param[out] pool BufferPool to populate with buffers\n> > > > - * \\return 0 on success or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Device::exportBuffers(BufferPool *pool)\n> > > > {\n> > > > @@ -645,7 +645,7 @@ int V4L2Device::createPlane(Buffer *buffer, unsigned int planeIndex,\n> > > > /**\n> > > > * \\brief Import the externally allocated \\a pool of buffers\n> > > > * \\param[in] pool BufferPool of buffers to import\n> > > > - * \\return 0 on success or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Device::importBuffers(BufferPool *pool)\n> > > > {\n> > > > @@ -697,7 +697,7 @@ int V4L2Device::releaseBuffers()\n> > > > * \\todo Support output devices (bytesused, ...)\n> > > > * \\todo Support imported buffers (dmabuf fd)\n> > > > *\n> > > > - * \\return 0 on success or a negative error number otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Device::queueBuffer(Buffer *buffer)\n> > > > {\n> > > > @@ -830,7 +830,7 @@ void V4L2Device::bufferAvailable(EventNotifier *notifier)\n> > > > /**\n> > > > * \\brief Start the video stream\n> > > > *\n> > > > - * \\return 0 on success or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Device::streamOn()\n> > > > {\n> > > > @@ -852,7 +852,7 @@ int V4L2Device::streamOn()\n> > > > *\n> > > > * \\todo Ensure completion notifications are sent for all queued buffers\n> > > > *\n> > > > - * \\return 0 on success or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Device::streamOff()\n> > > > {\n> > > > diff --git a/src/libcamera/v4l2_subdevice.cpp b/src/libcamera/v4l2_subdevice.cpp\n> > > > index b436f73cc75fe307..b31eac2ed9bd2502 100644\n> > > > --- a/src/libcamera/v4l2_subdevice.cpp\n> > > > +++ b/src/libcamera/v4l2_subdevice.cpp\n> > > > @@ -95,7 +95,7 @@ V4L2Subdevice::V4L2Subdevice(const MediaEntity *entity)\n> > > > /**\n> > > > * \\brief Open a V4L2 subdevice\n> > > > *\n> > > > - * \\return 0 on success, a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Subdevice::open()\n> > > > {\n> > > > @@ -152,7 +152,7 @@ void V4L2Subdevice::close()\n> > > > * \\param[in] pad The 0-indexed pad number the rectangle is to be applied to\n> > > > * \\param[inout] rect The rectangle describing crop target area\n> > > > *\n> > > > - * \\return 0 on success, or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect)\n> > > > {\n> > > > @@ -164,7 +164,7 @@ int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect)\n> > > > * \\param[in] pad The 0-indexed pad number the rectangle is to be applied to\n> > > > * \\param[inout] rect The rectangle describing the compose target area\n> > > > *\n> > > > - * \\return 0 on success, or a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Subdevice::setCompose(unsigned int pad, Rectangle *rect)\n> > > > {\n> > > > @@ -176,7 +176,7 @@ int V4L2Subdevice::setCompose(unsigned int pad, Rectangle *rect)\n> > > > * \\param[in] pad The 0-indexed pad number the format is to be retrieved from\n> > > > * \\param[out] format The image bus format\n> > > > *\n> > > > - * \\return 0 for success, a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> > > > {\n> > > > @@ -209,7 +209,7 @@ int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> > > > * actually applied format parameters, as \\ref V4L2Subdevice::getFormat would\n> > > > * do.\n> > > > *\n> > > > - * \\return 0 for success, a negative error code otherwise\n> > > > + * \\return 0 on success or a negative error code\n> > > > */\n> > > > int V4L2Subdevice::setFormat(unsigned int pad, V4L2SubdeviceFormat *format)\n> > > > {\n> > \n> > -- \n> > Regards,\n> > \n> > Laurent Pinchart\n> \n> -- \n> Regards,\n> Niklas Söderlund","headers":{"Return-Path":"","Received":["from mail-lf1-x144.google.com (mail-lf1-x144.google.com\n\t[IPv6:2a00:1450:4864:20::144])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 7E998600FD\n\tfor ;\n\tWed, 27 Feb 2019 19:57:23 +0100 (CET)","by mail-lf1-x144.google.com with SMTP id z196so12549849lff.4\n\tfor ;\n\tWed, 27 Feb 2019 10:57:23 -0800 (PST)","from localhost (89-233-230-99.cust.bredband2.com. [89.233.230.99])\n\tby smtp.gmail.com with ESMTPSA id\n\tl10sm104382lfk.26.2019.02.27.10.57.21\n\t(version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256);\n\tWed, 27 Feb 2019 10:57:21 -0800 (PST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=ragnatech-se.20150623.gappssmtp.com; s=20150623;\n\th=date:from:to:cc:subject:message-id:references:mime-version\n\t:content-disposition:content-transfer-encoding:in-reply-to\n\t:user-agent; bh=ID4WYZcc4wQRy6sLmrvRarXqLBKeJrdyh+8xkC0qwHY=;\n\tb=qXnZ4WSaBa7S1mBMRo8HQcZEuG9OxvPjEjoRwM/9j/D61JjEJUdrd8hlqRcgwpiv7P\n\tlEx4UjgyyvaZeGjhvbvF0EB58oJiH0nIJN61lPGslirGB6p+U1RUnpoFN4oXuNMAxYrP\n\tVx4nHKNJi40/xRd5uOlpnQ4EfYbw616DRr+kym3DSJsvWSuMwTgoCpKdjqtiZ/Fb5krC\n\tOX7CTKLC15mGUDZvhjGU5T/Ud55vT4wANYaoc9aH37vmVt9to+oAuGTInwLWO2/0/79o\n\tUH6DRCNuzmLePl2+H1w1sVEo00QNIbXwdu2MjyiCiBzPpxKbSralMVVwbAyr4txobKVJ\n\tkU0Q==","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:date:from:to:cc:subject:message-id:references\n\t:mime-version:content-disposition:content-transfer-encoding\n\t:in-reply-to:user-agent;\n\tbh=ID4WYZcc4wQRy6sLmrvRarXqLBKeJrdyh+8xkC0qwHY=;\n\tb=Eri6bFKTEyqf3Mvd+dt6s6fcjOfdDkGB2Tvwjtm2lABw2kgepAtN0Xg9zbmurXLhfY\n\t7t5em8T2qgQfPI5yBNuA1RszQexf0p7dfWr0hC3e/xE6KzYAeLc0xYYwZIkuKhxaKVjN\n\t64G6UAuU5S5kC10o9OsGppOkNaMPZrZofk/GxW3LwQWdUsO+Li6PsFDEIMb9s+1WUoNQ\n\tOr9XWeeow57bJtjMUV3tBavFFF6GtzM5VHGBHo0ksu7qHKGquQwMEnuCf2zOVCA7loVX\n\tQ/2qn9aatZA0sH5RLfrmcWNAGbaQV9SjO9Igl09NZJr/WlfWsLkaWsDm+wSP79wE2Jtr\n\teDQQ==","X-Gm-Message-State":"AHQUAuZO+T35Ayg9spZvs5SR2uYkkDObz7xRXeAY+AU3e49fgB4UgvQx\n\tILvAr7AfSNbFulgI1bNbvn10/A==","X-Google-Smtp-Source":"AHgI3IZOAXASq305+QrbVXuw07lcQgGM2BHjHPS4tO7sZndq1EGGVG9DFnQSgmTAuW0Q8+T4FwTw5Q==","X-Received":"by 2002:ac2:4154:: with SMTP id c20mr1728998lfi.74.1551293842646;\n\tWed, 27 Feb 2019 10:57:22 -0800 (PST)","Date":"Wed, 27 Feb 2019 19:57:21 +0100","From":"Niklas =?iso-8859-1?q?S=F6derlund?= ","To":"Laurent Pinchart ","Cc":"Jacopo Mondi , libcamera-devel@lists.libcamera.org","Message-ID":"<20190227185721.GV899@bigcity.dyn.berto.se>","References":"<20190226021857.28255-1-niklas.soderlund@ragnatech.se>\n\t<20190226021857.28255-3-niklas.soderlund@ragnatech.se>\n\t<20190226164823.t7vg5okv24f5knnh@uno.localdomain>\n\t<20190227125546.GC4813@pendragon.ideasonboard.com>\n\t<20190227163623.GT899@bigcity.dyn.berto.se>","MIME-Version":"1.0","Content-Type":"text/plain; charset=iso-8859-1","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20190227163623.GT899@bigcity.dyn.berto.se>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH 2/8] libcamera: align the\n\tdocumentation for numeric error codes","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Wed, 27 Feb 2019 18:57:23 -0000"}}]