[{"id":2640,"web_url":"https://patchwork.libcamera.org/comment/2640/","msgid":"<1abe9903-3a0d-e714-2bee-67b48a24c255@ideasonboard.com>","date":"2019-09-13T08:17:01","subject":"Re: [libcamera-devel] [PATCH] Documentation: Exclude\n\tbound_method.{h, cpp}","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi Laurent\n\nOn 12/09/2019 20:57, Laurent Pinchart wrote:\n> The bound method classes are not part of the public API, even though\n> they need to be exposed to applications due to the Object and Signal\n> template methods that use them. They are excluded from documentation\n> generation through EXCLUDE_SYMBOLS, but the corresponding .h file is\n> still listed in the generated documentation. Fix this by excluding the\n> bound_method.{h,cpp} files themselves.\n\nI agree we probably don't want to document this for library users to\nuse, but do we need to mark this in any special way to denote that this\nfile will be part of the ABI, or perhaps that's implied by the location\nin TOP_SRCDIR/include.\n\nEither way,\n\nAcked-by: Kieran Bingham \n\n\n> Signed-off-by: Laurent Pinchart \n> ---\n> Documentation/Doxyfile.in | 4 +++-\n> 1 file changed, 3 insertions(+), 1 deletion(-)\n> \n> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\n> index a9596c2a32d8..db939abc8319 100644\n> --- a/Documentation/Doxyfile.in\n> +++ b/Documentation/Doxyfile.in\n> @@ -833,7 +833,9 @@ RECURSIVE = YES\n> # Note that relative paths are relative to the directory from which doxygen is\n> # run.\n> \n> -EXCLUDE = @TOP_SRCDIR@/src/libcamera/device_enumerator_sysfs.cpp \\\n> +EXCLUDE = @TOP_SRCDIR@/include/libcamera/bound_method.h \\\n> +\t\t\t @TOP_SRCDIR@/src/libcamera/bound_method.cpp \\\n> +\t\t\t @TOP_SRCDIR@/src/libcamera/device_enumerator_sysfs.cpp \\\n> \t\t\t @TOP_SRCDIR@/src/libcamera/device_enumerator_udev.cpp \\\n> \t\t\t @TOP_SRCDIR@/src/libcamera/include/device_enumerator_sysfs.h \\\n> \t\t\t @TOP_SRCDIR@/src/libcamera/include/device_enumerator_udev.h \\\n>","headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id E788160BB2\n\tfor ;\n\tFri, 13 Sep 2019 10:17:04 +0200 (CEST)","from [192.168.0.20]\n\t(cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 2799333A;\n\tFri, 13 Sep 2019 10:17:04 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1568362624;\n\tbh=ecR7g5lFejoSG1ySFX6UOYY/5imid3NgsC6r9WqZYLM=;\n\th=Reply-To:Subject:To:References:From:Date:In-Reply-To:From;\n\tb=AW1FNcDWFVBKB7g5WyH6UVFnyYpH9rEJdCUxFuL1w9PbwzyAPoA2DcgMn1xIJhf4S\n\tdWOUpBGDB3YArIM+L5Tl7/KxT3ceL4cuUauEGpC0q+uneC/7QbHokMVOpKakMmhmqH\n\tZsWRh8i0qPLqF8yz4xiLQR4QxxhD0gmibKTxge+Q=","Reply-To":"kieran.bingham@ideasonboard.com","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20190912195703.18678-1-laurent.pinchart@ideasonboard.com>","From":"Kieran Bingham ","Openpgp":"preference=signencrypt","Autocrypt":"addr=kieran.bingham@ideasonboard.com; keydata=\n\tmQINBFYE/WYBEACs1PwjMD9rgCu1hlIiUA1AXR4rv2v+BCLUq//vrX5S5bjzxKAryRf0uHat\n\tV/zwz6hiDrZuHUACDB7X8OaQcwhLaVlq6byfoBr25+hbZG7G3+5EUl9cQ7dQEdvNj6V6y/SC\n\trRanWfelwQThCHckbobWiQJfK9n7rYNcPMq9B8e9F020LFH7Kj6YmO95ewJGgLm+idg1Kb3C\n\tpotzWkXc1xmPzcQ1fvQMOfMwdS+4SNw4rY9f07Xb2K99rjMwZVDgESKIzhsDB5GY465sCsiQ\n\tcSAZRxqE49RTBq2+EQsbrQpIc8XiffAB8qexh5/QPzCmR4kJgCGeHIXBtgRj+nIkCJPZvZtf\n\tKr2EAbc6tgg6DkAEHJb+1okosV09+0+TXywYvtEop/WUOWQ+zo+Y/OBd+8Ptgt1pDRyOBzL8\n\tRXa8ZqRf0Mwg75D+dKntZeJHzPRJyrlfQokngAAs4PaFt6UfS+ypMAF37T6CeDArQC41V3ko\n\tlPn1yMsVD0p+6i3DPvA/GPIksDC4owjnzVX9kM8Zc5Cx+XoAN0w5Eqo4t6qEVbuettxx55gq\n\t8K8FieAjgjMSxngo/HST8TpFeqI5nVeq0/lqtBRQKumuIqDg+Bkr4L1V/PSB6XgQcOdhtd36\n\tOe9X9dXB8YSNt7VjOcO7BTmFn/Z8r92mSAfHXpb07YJWJosQOQARAQABtDBLaWVyYW4gQmlu\n\tZ2hhbSA8a2llcmFuLmJpbmdoYW1AaWRlYXNvbmJvYXJkLmNvbT6JAlcEEwEKAEECGwMFCwkI\n\tBwIGFQgJCgsCBBYCAwECHgECF4ACGQEWIQSQLdeYP70o/eNy1HqhHkZyEKRh/QUCXWTtygUJ\n\tCyJXZAAKCRChHkZyEKRh/f8dEACTDsbLN2nioNZMwyLuQRUAFcXNolDX48xcUXsWS2QjxaPm\n\tVsJx8Uy8aYkS85mdPBh0C83OovQR/OVbr8AxhGvYqBs3nQvbWuTl/+4od7DfK2VZOoKBAu5S\n\tQK2FYuUcikDqYcFWJ8DQnubxfE8dvzojHEkXw0sA4igINHDDFX3HJGZtLio+WpEFQtCbfTAG\n\tYZslasz1YZRbwEdSsmO3/kqy5eMnczlm8a21A3fKUo3g8oAZEFM+f4DUNzqIltg31OAB/kZS\n\tenKZQ/SWC8PmLg/ZXBrReYakxXtkP6w3FwMlzOlhGxqhIRNiAJfXJBaRhuUWzPOpEDE9q5YJ\n\tBmqQL2WJm1VSNNVxbXJHpaWMH1sA2R00vmvRrPXGwyIO0IPYeUYQa3gsy6k+En/aMQJd27dp\n\taScf9am9PFICPY5T4ppneeJLif2lyLojo0mcHOV+uyrds9XkLpp14GfTkeKPdPMrLLTsHRfH\n\tfA4I4OBpRrEPiGIZB/0im98MkGY/Mu6qxeZmYLCcgD6qz4idOvfgVOrNh+aA8HzIVR+RMW8H\n\tQGBN9f0E3kfwxuhl3omo6V7lDw8XOdmuWZNC9zPq1UfryVHANYbLGz9KJ4Aw6M+OgBC2JpkD\n\thXMdHUkC+d20dwXrwHTlrJi1YNp6rBc+xald3wsUPOZ5z8moTHUX/uPA/qhGsbkCDQRWBP1m\n\tARAAzijkb+Sau4hAncr1JjOY+KyFEdUNxRy+hqTJdJfaYihxyaj0Ee0P0zEi35CbE6lgU0Uz\n\ttih9fiUbSV3wfsWqg1Ut3/5rTKu7kLFp15kF7eqvV4uezXRD3Qu4yjv/rMmEJbbD4cTvGCYI\n\td6MDC417f7vK3hCbCVIZSp3GXxyC1LU+UQr3fFcOyCwmP9vDUR9JV0BSqHHxRDdpUXE26Dk6\n\tmhf0V1YkspE5St814ETXpEus2urZE5yJIUROlWPIL+hm3NEWfAP06vsQUyLvr/GtbOT79vXl\n\tEn1aulcYyu20dRRxhkQ6iILaURcxIAVJJKPi8dsoMnS8pB0QW12AHWuirPF0g6DiuUfPmrA5\n\tPKe56IGlpkjc8cO51lIxHkWTpCMWigRdPDexKX+Sb+W9QWK/0JjIc4t3KBaiG8O4yRX8ml2R\n\t+rxfAVKM6V769P/hWoRGdgUMgYHFpHGSgEt80OKK5HeUPy2cngDUXzwrqiM5Sz6Od0qw5pCk\n\tNlXqI0W/who0iSVM+8+RmyY0OEkxEcci7rRLsGnM15B5PjLJjh1f2ULYkv8s4SnDwMZ/kE04\n\t/UqCMK/KnX8pwXEMCjz0h6qWNpGwJ0/tYIgQJZh6bqkvBrDogAvuhf60Sogw+mH8b+PBlx1L\n\toeTK396wc+4c3BfiC6pNtUS5GpsPMMjYMk7kVvEAEQEAAYkCJQQYAQoADwIbDAUCWcOUawUJ\n\tB4D+AgAKCRChHkZyEKRh/XJhEACr5iidt/0MZ0rWRMCbZFMWD7D2g6nZeOp+F2zY8CEUW+sd\n\tCDVd9BH9QX9KN5SZo6YtJzMzSzpcx45VwTvtQW0n/6Eujg9EUqblfU9xqvqDmbjEapr5d/OL\n\t21GTALb0owKhA5qDUGEcKGCphpQffKhTNo/BP99jvmJUj7IPSKH97qPypi8/ym8bAxB+uY31\n\tgHTMHf1jMJJ1pRo2tYYPeIIHGDqXBI4sp5GHHF+JcIhgR/e/A6w/dgzHYmQPl2ix5eZYEZbV\n\tTRP+gkX4NV8oHqa/lR+xPOlWElGB57viOSOoWriqxQbFy8XbG1GR8cWlkNtGBGVWaJaSoORP\n\tiowD7irXL91bCyFIqL+7BVk3Jy4uzP744PzE80KwxOp5SQAp9sPzFbgsJrLev90PZySjFHG0\n\twP144DK7nBjOj/J0g9OHVASP1JjK+nw7SDoKnETDIdRC0XmiHXk7TXzPdkvO0UkpHdEPjZUp\n\tWyuc0MqehjR/hTTPt4m/Y14XzEcy6JREIjOrFfUZVho2QpOdv9CNryGdieRTNjUtz463CIaZ\n\tdPBiw9mOMBoNffkn9FIoCjLnAaj9gUAnEHWBZOEviQ5NuyqpeP0YtzI4iaRbSUkYZHej99X3\n\tVmHrdLlMqd/ZgYYbPGSL4AN3FVACb5CxuxEHwo029VcE5U3CSjzqtCoX12tm7A==","Organization":"Ideas on Board","Message-ID":"<1abe9903-3a0d-e714-2bee-67b48a24c255@ideasonboard.com>","Date":"Fri, 13 Sep 2019 09:17:01 +0100","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101\n\tThunderbird/60.8.0","MIME-Version":"1.0","In-Reply-To":"<20190912195703.18678-1-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=utf-8","Content-Language":"en-GB","Content-Transfer-Encoding":"7bit","Subject":"Re: [libcamera-devel] [PATCH] Documentation: Exclude\n\tbound_method.{h, cpp}","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":"Fri, 13 Sep 2019 08:17:05 -0000"}},{"id":2646,"web_url":"https://patchwork.libcamera.org/comment/2646/","msgid":"<20190913091755.GD29992@pendragon.ideasonboard.com>","date":"2019-09-13T09:17:55","subject":"Re: [libcamera-devel] [PATCH] Documentation: Exclude\n\tbound_method.{h, cpp}","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Kieran,\n\nOn Fri, Sep 13, 2019 at 09:17:01AM +0100, Kieran Bingham wrote:\n> On 12/09/2019 20:57, Laurent Pinchart wrote:\n> > The bound method classes are not part of the public API, even though\n> > they need to be exposed to applications due to the Object and Signal\n> > template methods that use them. They are excluded from documentation\n> > generation through EXCLUDE_SYMBOLS, but the corresponding .h file is\n> > still listed in the generated documentation. Fix this by excluding the\n> > bound_method.{h,cpp} files themselves.\n> \n> I agree we probably don't want to document this for library users to\n> use, but do we need to mark this in any special way to denote that this\n> file will be part of the ABI, or perhaps that's implied by the location\n> in TOP_SRCDIR/include.\n\nI think the location guarantees it, yes. My plan is to actually make the\nbound methods part of the public API, as they can be useful, but for\nthat I need to refactor them to fix a few issues. As that's a low\npriority task I decided to drop them from the documentation for now.\n\n> Either way,\n> \n> Acked-by: Kieran Bingham \n> \n> > Signed-off-by: Laurent Pinchart \n> > ---\n> > Documentation/Doxyfile.in | 4 +++-\n> > 1 file changed, 3 insertions(+), 1 deletion(-)\n> > \n> > diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\n> > index a9596c2a32d8..db939abc8319 100644\n> > --- a/Documentation/Doxyfile.in\n> > +++ b/Documentation/Doxyfile.in\n> > @@ -833,7 +833,9 @@ RECURSIVE = YES\n> > # Note that relative paths are relative to the directory from which doxygen is\n> > # run.\n> > \n> > -EXCLUDE = @TOP_SRCDIR@/src/libcamera/device_enumerator_sysfs.cpp \\\n> > +EXCLUDE = @TOP_SRCDIR@/include/libcamera/bound_method.h \\\n> > +\t\t\t @TOP_SRCDIR@/src/libcamera/bound_method.cpp \\\n> > +\t\t\t @TOP_SRCDIR@/src/libcamera/device_enumerator_sysfs.cpp \\\n> > \t\t\t @TOP_SRCDIR@/src/libcamera/device_enumerator_udev.cpp \\\n> > \t\t\t @TOP_SRCDIR@/src/libcamera/include/device_enumerator_sysfs.h \\\n> > \t\t\t @TOP_SRCDIR@/src/libcamera/include/device_enumerator_udev.h \\\n> >","headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 9986260BB0\n\tfor ;\n\tFri, 13 Sep 2019 11:18:03 +0200 (CEST)","from pendragon.ideasonboard.com (bl10-204-24.dsl.telepac.pt\n\t[85.243.204.24])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id E9E0D33A;\n\tFri, 13 Sep 2019 11:18:02 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1568366283;\n\tbh=uPj1nJfhvZ/dbEjFWFJyMDqUIPAt8cU3n1XaKYOkU98=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=opHZ/xAAwGMf4x4OlM42bPXwsrB78e9PhkefjWOquSJqgXO7nMt4sYIxsqWycP54b\n\tbldB2v8Hs7Ko+QPn+eJ9Mol6KYS2FKv2VRqUDNnpx0+4zHXeTpCgCZst6yXZqojWAc\n\txjz8xMh5LPg5VYt4y7QxIkOwtoC1qmzMUrEhxFe8=","Date":"Fri, 13 Sep 2019 12:17:55 +0300","From":"Laurent Pinchart ","To":"Kieran Bingham ","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20190913091755.GD29992@pendragon.ideasonboard.com>","References":"<20190912195703.18678-1-laurent.pinchart@ideasonboard.com>\n\t<1abe9903-3a0d-e714-2bee-67b48a24c255@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<1abe9903-3a0d-e714-2bee-67b48a24c255@ideasonboard.com>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH] Documentation: Exclude\n\tbound_method.{h, cpp}","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":"Fri, 13 Sep 2019 09:18:03 -0000"}}]