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>
23 lines
809 B
C
23 lines
809 B
C
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2021, Google Inc.
|
|
*
|
|
* 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
|
|
* internal functionality with IPA module only.
|
|
*
|
|
* This functionality is not considered part of the public libcamera
|
|
* API, and can therefore potentially face ABI instabilities which
|
|
* should not be exposed to applications. IPA modules however should be
|
|
* versioned and more closely matched to the libcamera installation.
|
|
*
|
|
* Components which include this file can not be included in any file
|
|
* which forms part of the libcamera API.
|
|
*/
|
|
|
|
#ifndef LIBCAMERA_BASE_PRIVATE
|
|
#error "Private headers must not be included in the libcamera API"
|
|
#endif
|