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

@ -4,7 +4,7 @@
#
# Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
#
# checkstyle.py - A patch style checker script based on clang-format
# A patch style checker script based on clang-format
#
# TODO:
#

View file

@ -4,7 +4,7 @@
#
# Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
#
# gen-controls.py - Generate control definitions from YAML
# Generate control definitions from YAML
import argparse
from functools import reduce

View file

@ -4,7 +4,7 @@
#
# Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
#
# gen-formats.py - Generate formats definitions from YAML
# Generate formats definitions from YAML
import argparse
import re

View file

@ -4,7 +4,7 @@
#
# Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
#
# gen-ipa-priv-key.sh - Generate an RSA private key to sign IPA modules
# Generate an RSA private key to sign IPA modules
key="$1"

View file

@ -4,7 +4,7 @@
#
# Author: Paul Elder <paul.elder@ideasonboard.com>
#
# extract-docs.py - Extract doxygen documentation from mojom files
# Extract doxygen documentation from mojom files
import argparse
import re

View file

@ -4,7 +4,7 @@
#
# Author: Paul Elder <paul.elder@ideasonboard.com>
#
# generate.py - Run mojo code generator for generating libcamera IPC files
# Run mojo code generator for generating libcamera IPC files
import os
import sys

View file

@ -4,7 +4,7 @@
#
# Author: Paul Elder <paul.elder@ideasonboard.com>
#
# mojom_libcamera_generator.py - Generates libcamera files from a mojom.Module.
# Generates libcamera files from a mojom.Module.
import argparse
import datetime

View file

@ -4,7 +4,7 @@
#
# Author: Paul Elder <paul.elder@ideasonboard.com>
#
# parser.py - Run mojo parser with python3
# Run mojo parser with python3
import os
import sys

View file

@ -4,7 +4,7 @@
#
# Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
#
# ipu3-capture.sh - Capture raw frames from cameras based on the Intel IPU3
# Capture raw frames from cameras based on the Intel IPU3
#
# The scripts makes use of the following tools, which are expected to be
# executable from the system-wide path or from the local directory:

View file

@ -4,7 +4,7 @@
#
# Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
#
# ipu3-process.sh - Process raw frames with the Intel IPU3
# Process raw frames with the Intel IPU3
#
# The scripts makes use of the following tools, which are expected to be
# found in $PATH:

View file

@ -4,7 +4,7 @@
#
# Copyright (C) 2022, Raspberry Pi (Trading) Limited
#
# alsc_only.py - alsc tuning tool
# alsc tuning tool
from ctt import *

View file

@ -1,4 +1,4 @@
# colors.py - Program to convert from RGB to LAB color space
# Program to convert from RGB to LAB color space
def RGB_to_LAB(RGB): # where RGB is a 1x3 array. e.g RGB = [100, 255, 230]
num = 0
XYZ = [0, 0, 0]

View file

@ -4,7 +4,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# ctt.py - camera tuning tool
# camera tuning tool
import os
import sys

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# ctt_alsc.py - camera tuning tool for ALSC (auto lens shading correction)
# camera tuning tool for ALSC (auto lens shading correction)
from ctt_image_load import *
import matplotlib.pyplot as plt

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# ctt_awb.py - camera tuning tool for AWB
# camera tuning tool for AWB
from ctt_image_load import *
import matplotlib.pyplot as plt

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# ctt_ccm.py - camera tuning tool for CCM (colour correction matrix)
# camera tuning tool for CCM (colour correction matrix)
from ctt_image_load import *
from ctt_awb import get_alsc_patches

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# ctt_geq.py - camera tuning tool for GEQ (green equalisation)
# camera tuning tool for GEQ (green equalisation)
from ctt_tools import *
import matplotlib.pyplot as plt

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019-2020, Raspberry Pi Ltd
#
# ctt_image_load.py - camera tuning tool image loading
# camera tuning tool image loading
from ctt_tools import *
from ctt_macbeth_locator import *

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# ctt_lux.py - camera tuning tool for lux level
# camera tuning tool for lux level
from ctt_tools import *

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# ctt_macbeth_locator.py - camera tuning tool Macbeth chart locator
# camera tuning tool Macbeth chart locator
from ctt_ransac import *
from ctt_tools import *

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# ctt_noise.py - camera tuning tool noise calibration
# camera tuning tool noise calibration
from ctt_image_load import *
import matplotlib.pyplot as plt

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# ctt_ransac.py - camera tuning tool RANSAC selector for Macbeth chart locator
# camera tuning tool RANSAC selector for Macbeth chart locator
import numpy as np

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# ctt_tools.py - camera tuning tool miscellaneous
# camera tuning tool miscellaneous
import time
import re

