From 4427f0cf6c2c1c3e0b32637e309316cd63e7a716 Mon Sep 17 00:00:00 2001 From: chrislusf Date: Sat, 24 Oct 2015 09:58:32 -0700 Subject: [PATCH] godoc --- agent/agent_server.go | 2 ++ driver/context_driver.go | 2 +- driver/plan/group.go | 2 +- driver/rsync/http_server.go | 3 ++- flow/context.go | 4 ++-- io/channels.go | 3 ++- resource/resource.go | 2 +- resource/service_discovery/client/name_service_agent.go | 2 +- resource/service_discovery/master/master.go | 3 ++- 9 files changed, 14 insertions(+), 9 deletions(-) diff --git a/agent/agent_server.go b/agent/agent_server.go index 788b755..ce1bdfc 100644 --- a/agent/agent_server.go +++ b/agent/agent_server.go @@ -1,3 +1,5 @@ +// Package agent runs on servers with computing resources, and executes +// tasks sent by driver. package agent import ( diff --git a/driver/context_driver.go b/driver/context_driver.go index 301fe4f..0cd31f9 100644 --- a/driver/context_driver.go +++ b/driver/context_driver.go @@ -1,4 +1,4 @@ -// Driver coordinates distributed execution +// Pacakge driver coordinates distributed execution. package driver import ( diff --git a/driver/plan/group.go b/driver/plan/group.go index 57e5564..f20e6ed 100644 --- a/driver/plan/group.go +++ b/driver/plan/group.go @@ -1,4 +1,4 @@ -// Optimize task execution by grouping tasks that are connected. +// Package plan optimizes task execution by grouping tasks that are connected. package plan import ( diff --git a/driver/rsync/http_server.go b/driver/rsync/http_server.go index a396822..d7acd58 100644 --- a/driver/rsync/http_server.go +++ b/driver/rsync/http_server.go @@ -1,4 +1,5 @@ -// Server and client to copy files between driver and agent. +// Package rsync adds file server and copying client to copy files +// between glow driver and agent. package rsync import ( diff --git a/flow/context.go b/flow/context.go index 1966865..fcd1eea 100644 --- a/flow/context.go +++ b/flow/context.go @@ -1,5 +1,5 @@ -// This contains data structure for computation. Mostly Dataset operations -// such as Map/Reduce/Join/Sort etc +// Package flow contains data structure for computation. +// Mostly Dataset operations such as Map/Reduce/Join/Sort etc. package flow import ( diff --git a/io/channels.go b/io/channels.go index 73db074..68feb3d 100644 --- a/io/channels.go +++ b/io/channels.go @@ -1,4 +1,5 @@ -// Generic network channel managed by agent. +// Package io creates network channels. The network channels are managed by +// glow agent. package io import ( diff --git a/resource/resource.go b/resource/resource.go index 7f8a485..cf4a114 100644 --- a/resource/resource.go +++ b/resource/resource.go @@ -1,4 +1,4 @@ -// resource management +// Package resource manages computing resources and their locations. package resource import ( diff --git a/resource/service_discovery/client/name_service_agent.go b/resource/service_discovery/client/name_service_agent.go index 57b130f..189d814 100644 --- a/resource/service_discovery/client/name_service_agent.go +++ b/resource/service_discovery/client/name_service_agent.go @@ -1,4 +1,4 @@ -// client send heartbeats to master +// Package client send heartbeats to master. package client import ( diff --git a/resource/service_discovery/master/master.go b/resource/service_discovery/master/master.go index e725a37..94a036e 100644 --- a/resource/service_discovery/master/master.go +++ b/resource/service_discovery/master/master.go @@ -1,4 +1,5 @@ -// master collects data from agents, and manage named network channels. +// Package master collects data from agents, and manage named network +// channels. package master import (