From 5b60e7d728f5692fe7960c87c01791cb9ed86acc Mon Sep 17 00:00:00 2001
From: "Sascha L. Teichmann" <sascha.teichmann@intevation.de>
Date: Tue, 17 Jan 2023 11:02:06 +0100
Subject: [PATCH] Add package comments to make revive happy.

---
 cmd/csaf_aggregator/main.go |  1 +
 cmd/csaf_checker/main.go    |  1 +
 cmd/csaf_downloader/main.go |  1 +
 cmd/csaf_provider/main.go   |  1 +
 csaf/doc.go                 | 10 ++++++++++
 util/doc.go                 | 10 ++++++++++
 6 files changed, 24 insertions(+)
 create mode 100644 csaf/doc.go
 create mode 100644 util/doc.go

diff --git a/cmd/csaf_aggregator/main.go b/cmd/csaf_aggregator/main.go
index 5c9d7e3..1584d83 100644
--- a/cmd/csaf_aggregator/main.go
+++ b/cmd/csaf_aggregator/main.go
@@ -6,6 +6,7 @@
 // SPDX-FileCopyrightText: 2022 German Federal Office for Information Security (BSI) <https://www.bsi.bund.de>
 // Software-Engineering: 2022 Intevation GmbH <https://intevation.de>
 
+// Package main implements the csaf_aggregator tool.
 package main
 
 import (
diff --git a/cmd/csaf_checker/main.go b/cmd/csaf_checker/main.go
index a0c650a..78f58b6 100644
--- a/cmd/csaf_checker/main.go
+++ b/cmd/csaf_checker/main.go
@@ -6,6 +6,7 @@
 // SPDX-FileCopyrightText: 2022 German Federal Office for Information Security (BSI) <https://www.bsi.bund.de>
 // Software-Engineering: 2022 Intevation GmbH <https://intevation.de>
 
+// Package main implements the csaf_checker tool.
 package main
 
 import (
diff --git a/cmd/csaf_downloader/main.go b/cmd/csaf_downloader/main.go
index c778701..58ebe5e 100644
--- a/cmd/csaf_downloader/main.go
+++ b/cmd/csaf_downloader/main.go
@@ -6,6 +6,7 @@
 // SPDX-FileCopyrightText: 2022 German Federal Office for Information Security (BSI) <https://www.bsi.bund.de>
 // Software-Engineering: 2022 Intevation GmbH <https://intevation.de>
 
+// Package main implements the csaf_downloader tool.
 package main
 
 import (
diff --git a/cmd/csaf_provider/main.go b/cmd/csaf_provider/main.go
index da409b2..5947dc0 100644
--- a/cmd/csaf_provider/main.go
+++ b/cmd/csaf_provider/main.go
@@ -6,6 +6,7 @@
 // SPDX-FileCopyrightText: 2021 German Federal Office for Information Security (BSI) <https://www.bsi.bund.de>
 // Software-Engineering: 2021 Intevation GmbH <https://intevation.de>
 
+// Package main implements the csaf_provider.
 package main
 
 import (
diff --git a/csaf/doc.go b/csaf/doc.go
new file mode 100644
index 0000000..391d99b
--- /dev/null
+++ b/csaf/doc.go
@@ -0,0 +1,10 @@
+// This file is Free Software under the MIT License
+// without warranty, see README.md and LICENSES/MIT.txt for details.
+//
+// SPDX-License-Identifier: MIT
+//
+// SPDX-FileCopyrightText: 2022 German Federal Office for Information Security (BSI) <https://www.bsi.bund.de>
+// Software-Engineering: 2022 Intevation GmbH <https://intevation.de>
+
+// Package csaf contains the core data models used by the csaf distribution.
+package csaf
diff --git a/util/doc.go b/util/doc.go
new file mode 100644
index 0000000..df6809e
--- /dev/null
+++ b/util/doc.go
@@ -0,0 +1,10 @@
+// This file is Free Software under the MIT License
+// without warranty, see README.md and LICENSES/MIT.txt for details.
+//
+// SPDX-License-Identifier: MIT
+//
+// SPDX-FileCopyrightText: 2023 German Federal Office for Information Security (BSI) <https://www.bsi.bund.de>
+// Software-Engineering: 2023 Intevation GmbH <https://intevation.de>
+
+// Package util implements several utilities functions and types.
+package util