diff options
| author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2024-05-08 19:28:06 +0300 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2024-05-09 23:31:14 +0300 |
| commit | 829acb3ab0b178110f449bed238ef117fa96408d (patch) | |
| tree | 06ac1d2028b6da535faa9ee2f6cf998c18e1c226 /utils/gen-header.sh | |
| parent | f1522e94dfaedcde26280eb6387f2c6f2de66fd7 (diff) | |
libcamera: Drop file name from header comment blocks in templates
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 blocks in
template files and templates embedded in generator scripts.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
Diffstat (limited to 'utils/gen-header.sh')
| -rwxr-xr-x | utils/gen-header.sh | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/utils/gen-header.sh b/utils/gen-header.sh index 8b66c5dd..d4692758 100755 --- a/utils/gen-header.sh +++ b/utils/gen-header.sh @@ -9,7 +9,7 @@ cat <<EOF > "$dst_file" /* * Copyright (C) 2018-2019, Google Inc. * - * libcamera.h - libcamera public API + * libcamera public API */ #pragma once |