Skip to content
Permalink
Browse files

Centralise the canonical import paths and more package docs

Put the canonical import path into the main directory, to
centralise it, and make sure it's applied across everything.

As a side effect of this work, also added some more package docs.
  • Loading branch information...
markmandel committed Mar 6, 2018
1 parent bce0277 commit deae857787e7efef1eec55a837a49cfa745f8971
Showing with 83 additions and 2 deletions.
  1. +18 −0 doc.go
  2. +16 −0 pkg/apis/doc.go
  3. +16 −0 pkg/client/doc.go
  4. +15 −0 pkg/doc.go
  5. +16 −0 pkg/util/doc.go
  6. +2 −2 pkg/version.go
18 doc.go
@@ -0,0 +1,18 @@
/*
* Copyright 2018 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// Package agones is a library for hosting, running and scaling dedicated game servers on Kubernetes.
package agones // import "agones.dev/agones"
@@ -0,0 +1,16 @@
// Copyright 2018 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package apis contains all the types for the Custom Resource Definitions
package apis
@@ -0,0 +1,16 @@
// Copyright 2018 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package client contains the generated client for the Custom Resource Definitions
package client
@@ -0,0 +1,15 @@
// Copyright 2018 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package pkg
@@ -0,0 +1,16 @@
// Copyright 2018 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package util is for general libraries that aren't specific to Agones
package util
@@ -12,10 +12,10 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package pkg // import "agones.dev/agones/pkg"
package pkg

var (
// Version is the global version for all binaries
// This is set at compile time by the build process
Version string = "dev"
Version = "dev"
)

0 comments on commit deae857

Please sign in to comment.
You can’t perform that action at this time.