[{"id":24860,"web_url":"https://patchwork.libcamera.org/comment/24860/","msgid":"<166194078373.15972.5686544040533333518@Monstersaurus>","date":"2022-08-31T10:13:03","subject":"Re: [libcamera-devel] [PATCH 1/2] Documentation: Strip default\n\toptions and comments from Doxyfile.in","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Quoting Laurent Pinchart via libcamera-devel (2022-08-30 13:19:05)\n> Doxyfile.in was generated using `doxygen -g` with Doxygen v1.8.14. This\n> has produced a file with all options supported by Doxygen at the time,\n> and a handful of them have then been modified to support libcamera's\n> needs, with most options retaining their default.\n> \n> Some of the default options have been deprecated in newer Doxygen\n> releases, which led to warnings when generating the documentation. The\n> usual process to fix this is to update the configuration file with\n> `doxygen -u`. This creates a big diff due to the large number of changes\n> to default options, which isn't quite nice. Instead, let's just drop all\n> the default options and the comments, to produce a small and more\n> readable Doxyfile.in.\n> \n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> ---\n>  Documentation/Doxyfile.in | 2328 -------------------------------------\n>  1 file changed, 2328 deletions(-)\n> \n> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\n> index 4bb83d50c6c9..0011b82f2353 100644\n> --- a/Documentation/Doxyfile.in\n> +++ b/Documentation/Doxyfile.in\n> @@ -1,793 +1,26 @@\n>  # SPDX-License-Identifier: CC-BY-SA-4.0\n>  # Doxyfile 1.8.14\n>  \n> -# This file describes the settings to be used by the documentation system\n> -# doxygen (www.doxygen.org) for a project.\n> -#\n> -# All text after a double hash (##) is considered a comment and is placed in\n> -# front of the TAG it is preceding.\n> -#\n> -# All text after a single hash (#) is considered a comment and will be ignored.\n> -# The format is:\n> -# TAG = value [value, ...]\n> -# For lists, items can also be appended using:\n> -# TAG += value [value, ...]\n> -# Values that contain spaces should be placed between quotes (\\\" \\\").\n> -\n\n<snip large content, with no inline review>\n\nI was a bit hesitant and losing the documentation for all these options,\nbut as they are stale and liable to bitrot - I agree it's better to\nremove it.\n\nIt's easy enough to reference the Doxygen documentation directly.\n\n\nReviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>","headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 1424EC0DA4\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 31 Aug 2022 10:13:09 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 827F561FC0;\n\tWed, 31 Aug 2022 12:13:08 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4EC9661F9F\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 31 Aug 2022 12:13:07 +0200 (CEST)","from pendragon.ideasonboard.com\n\t(cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id C896E481;\n\tWed, 31 Aug 2022 12:13:06 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1661940788;\n\tbh=Or8XS3kNeeW+DAJOOlvQ9g4RL1UZ4IxGY4+6tj66oCc=;\n\th=In-Reply-To:References:To:Date:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=oW3ilx3NnJf6Fl6QRarSCT3udTdHEwYqbdKnpnvrtjEUulHOgxO6dENrSNdvprgMr\n\tyBhx+yMK9KQ0ursgK+JsWjVlfCA7Pe/80nt71FWwhlFzXp21X/aPcuqEQfxpTE/SJ+\n\trjwMwCy+4mK4GPmJxr70nWJs+vfRefqMqlhafZsJblbMYO0wEW7kD4EDSF/vtgzekf\n\twnc2tTa0/DBfsxJrlv8h2LlGbhHZmGBXGPx+V7Jn4gyxcim9qx1doq2YVv0PDUjHPR\n\tscna0XOf4JAKKRId9lIEjlNNxPmN+lAatMJ1W0xB/0bSSmR9WNFRs6HW/BARJODfRy\n\tO5coNDS6d9Djw==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1661940786;\n\tbh=Or8XS3kNeeW+DAJOOlvQ9g4RL1UZ4IxGY4+6tj66oCc=;\n\th=In-Reply-To:References:Subject:From:To:Date:From;\n\tb=uQmoJzaWUSMeSlBC/sbk02qEFn4qYtNEhrudbeBgXwcaWSBi7nGzLWeIXiiZrNwyF\n\tSC14hC6hxeuAH/3RXE0cKhOIHHSrab89fFRdReXWwU5FWgCHcA4PULVEM+fKUGO4D7\n\tSA0waIkKrRMgS1P+2fYPNX7UpJjYsrWDdVyP9qo8="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"uQmoJzaW\"; dkim-atps=neutral","Content-Type":"text/plain; charset=\"utf-8\"","MIME-Version":"1.0","Content-Transfer-Encoding":"quoted-printable","In-Reply-To":"<20220830121906.25364-2-laurent.pinchart@ideasonboard.com>","References":"<20220830121906.25364-1-laurent.pinchart@ideasonboard.com>\n\t<20220830121906.25364-2-laurent.pinchart@ideasonboard.com>","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>,\n\tlibcamera-devel@lists.libcamera.org","Date":"Wed, 31 Aug 2022 11:13:03 +0100","Message-ID":"<166194078373.15972.5686544040533333518@Monstersaurus>","User-Agent":"alot/0.10","Subject":"Re: [libcamera-devel] [PATCH 1/2] Documentation: Strip default\n\toptions and comments from Doxyfile.in","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","From":"Kieran Bingham via libcamera-devel\n\t<libcamera-devel@lists.libcamera.org>","Reply-To":"Kieran Bingham <kieran.bingham@ideasonboard.com>","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}}]