626172a16b
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>
21 lines
923 B
Python
21 lines
923 B
Python
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
#
|
|
# Copyright (C) 2022, Paul Elder <paul.elder@ideasonboard.com>
|
|
#
|
|
# Base class for a parser for a specific format of config file
|
|
|
|
class Parser(object):
|
|
def __init__(self):
|
|
pass
|
|
|
|
# @brief Parse a config file into a config dict
|
|
# @details The config dict shall have one key 'general' with a dict value
|
|
# for general configuration options, and all other entries shall
|
|
# have the module as the key with its configuration options (as a
|
|
# dict) as the value. The config dict shall prune entries that are
|
|
# for modules that are not in @a modules.
|
|
# @param config (str) Path to config file
|
|
# @param modules (list) List of modules
|
|
# @return (dict, list) Configuration and list of modules to disable
|
|
def parse(self, config_file: str, modules: list) -> (dict, list):
|
|
raise NotImplementedError
|