View file

@ -4,7 +4,7 @@
#
# Author: Paul Elder <paul.elder@ideasonboard.com>
#
# analyze-ipa-trace.py - Example of how to extract information from libcamera lttng traces
# Example of how to extract information from libcamera lttng traces
import argparse
import bt2

View file

@ -4,7 +4,7 @@
#
# Author: Paul Elder <paul.elder@ideasonboard.com>
#
# gen-tp-header.py - Generate header file to contain lttng tracepoints
# Generate header file to contain lttng tracepoints
import datetime
import jinja2

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# average.py - Wrapper for numpy averaging functions to enable duck-typing
# Wrapper for numpy averaging functions to enable duck-typing
import numpy as np

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# generator.py - Base class for a generator to convert dict to tuning file
# Base class for a generator to convert dict to tuning file
from pathlib import Path

View file

@ -2,7 +2,7 @@
#
# Copyright 2022 Raspberry Pi Ltd
#
# raspberrypi_output.py - Generate tuning file in Raspberry Pi's json format
# Generate tuning file in Raspberry Pi's json format
#
# (Copied from ctt_pretty_print_json.py)

View file

@ -2,7 +2,7 @@
#
# Copyright 2022 Paul Elder <paul.elder@ideasonboard.com>
#
# yaml_output.py - Generate tuning file in YAML format
# Generate tuning file in YAML format
from .generator import Generator

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# gradient.py - Gradients that can be used to distribute or map numbers
# Gradients that can be used to distribute or map numbers
import libtuning as lt

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# image.py - Container for an image and associated metadata
# Container for an image and associated metadata
import binascii
import numpy as np

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# libtuning.py - An infrastructure for camera tuning tools
# An infrastructure for camera tuning tools
import argparse

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2019, Raspberry Pi Ltd
#
# macbeth.py - Locate and extract Macbeth charts from images
# Locate and extract Macbeth charts from images
# (Copied from: ctt_macbeth_locator.py)
# \todo Add debugging

View file

@ -3,7 +3,7 @@
# Copyright (C) 2019, Raspberry Pi Ltd
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# raspberrypi.py - ALSC module for tuning Raspberry Pi
# ALSC module for tuning Raspberry Pi
from .lsc import LSC

View file

@ -3,7 +3,7 @@
# Copyright (C) 2019, Raspberry Pi Ltd
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# rkisp1.py - LSC module for tuning rkisp1
# LSC module for tuning rkisp1
from .lsc import LSC

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# module.py - Base class for algorithm-specific tuning modules
# Base class for algorithm-specific tuning modules
# @var type Type of the module. Defined in the base module.

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# parser.py - Base class for a parser for a specific format of config file
# Base class for a parser for a specific format of config file
class Parser(object):
def __init__(self):

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# raspberrypi_parser.py - Parser for Raspberry Pi config file format
# Parser for Raspberry Pi config file format
from .parser import Parser

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# yaml_parser.py - Parser for YAML format config file
# Parser for YAML format config file
from .parser import Parser

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# smoothing.py - Wrapper for cv2 smoothing functions to enable duck-typing
# Wrapper for cv2 smoothing functions to enable duck-typing
import cv2

View file

@ -3,7 +3,7 @@
# Copyright (C) 2019, Raspberry Pi Ltd
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# utils.py - Utilities for libtuning
# Utilities for libtuning
import decimal
import math

View file

@ -2,7 +2,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# alsc.py - ALSC module instance for Raspberry Pi tuning scripts
# ALSC module instance for Raspberry Pi tuning scripts
import libtuning as lt
from libtuning.modules.lsc import ALSCRaspberryPi

View file

@ -3,7 +3,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# raspberrypi_alsc_only.py - Tuning script for raspberrypi, ALSC only
# Tuning script for raspberrypi, ALSC only
import sys

View file

@ -3,7 +3,7 @@
#
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
#
# rkisp1.py - Tuning script for rkisp1
# Tuning script for rkisp1
import sys