libcamera: Drop file name from header comment blocks

Source files in libcamera start by a comment block header, which
includes the file name and a one-line description of the file contents.
While the latter is useful to get a quick overview of the file contents
at a glance, the former is mostly a source of inconvenience. The name in
the comments can easily get out of sync with the file name when files
are renamed, and copy & paste during development have often lead to
incorrect names being used to start with.

Readers of the source code are expected to know which file they're
looking it. Drop the file name from the header comment block.

The change was generated with the following script:

----------------------------------------

dirs="include/libcamera src test utils"

declare -rA patterns=(
	['c']=' \* '
	['cpp']=' \* '
	['h']=' \* '
	['py']='# '
	['sh']='# '
)

for ext in ${!patterns[@]} ; do
	files=$(for dir in $dirs ; do find $dir -name "*.${ext}" ; done)
	pattern=${patterns[${ext}]}

	for file in $files ; do
		name=$(basename ${file})
		sed -i "s/^\(${pattern}\)${name} - /\1/" "$file"
	done
done
----------------------------------------

This misses several files that are out of sync with the comment block
header. Those will be addressed separately and manually.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
This commit is contained in:
Laurent Pinchart 2024-05-08 19:28:06 +03:00
parent fdcd5d04ec
commit 626172a16b
522 changed files with 522 additions and 522 deletions

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Ideas on Board Oy
*
* backtrace.h - Call stack backtraces
* Call stack backtraces
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* bound_method.h - Method bind and invocation
* Method bind and invocation
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* class.h - Utilities and helpers for classes
* Utilities and helpers for classes
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* compiler.h - Compiler support
* Compiler support
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* event_dispatcher.h - Event dispatcher
* Event dispatcher
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* event_dispatcher_poll.h - Poll-based event dispatcher
* Poll-based event dispatcher
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* event_notifier.h - File descriptor event notifier
* File descriptor event notifier
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* file.h - File I/O operations
* File I/O operations
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* flags.h - Type-safe enum-based bitfields
* Type-safe enum-based bitfields
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2018, Google Inc.
*
* log.h - Logging infrastructure
* Logging infrastructure
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* message.h - Message queue support
* Message queue support
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* mutex.h - Mutex classes with clang thread safety annotation
* Mutex classes with clang thread safety annotation
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* object.h - Base object
* Base object
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* private.h - Private Header Validation
* Private Header Validation
*
* A selection of internal libcamera headers are installed as part
* of the libcamera package to allow sharing of a select subset of

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* semaphore.h - General-purpose counting semaphore
* General-purpose counting semaphore
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* shared_fd.h - File descriptor wrapper with shared ownership
* File descriptor wrapper with shared ownership
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* signal.h - Signal & slot implementation
* Signal & slot implementation
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* span.h - C++20 std::span<> implementation for C++11
* C++20 std::span<> implementation for C++11
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* thread.h - Thread support
* Thread support
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* timer.h - Generic timer
* Generic timer
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* unique_fd.h - File descriptor wrapper that owns a file descriptor.
* File descriptor wrapper that owns a file descriptor.
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2018, Google Inc.
*
* utils.h - Miscellaneous utility functions
* Miscellaneous utility functions
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2018, Google Inc.
*
* camera.h - Camera object interface
* Camera object interface
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2018, Google Inc.
*
* camera_manager.h - Camera management
* Camera management
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Raspberry Pi Ltd
*
* color_space.h - color space definitions
* color space definitions
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* controls.h - Control handling
* Control handling
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* framebuffer.h - Frame buffer handling
* Frame buffer handling
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* framebuffer_allocator.h - FrameBuffer allocator
* FrameBuffer allocator
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* geometry.h - Geometry-related classes
* Geometry-related classes
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Raspberry Pi Ltd
*
* bayer_format.h - Bayer Pixel Format
* Bayer Pixel Format
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* byte_stream_buffer.h - Byte stream buffer
* Byte stream buffer
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* camera.h - Camera private data
* Camera private data
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* camera_controls.h - Camera controls
* Camera controls
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* camera_lens.h - A camera lens controller
* A camera lens controller
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2023, Ideas on Board Oy.
*
* camera_manager.h - Camera manager private data
* Camera manager private data
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* camera_sensor.h - A camera sensor
* A camera sensor
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* camera_sensor_properties.h - Database of camera sensor properties
* Database of camera sensor properties
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* control_serializer.h - Control (de)serializer
* Control (de)serializer
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* control_validator.h - Control validator
* Control validator
*/
#pragma once

