NekoCWD/libcamera
NekoCWD/libcamera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 7 Wiki Activity Actions

libcamera: Drop file name from header comment blocks

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

2
utils/tuning/libtuning/average.py
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

2
utils/tuning/libtuning/generators/generator.py
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

2
utils/tuning/libtuning/generators/raspberrypi_output.py
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)

2
utils/tuning/libtuning/generators/yaml_output.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

2
utils/tuning/libtuning/gradient.py
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

2
utils/tuning/libtuning/image.py
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

2
utils/tuning/libtuning/libtuning.py
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

2
utils/tuning/libtuning/macbeth.py
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

2
utils/tuning/libtuning/modules/lsc/raspberrypi.py
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

2
utils/tuning/libtuning/modules/lsc/rkisp1.py
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

2
utils/tuning/libtuning/modules/module.py
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.

2
utils/tuning/libtuning/parsers/parser.py
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):

2
utils/tuning/libtuning/parsers/raspberrypi_parser.py
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

2
utils/tuning/libtuning/parsers/yaml_parser.py
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

2
utils/tuning/libtuning/smoothing.py
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

2
utils/tuning/libtuning/utils.py
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

2
utils/tuning/raspberrypi/alsc.py
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

2
utils/tuning/raspberrypi_alsc_only.py
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

2
utils/tuning/rkisp1.py
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