Skip to content

Commit

Permalink
Add empty lines between license headers and package declarations
Browse files Browse the repository at this point in the history
Having package declarations immediately follow the license headers causes godoc
tool treat the headers as the package docs if there is no proper doc.
It's a very minor annoyance, but why not fix it.

Ideally this would be checked by a linter, but go-header doesn't have such an
option, see denis-tingaikin/go-header#35

Signed-off-by: Anna Kapuscinska <[email protected]>
  • Loading branch information
lambdanis committed Nov 22, 2023
1 parent 82931c6 commit 3202115
Show file tree
Hide file tree
Showing 50 changed files with 50 additions and 0 deletions.
1 change: 1 addition & 0 deletions cmd/dump-syscalls-info/main.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package main

import (
Expand Down
1 change: 1 addition & 0 deletions cmd/ksyms/ksyms.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package main

import (
Expand Down
1 change: 1 addition & 0 deletions cmd/tetra/main.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package main

import (
Expand Down
1 change: 1 addition & 0 deletions cmd/tetragon/conf.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package main

import (
Expand Down
1 change: 1 addition & 0 deletions cmd/tetragon/conf_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package main

import (
Expand Down
1 change: 1 addition & 0 deletions cmd/tetragon/main.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package main

import (
Expand Down
1 change: 1 addition & 0 deletions cmd/tetragon/sensors.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package main

import (
Expand Down
1 change: 1 addition & 0 deletions cmd/tetragon/tetragon.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package main

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/alignchecker/alignchecker_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package alignchecker

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/api/calltraceapi/calltraceapi.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package calltraceapi

type StackAddr struct {
Expand Down
1 change: 1 addition & 0 deletions pkg/api/confapi/confapi.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package confapi

type TetragonConf struct {
Expand Down
1 change: 1 addition & 0 deletions pkg/api/flags.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package api

// Msg Flag Definitions
Expand Down
1 change: 1 addition & 0 deletions pkg/api/ops/ops.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package ops

const (
Expand Down
1 change: 1 addition & 0 deletions pkg/api/ops/ops_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package ops

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/api/processapi/processapi.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package processapi

const (
Expand Down
1 change: 1 addition & 0 deletions pkg/api/readyapi/readyapi.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package readyapi

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/api/testapi/testapi.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package testapi

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/fileutils/fileutils.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package fileutils

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/grpc/exec/exec.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package exec

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/grpc/test/test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package test

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/grpc/tracing/tracing.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package tracing

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/ksyms/ksyms_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package ksyms

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/ktime/ktime.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package ktime

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/pidfile/pidfile.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package pidfile

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/pidfile/pidfile_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package pidfile

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/podhooks/podhooks.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package podhooks

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/policyfilter/podhelpers_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package policyfilter

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/policyfilter/policyfilter.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package policyfilter

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/process/args.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package process

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/reader/exec/exec.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package exec

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/reader/kernel/kernel.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package kernel

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/reader/ktime/ktime.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package ktime

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/reader/network/inet.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package network

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/reader/network/network.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package network

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/reader/node/node.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package node

import "os"
Expand Down
1 change: 1 addition & 0 deletions pkg/reader/path/path.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package path

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/reader/path/path_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package path

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/reader/proc/proc.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package proc

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/reader/proc/proc_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package proc

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/sensors/collection.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package sensors

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/sensors/exec/cgroups_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package exec

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/sensors/exec/exec.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package exec

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/sensors/exec/exec_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package exec

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/sensors/manager.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package sensors

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/sensors/path.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package sensors

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/sensors/program/program.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package program

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/sensors/test/test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package test

// Test sensor that uses an lseek hook that generates TEST events when BogusFd
Expand Down
1 change: 1 addition & 0 deletions pkg/sensors/unloader/unloader.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package unloader

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/tracingpolicy/generate/generate.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package generate

import (
Expand Down
1 change: 1 addition & 0 deletions pkg/unixlisten/unixlisten.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package unixlisten

import (
Expand Down

0 comments on commit 3202115

Please sign in to comment.