View file

@ -3,7 +3,7 @@
* Copyright (C) 2020, Laurent Pinchart
* Copyright 2022 NXP
*
* converter.h - Generic format converter interface
* Generic format converter interface
*/
#pragma once

View file

@ -3,7 +3,7 @@
* Copyright (C) 2020, Laurent Pinchart
* Copyright 2022 NXP
*
* converter_v4l2_m2m.h - V4l2 M2M Format converter interface
* V4l2 M2M Format converter interface
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Raspberry Pi Ltd
*
* delayed_controls.h - Helper to deal with controls that take effect with a delay
* Helper to deal with controls that take effect with a delay
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2018, Google Inc.
*
* device_enumerator.h - API to enumerate and find media devices
* API to enumerate and find media devices
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* device_enumerator_sysfs.h - sysfs-based device enumerator
* sysfs-based device enumerator
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2018-2019, Google Inc.
*
* device_enumerator_udev.h - udev-based device enumerator
* udev-based device enumerator
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Raspberry Pi Ltd
*
* dma_heaps.h - Helper class for dma-heap allocations.
* Helper class for dma-heap allocations.
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* formats.h - libcamera image formats
* libcamera image formats
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* framebuffer.h - Internal frame buffer handling
* Internal frame buffer handling
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* ipa_data_serializer.h - Image Processing Algorithm data serializer
* Image Processing Algorithm data serializer
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* ipa_manager.h - Image Processing Algorithm module manager
* Image Processing Algorithm module manager
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* ipa_module.h - Image Processing Algorithm module
* Image Processing Algorithm module
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* ipa_proxy.h - Image Processing Algorithm proxy
* Image Processing Algorithm proxy
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* ipc_pipe.h - Image Processing Algorithm IPC module for IPA proxies
* Image Processing Algorithm IPC module for IPA proxies
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* ipc_pipe_unixsocket.h - Image Processing Algorithm IPC module using unix socket
* Image Processing Algorithm IPC module using unix socket
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* ipc_unixsocket.h - IPC mechanism based on Unix sockets
* IPC mechanism based on Unix sockets
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* mapped_framebuffer.h - Frame buffer memory mapping support
* Frame buffer memory mapping support
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2018, Google Inc.
*
* media_device.h - Media device handler
* Media device handler
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2018, Google Inc.
*
* media_object.h - Media Device objects: entities, pads and links.
* Media Device objects: entities, pads and links.
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2018, Google Inc.
*
* pipeline_handler.h - Pipeline handler infrastructure
* Pipeline handler infrastructure
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* process.h - Process object
* Process object
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* pub_key.h - Public key signature verification
* Public key signature verification
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* request.h - Request class private data
* Request class private data
*/
#pragma once

View file

@ -4,7 +4,7 @@
* Copyright (C) 2024 Andrei Konovalov
* Copyright (C) 2024 Dennis Bonke
*
* shared_mem_object.h - Helpers for shared memory allocations
* Helpers for shared memory allocations
*/
#pragma once

View file

@ -5,7 +5,7 @@
* Authors:
* Hans de Goede <hdegoede@redhat.com>
*
* debayer_params.h - DebayerParams header
* DebayerParams header
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2023, Linaro Ltd
*
* software_isp.h - Simple software ISP implementation
* Simple software ISP implementation
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2023, Linaro Ltd
*
* swisp_stats.h - Statistics data format used by the software ISP and software IPA
* Statistics data format used by the software ISP and software IPA
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* source_paths.h - Identify libcamera source and build paths
* Identify libcamera source and build paths
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* sysfs.h - Miscellaneous utility functions to access sysfs
* Miscellaneous utility functions to access sysfs
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* v4l2_device.h - Common base for V4L2 video devices and subdevices
* Common base for V4L2 video devices and subdevices
*/
#pragma once

