Skip to content

Commit

Permalink
Add copyright messages to doc.go files
Browse files Browse the repository at this point in the history
  • Loading branch information
benhoyt committed Jul 27, 2022
1 parent 819954e commit 0e0803c
Show file tree
Hide file tree
Showing 80 changed files with 240 additions and 0 deletions.
3 changes: 3 additions & 0 deletions api/agent/hostkeyreporter/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package hostkeyreporter implements the client-side API facade used
// by the hostkeyreporter worker.
package hostkeyreporter
3 changes: 3 additions & 0 deletions api/agent/leadership/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package leadership implements the client to the analog leadership
// service.
package leadership
3 changes: 3 additions & 0 deletions api/agent/machineactions/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package machineactions implements the API side of
// running actions on machines.
package machineactions
3 changes: 3 additions & 0 deletions api/agent/meterstatus/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package meterstatus contains an implementation of the API facade to
// watch the meter status of a unit for changes and return the current meter status.
package meterstatus
3 changes: 3 additions & 0 deletions api/agent/metricsadder/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package metricsadder contains an implementation of the API facade to
// add metrics to the state.
package metricsadder
3 changes: 3 additions & 0 deletions api/client/application/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package application provides access to the application API facade.
// This facade contains API calls that are specific to applications.
// As a rule of thumb, if the argument for an API requires an application name
Expand Down
3 changes: 3 additions & 0 deletions api/client/bundle/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package bundle provides access to the bundle API facade.
// This facade contains API calls that are specific to bundles.
package bundle
3 changes: 3 additions & 0 deletions api/client/charms/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package charms provides a client for accessing the charms API.
package charms
3 changes: 3 additions & 0 deletions api/client/metricsdebug/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package metricsdebug implements the client to access metrics debug
// functions within state.
package metricsdebug
3 changes: 3 additions & 0 deletions api/common/charms/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package charms provides common helpers for charm-related APIs.
package charms
3 changes: 3 additions & 0 deletions api/controller/metricsmanager/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package metricsmanager implements the API facade to access metrics
// functions within state.
package metricsmanager
3 changes: 3 additions & 0 deletions api/controller/pubsub/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package pubsub implements the API for streaming pubsub messages between API
// servers.
package pubsub
3 changes: 3 additions & 0 deletions api/logsender/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package logsender implements the API for storing log
// messages on the API server.
package logsender
3 changes: 3 additions & 0 deletions apiserver/common/storagecommon/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package storagecommon provides common storage-related services
// for API server facades.
package storagecommon
3 changes: 3 additions & 0 deletions apiserver/facades/agent/hostkeyreporter/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package hostkeyreporter implements the API facade used by the
// hostkeyreporter worker.
package hostkeyreporter
3 changes: 3 additions & 0 deletions apiserver/facades/agent/machine/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package machine implements the API interface used by the machiner worker.
package machine
3 changes: 3 additions & 0 deletions apiserver/facades/agent/machineactions/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package machineactions implements the API server side of
// running actions on machines.
package machineactions
3 changes: 3 additions & 0 deletions apiserver/facades/agent/meterstatus/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package meterstatus provides the meter status API facade.
package meterstatus
3 changes: 3 additions & 0 deletions apiserver/facades/agent/metricsender/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package metricsender contains functions for sending
// metrics from a controller to a remote metric collector.
package metricsender
3 changes: 3 additions & 0 deletions apiserver/facades/agent/uniter/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package uniter implements the API interface used by the uniter worker.
package uniter
3 changes: 3 additions & 0 deletions apiserver/facades/client/application/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package application contains API calls for functionality
// related to deploying and managing applications and their
// related charms.
Expand Down
3 changes: 3 additions & 0 deletions apiserver/facades/client/bundle/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package bundle defines an API endpoint for functions dealing with bundles.
package bundle
3 changes: 3 additions & 0 deletions apiserver/facades/client/cloud/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package cloud defines an API endpoint for functions dealing with
// the controller's cloud definition, and cloud credentials.
package cloud
3 changes: 3 additions & 0 deletions apiserver/facades/client/controller/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package controller defines an API endpoint for functions dealing
// with controllers as a whole.
package controller
3 changes: 3 additions & 0 deletions apiserver/facades/client/metricsdebug/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package metricsdebug contains the implementation of an API endpoint
// for metrics debug functionality.
package metricsdebug
3 changes: 3 additions & 0 deletions apiserver/facades/client/modelmanager/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package modelmanager defines an API endpoint for functions dealing with
// models: creating, listing and sharing models. This facade is available at
// the root of the controller API, and as such, there is no implicit Model
Expand Down
3 changes: 3 additions & 0 deletions apiserver/facades/client/modelupgrader/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package modelupgrader defines an API endpoint for functions dealing with
// upgrading models.
package modelupgrader
3 changes: 3 additions & 0 deletions apiserver/facades/client/sshclient/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package sshclient implements the API endpoint required for Juju
// clients that wish to make SSH connections to Juju managed machines.
package sshclient
3 changes: 3 additions & 0 deletions apiserver/facades/client/storage/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package storage provides an API server facade for managing
// storage entities.
package storage
3 changes: 3 additions & 0 deletions apiserver/facades/controller/metricsmanager/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package metricsmanager contains the implementation of an API endpoint
// for calling metrics functions in state.
package metricsmanager
3 changes: 3 additions & 0 deletions apiserver/facades/controller/resumer/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package resumer implements the API interface
// used by the resumer worker.
package resumer
3 changes: 3 additions & 0 deletions apiserver/httpattachment/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package httpattachment provides facilities for attaching a streaming
// blob of data and associated metadata to an HTTP API request,
// and for reading that blob on the server side.
Expand Down
3 changes: 3 additions & 0 deletions cloud/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package cloud provides functionality to parse information
// describing clouds, including regions, supported auth types etc.
package cloud
3 changes: 3 additions & 0 deletions cloudconfig/cloudinit/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package cloudinit implements a way of creating
// a cloud-init configuration file.
// See https://help.ubuntu.com/community/CloudInit.
Expand Down
3 changes: 3 additions & 0 deletions cloudconfig/providerinit/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package providerinit offers userdata in a gzipped format to be used by
// different cloud providers.
package providerinit
3 changes: 3 additions & 0 deletions cloudconfig/providerinit/renderers/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package renderers implements a way to encode the userdata
// depending on the OS and the provider.
// It currently holds an interface and common functions, while
Expand Down
3 changes: 3 additions & 0 deletions cmd/juju/controller/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package controller groups various commands that are based on talking
// directly to the controller, and not environments in the controller.
package controller
3 changes: 3 additions & 0 deletions cmd/juju/romulus/budget/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package budget defines the command used to update budgets.
package budget
3 changes: 3 additions & 0 deletions cmd/juju/romulus/commands/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package commands provides functionality for registering all the romulus commands.
package commands
3 changes: 3 additions & 0 deletions cmd/juju/romulus/listplans/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package listplans implements the command that can be used to list plans
// that are available for a charm.
package listplans
3 changes: 3 additions & 0 deletions cmd/juju/romulus/setplan/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package setplan implements the "juju set-plan" command.
package setplan
3 changes: 3 additions & 0 deletions cmd/juju/romulus/sla/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package sla implements the "juju sla" command.
package sla
3 changes: 3 additions & 0 deletions cmd/juju/storage/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package storage implements the "juju storage" command, which provides a
// storage management interface for manipulating and inspecting storage
// entities (volumes, filesystems, charm storage).
Expand Down
3 changes: 3 additions & 0 deletions cmd/plugins/juju-wait-for/api/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package api exists because we can't generate mocks in the main namespace.
package api
3 changes: 3 additions & 0 deletions controller/modelmanager/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package modelmanager provides the business logic for
// model management operations in the controller.
package modelmanager
3 changes: 3 additions & 0 deletions core/leadership/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package leadership holds code pertaining to application leadership in juju. It's
// expected to grow as we're able to extract (e.g.) the Ticket and Tracker
// interfaces from worker/leadership; and quite possible the implementations
Expand Down
3 changes: 3 additions & 0 deletions core/os/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package os provides access to operating system related configuration.
package os
3 changes: 3 additions & 0 deletions core/paths/transientfile/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package transientfile provides helpers for creating files that do not
// survive machine reboots.
package transientfile
3 changes: 3 additions & 0 deletions core/presence/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package presence works on the premise that an agent it alive
// if it has a current connection to one of the API servers.
//
Expand Down
3 changes: 3 additions & 0 deletions core/resources/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package resources provides core functionality for the "resources"
// feature in Juju.
package resources
3 changes: 3 additions & 0 deletions core/resources/testing/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package testing provides helpers for testing with resources.
package testing
3 changes: 3 additions & 0 deletions environs/imagemetadata/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package imagemetadata supports locating, parsing, and filtering Ubuntu
// image metadata in simplestreams format.
//
Expand Down
3 changes: 3 additions & 0 deletions environs/simplestreams/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package simplestreams supports locating, parsing, and filtering metadata in
// simplestreams format.
//
Expand Down
3 changes: 3 additions & 0 deletions environs/tools/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package tools supports locating, parsing, and filtering Ubuntu tools
// metadata in simplestreams format.
//
Expand Down
3 changes: 3 additions & 0 deletions feature/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package feature defines the names of the current feature flags.
package feature
3 changes: 3 additions & 0 deletions provider/dummy/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package dummy implements an environment provider for testing
// purposes, registered with environs under the name "dummy".
//
Expand Down
3 changes: 3 additions & 0 deletions provider/lxd/lxdnames/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package lxdnames provides names for the LXD provider.
package lxdnames
3 changes: 3 additions & 0 deletions pubsub/agent/doc.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package agent contains messages for all agents rather than controllers.
//
// All these structures are expected to be used with a SimpleHub that doesn't
Expand Down
3 changes: 3 additions & 0 deletions rpc/jsoncodec/doc.go
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
// Copyright 2022 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.

// Package jsoncodec provides a JSON codec for the rpc package.
package jsoncodec
Loading

0 comments on commit 0e0803c

Please sign in to comment.