[libcamera-devel] [PATCH 1/2] Documentation: Strip default options and comments from Doxyfile.in

[Kieran Bingham]

Quoting Laurent Pinchart via libcamera-devel (2022-08-30 13:19:05)
> Doxyfile.in was generated using `doxygen -g` with Doxygen v1.8.14. This
> has produced a file with all options supported by Doxygen at the time,
> and a handful of them have then been modified to support libcamera's
> needs, with most options retaining their default.
> 
> Some of the default options have been deprecated in newer Doxygen
> releases, which led to warnings when generating the documentation. The
> usual process to fix this is to update the configuration file with
> `doxygen -u`. This creates a big diff due to the large number of changes
> to default options, which isn't quite nice. Instead, let's just drop all
> the default options and the comments, to produce a small and more
> readable Doxyfile.in.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> ---
>  Documentation/Doxyfile.in | 2328 -------------------------------------
>  1 file changed, 2328 deletions(-)
> 
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index 4bb83d50c6c9..0011b82f2353 100644
> --- a/Documentation/Doxyfile.in
> +++ b/Documentation/Doxyfile.in
> @@ -1,793 +1,26 @@
>  # SPDX-License-Identifier: CC-BY-SA-4.0
>  # Doxyfile 1.8.14
>  
> -# This file describes the settings to be used by the documentation system
> -# doxygen (www.doxygen.org) for a project.
> -#
> -# All text after a double hash (##) is considered a comment and is placed in
> -# front of the TAG it is preceding.
> -#
> -# All text after a single hash (#) is considered a comment and will be ignored.
> -# The format is:
> -# TAG = value [value, ...]
> -# For lists, items can also be appended using:
> -# TAG += value [value, ...]
> -# Values that contain spaces should be placed between quotes (\" \").
> -

<snip large content, with no inline review>

I was a bit hesitant and losing the documentation for all these options,
but as they are stale and liable to bitrot - I agree it's better to
remove it.

It's easy enough to reference the Doxygen documentation directly.


Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>