View file

@ -3,7 +3,7 @@
* Copyright (C) 2019, Google Inc.
* Copyright (C) 2020, Raspberry Pi Ltd
*
* v4l2_pixelformat.h - V4L2 Pixel Format
* V4L2 Pixel Format
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* v4l2_subdevice.h - V4L2 Subdevice
* V4L2 Subdevice
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* v4l2_videodevice.h - V4L2 Video Device
* V4L2 Video Device
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2022, Google Inc.
*
* yaml_parser.h - libcamera YAML parsing helper
* libcamera YAML parsing helper
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* ipa_controls.h - IPA Control handling
* IPA Control handling
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* ipa_interface.h - Image Processing Algorithm interface
* Image Processing Algorithm interface
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* ipa_module_info.h - Image Processing Algorithm module information
* Image Processing Algorithm module information
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* logging.h - Logging infrastructure
* Logging infrastructure
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2023, Ideas On Board Oy
*
* orientation.h - Image orientation
* Image orientation
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* pixel_format.h - libcamera Pixel Format
* libcamera Pixel Format
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* request.h - Capture request handling
* Capture request handling
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* stream.h - Video stream for a Camera
* Video stream for a Camera
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Raspberry Pi Ltd
*
* transform.h - 2D plane transforms
* 2D plane transforms
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* camera3_hal.cpp - Android Camera HALv3 module
* Android Camera HALv3 module
*/
#include <hardware/camera_common.h>

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* camera_buffer.h - Frame buffer handling interface definition
* Frame buffer handling interface definition
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* camera_capabilities.cpp - Camera static properties manager
* Camera static properties manager
*/
#include "camera_capabilities.h"

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* camera_capabilities.h - Camera static properties manager
* Camera static properties manager
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* camera_device.cpp - libcamera Android Camera Device
* libcamera Android Camera Device
*/
#include "camera_device.h"

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* camera_device.h - libcamera Android Camera Device
* libcamera Android Camera Device
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* camera_hal_config.cpp - Camera HAL configuration file manager
* Camera HAL configuration file manager
*/
#include "camera_hal_config.h"

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* camera_hal_config.h - Camera HAL configuration file manager
* Camera HAL configuration file manager
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* camera_hal_manager.cpp - libcamera Android Camera Manager
* libcamera Android Camera Manager
*/
#include "camera_hal_manager.h"

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* camera_hal_manager.h - libcamera Android Camera Manager
* libcamera Android Camera Manager
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* camera_metadata.cpp - libcamera Android Camera Metadata Helper
* libcamera Android Camera Metadata Helper
*/
#include "camera_metadata.h"

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* camera_metadata.h - libcamera Android Camera Metadata Helper
* libcamera Android Camera Metadata Helper
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019, Google Inc.
*
* camera_ops.h - Android Camera HAL Operations
* Android Camera HAL Operations
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019-2021, Google Inc.
*
* camera_request.cpp - libcamera Android Camera Request Descriptor
* libcamera Android Camera Request Descriptor
*/
#include "camera_request.h"

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2019-2021, Google Inc.
*
* camera_request.h - libcamera Android Camera Request Descriptor
* libcamera Android Camera Request Descriptor
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* camera_stream.cpp - Camera HAL stream
* Camera HAL stream
*/
#include "camera_stream.h"

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* camera_stream.h - Camera HAL stream
* Camera HAL stream
*/
#pragma once

View file

@ -2,7 +2,7 @@
/*
* Copyright (C) 2021, Google Inc.
*
* camera3_hal.cpp - cros-specific components of Android Camera HALv3 module
* cros-specific components of Android Camera HALv3 module
*/
#include <cros-camera/cros_camera_hal.h>

Some files were not shown because too many files have changed in this diff Show more