Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation: minor comment consistency in agent.go #56

Merged
merged 1 commit into from
Apr 18, 2014
Merged

documentation: minor comment consistency in agent.go #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions command/agent/agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ func (a *Agent) RPC(method string, args interface{}, reply interface{}) error {
return a.client.RPC(method, args, reply)
}

// Leave prepares the agent for a graceful shutdown
// Leave is used to prepare the agent for a graceful shutdown
func (a *Agent) Leave() error {
if a.server != nil {
return a.server.Leave()
Expand All @@ -222,8 +222,8 @@ func (a *Agent) Leave() error {
}
}

// Shutdown is used to hard stop the agent. Should be preceeded
// by a call to Leave to do it gracefully.
// Shutdown is used to hard stop the agent. Should be
// preceeded by a call to Leave to do it gracefully.
func (a *Agent) Shutdown() error {
a.shutdownLock.Lock()
defer a.shutdownLock.Unlock()
Expand Down Expand Up @@ -256,8 +256,8 @@ func (a *Agent) Shutdown() error {
return err
}

// ShutdownCh returns a channel that can be selected to wait
// for the agent to perform a shutdown.
// ShutdownCh is used to return a channel that can be
// selected to wait for the agent to perform a shutdown.
func (a *Agent) ShutdownCh() <-chan struct{} {
return a.shutdownCh
}
Expand Down Expand Up @@ -300,7 +300,7 @@ func (a *Agent) ForceLeave(node string) (err error) {
return err
}

// Used to retrieve the LAN members
// LANMembers is used to retrieve the LAN members
func (a *Agent) LANMembers() []serf.Member {
if a.server != nil {
return a.server.LANMembers()
Expand All @@ -309,7 +309,7 @@ func (a *Agent) LANMembers() []serf.Member {
}
}

// Used to retrieve the WAN members
// WANMembers is used to retrieve the WAN members
func (a *Agent) WANMembers() []serf.Member {
if a.server != nil {
return a.server.WANMembers()
Expand All @@ -325,12 +325,12 @@ func (a *Agent) StartSync() {
go a.state.antiEntropy(a.shutdownCh)
}

// PauseSync is called to pause anti-entropy while bulk changes are make
// PauseSync is used to pause anti-entropy while bulk changes are make
func (a *Agent) PauseSync() {
a.state.Pause()
}

// ResumeSync is called to to unpause anti-entropy after bulk changes are make
// ResumeSync is used to unpause anti-entropy after bulk changes are make
func (a *Agent) ResumeSync() {
a.state.Resume()
}
Expand Down