service: fix typos in comments (#3344)
This commit is contained in:
parent
bdec83da45
commit
cc71863594
@ -429,7 +429,7 @@ func ConvertRegisters(in *op.DwarfRegisters, dwarfRegisterToString func(int, *op
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// ConvertImage convers proc.Image to api.Image.
|
// ConvertImage converts proc.Image to api.Image.
|
||||||
func ConvertImage(image *proc.Image) Image {
|
func ConvertImage(image *proc.Image) Image {
|
||||||
return Image{Path: image.Path, Address: image.StaticBase}
|
return Image{Path: image.Path, Address: image.StaticBase}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -448,7 +448,7 @@ const (
|
|||||||
ReverseStep = "reverseStep"
|
ReverseStep = "reverseStep"
|
||||||
// StepOut continues to the return address of the current function
|
// StepOut continues to the return address of the current function
|
||||||
StepOut = "stepOut"
|
StepOut = "stepOut"
|
||||||
// ReverseStepOut continues backward to the calle rof the current function.
|
// ReverseStepOut continues backward to the caller of the current function.
|
||||||
ReverseStepOut = "reverseStepOut"
|
ReverseStepOut = "reverseStepOut"
|
||||||
// StepInstruction continues for exactly 1 cpu instruction.
|
// StepInstruction continues for exactly 1 cpu instruction.
|
||||||
StepInstruction = "stepInstruction"
|
StepInstruction = "stepInstruction"
|
||||||
|
|||||||
@ -47,7 +47,7 @@ type Client interface {
|
|||||||
ReverseStep() (*api.DebuggerState, error)
|
ReverseStep() (*api.DebuggerState, error)
|
||||||
// StepOut continues to the return address of the current function.
|
// StepOut continues to the return address of the current function.
|
||||||
StepOut() (*api.DebuggerState, error)
|
StepOut() (*api.DebuggerState, error)
|
||||||
// ReverseStepOut continues backward to the calle rof the current function.
|
// ReverseStepOut continues backward to the caller of the current function.
|
||||||
ReverseStepOut() (*api.DebuggerState, error)
|
ReverseStepOut() (*api.DebuggerState, error)
|
||||||
// Call resumes process execution while making a function call.
|
// Call resumes process execution while making a function call.
|
||||||
Call(goroutineID int64, expr string, unsafe bool) (*api.DebuggerState, error)
|
Call(goroutineID int64, expr string, unsafe bool) (*api.DebuggerState, error)
|
||||||
|
|||||||
@ -83,7 +83,7 @@ func main() {
|
|||||||
messages := []string{}
|
messages := []string{}
|
||||||
scope := pkgs[0].Types.Scope()
|
scope := pkgs[0].Types.Scope()
|
||||||
for _, name := range scope.Names() {
|
for _, name := range scope.Names() {
|
||||||
// Find only types that are embedding go-dap.Respose message.
|
// Find only types that are embedding go-dap.Response message.
|
||||||
obj := scope.Lookup(name)
|
obj := scope.Lookup(name)
|
||||||
if !obj.Exported() {
|
if !obj.Exported() {
|
||||||
continue // skip unexported
|
continue // skip unexported
|
||||||
|
|||||||
@ -203,7 +203,7 @@ type process struct {
|
|||||||
// impact handling of subsequent requests.
|
// impact handling of subsequent requests.
|
||||||
// The fields with cfgName tag can be updated through an evaluation request.
|
// The fields with cfgName tag can be updated through an evaluation request.
|
||||||
type launchAttachArgs struct {
|
type launchAttachArgs struct {
|
||||||
// stopOnEntry is set to automatically stop the debugee after start.
|
// stopOnEntry is set to automatically stop the debuggee after start.
|
||||||
stopOnEntry bool
|
stopOnEntry bool
|
||||||
// StackTraceDepth is the maximum length of the returned list of stack frames.
|
// StackTraceDepth is the maximum length of the returned list of stack frames.
|
||||||
StackTraceDepth int `cfgName:"stackTraceDepth"`
|
StackTraceDepth int `cfgName:"stackTraceDepth"`
|
||||||
@ -236,7 +236,7 @@ var defaultArgs = launchAttachArgs{
|
|||||||
substitutePathServerToClient: [][2]string{},
|
substitutePathServerToClient: [][2]string{},
|
||||||
}
|
}
|
||||||
|
|
||||||
// dapClientCapabilites captures arguments from intitialize request that
|
// dapClientCapabilites captures arguments from initialize request that
|
||||||
// impact handling of subsequent requests.
|
// impact handling of subsequent requests.
|
||||||
type dapClientCapabilites struct {
|
type dapClientCapabilites struct {
|
||||||
supportsVariableType bool
|
supportsVariableType bool
|
||||||
@ -362,7 +362,7 @@ func (s *Session) setLaunchAttachArgs(args LaunchAttachCommonConfig) error {
|
|||||||
// connection. It shuts down the underlying debugger and kills the target
|
// connection. It shuts down the underlying debugger and kills the target
|
||||||
// process if it was launched by it or stops the noDebug process.
|
// process if it was launched by it or stops the noDebug process.
|
||||||
// This method mustn't be called more than once.
|
// This method mustn't be called more than once.
|
||||||
// StopTriggered notifies other goroutines that stop is in progreess.
|
// StopTriggered notifies other goroutines that stop is in progress.
|
||||||
func (s *Server) Stop() {
|
func (s *Server) Stop() {
|
||||||
s.config.log.Debug("DAP server stopping...")
|
s.config.log.Debug("DAP server stopping...")
|
||||||
defer s.config.log.Debug("DAP server stopped")
|
defer s.config.log.Debug("DAP server stopped")
|
||||||
@ -404,7 +404,7 @@ func (s *Session) Close() {
|
|||||||
// Unless Stop() was called after read loop in ServeDAPCodec()
|
// Unless Stop() was called after read loop in ServeDAPCodec()
|
||||||
// returned, this will result in a closed connection error
|
// returned, this will result in a closed connection error
|
||||||
// on next read, breaking out the read loop and
|
// on next read, breaking out the read loop and
|
||||||
// allowing the run goroutinee to exit.
|
// allowing the run goroutines to exit.
|
||||||
// This connection is closed here and in serveDAPCodec().
|
// This connection is closed here and in serveDAPCodec().
|
||||||
// If this was a forced shutdown, external stop logic can close this first.
|
// If this was a forced shutdown, external stop logic can close this first.
|
||||||
// If this was a client loop exit (on error or disconnect), serveDAPCodec()
|
// If this was a client loop exit (on error or disconnect), serveDAPCodec()
|
||||||
@ -417,13 +417,13 @@ func (s *Session) Close() {
|
|||||||
// signals that client sent a disconnect request or there was connection
|
// signals that client sent a disconnect request or there was connection
|
||||||
// failure or closure. Since the server currently services only one
|
// failure or closure. Since the server currently services only one
|
||||||
// client, this is used as a signal to stop the entire server.
|
// client, this is used as a signal to stop the entire server.
|
||||||
// The function safeguards agaist closing the channel more
|
// The function safeguards against closing the channel more
|
||||||
// than once and can be called multiple times. It is not thread-safe
|
// than once and can be called multiple times. It is not thread-safe
|
||||||
// and is currently only called from the run goroutine.
|
// and is currently only called from the run goroutine.
|
||||||
func (c *Config) triggerServerStop() {
|
func (c *Config) triggerServerStop() {
|
||||||
// Avoid accidentally closing the channel twice and causing a panic, when
|
// Avoid accidentally closing the channel twice and causing a panic, when
|
||||||
// this function is called more than once because stop was triggered
|
// this function is called more than once because stop was triggered
|
||||||
// by multiple conditions simultenously.
|
// by multiple conditions simultaneously.
|
||||||
if c.DisconnectChan != nil {
|
if c.DisconnectChan != nil {
|
||||||
close(c.DisconnectChan)
|
close(c.DisconnectChan)
|
||||||
c.DisconnectChan = nil
|
c.DisconnectChan = nil
|
||||||
@ -1428,7 +1428,7 @@ func (s *Session) onSetFunctionBreakpointsRequest(request *dap.SetFunctionBreakp
|
|||||||
}
|
}
|
||||||
}, func(i int) (*bpLocation, error) {
|
}, func(i int) (*bpLocation, error) {
|
||||||
want := request.Arguments.Breakpoints[i]
|
want := request.Arguments.Breakpoints[i]
|
||||||
// Set the function breakpoint breakpoint
|
// Set the function breakpoint
|
||||||
spec, err := locspec.Parse(want.Name)
|
spec, err := locspec.Parse(want.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@ -1865,7 +1865,7 @@ func (s *Session) stoppedOnBreakpointGoroutineID(state *api.DebuggerState) (int6
|
|||||||
// stepUntilStopAndNotify is a wrapper around runUntilStopAndNotify that
|
// stepUntilStopAndNotify is a wrapper around runUntilStopAndNotify that
|
||||||
// first switches selected goroutine. allowNextStateChange is
|
// first switches selected goroutine. allowNextStateChange is
|
||||||
// a channel that will be closed to signal that an
|
// a channel that will be closed to signal that an
|
||||||
// asynchornous command has completed setup or was interrupted
|
// asynchronous command has completed setup or was interrupted
|
||||||
// due to an error, so the server is ready to receive new requests.
|
// due to an error, so the server is ready to receive new requests.
|
||||||
func (s *Session) stepUntilStopAndNotify(command string, threadId int, granularity dap.SteppingGranularity, allowNextStateChange chan struct{}) {
|
func (s *Session) stepUntilStopAndNotify(command string, threadId int, granularity dap.SteppingGranularity, allowNextStateChange chan struct{}) {
|
||||||
defer closeIfOpen(allowNextStateChange)
|
defer closeIfOpen(allowNextStateChange)
|
||||||
@ -2500,7 +2500,7 @@ func (s *Session) convertVariableWithOpts(v *proc.Variable, qualifiedNameOrExpr
|
|||||||
if v.DwarfType != nil && len(v.Children) > 0 && v.Children[0].Addr != 0 && v.Children[0].Kind != reflect.Invalid {
|
if v.DwarfType != nil && len(v.Children) > 0 && v.Children[0].Addr != 0 && v.Children[0].Kind != reflect.Invalid {
|
||||||
if v.Children[0].OnlyAddr { // Not loaded
|
if v.Children[0].OnlyAddr { // Not loaded
|
||||||
if v.Addr == 0 {
|
if v.Addr == 0 {
|
||||||
// This is equvalent to the following with the cli:
|
// This is equivalent to the following with the cli:
|
||||||
// (dlv) p &a7
|
// (dlv) p &a7
|
||||||
// (**main.FooBar)(0xc0000a3918)
|
// (**main.FooBar)(0xc0000a3918)
|
||||||
//
|
//
|
||||||
@ -2887,7 +2887,7 @@ func (s *Session) onSetVariableRequest(request *dap.SetVariableRequest) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if useFnCall {
|
if useFnCall {
|
||||||
// TODO(hyangah): function call injection currentlly allows to assign return values of
|
// TODO(hyangah): function call injection currently allows to assign return values of
|
||||||
// a function call to variables. So, curious users would find set variable
|
// a function call to variables. So, curious users would find set variable
|
||||||
// on string would accept expression like `fn()`.
|
// on string would accept expression like `fn()`.
|
||||||
if state, retVals, err := s.doCall(goid, frame, fmt.Sprintf("%v=%v", evaluateName, arg.Value)); err != nil {
|
if state, retVals, err := s.doCall(goid, frame, fmt.Sprintf("%v=%v", evaluateName, arg.Value)); err != nil {
|
||||||
@ -2928,7 +2928,7 @@ func (s *Session) onSetVariableRequest(request *dap.SetVariableRequest) {
|
|||||||
// to update the variable/watch sections if necessary.
|
// to update the variable/watch sections if necessary.
|
||||||
//
|
//
|
||||||
// More complicated situation is when the set variable involves call
|
// More complicated situation is when the set variable involves call
|
||||||
// injection - after the injected call is completed, the debugee can
|
// injection - after the injected call is completed, the debuggee can
|
||||||
// be in a completely different state (see the note in doCall) due to
|
// be in a completely different state (see the note in doCall) due to
|
||||||
// how the call injection is implemented. Ideally, we need to also refresh
|
// how the call injection is implemented. Ideally, we need to also refresh
|
||||||
// the stack frames but that is complicated. For now we don't try to actively
|
// the stack frames but that is complicated. For now we don't try to actively
|
||||||
@ -3463,7 +3463,7 @@ func (s *Session) resumeOnce(command string, allowNextStateChange chan struct{})
|
|||||||
// termination, error, breakpoint, etc, when an appropriate
|
// termination, error, breakpoint, etc, when an appropriate
|
||||||
// event needs to be sent to the client. allowNextStateChange is
|
// event needs to be sent to the client. allowNextStateChange is
|
||||||
// a channel that will be closed to signal that an
|
// a channel that will be closed to signal that an
|
||||||
// asynchornous command has completed setup or was interrupted
|
// asynchronous command has completed setup or was interrupted
|
||||||
// due to an error, so the server is ready to receive new requests.
|
// due to an error, so the server is ready to receive new requests.
|
||||||
func (s *Session) runUntilStopAndNotify(command string, allowNextStateChange chan struct{}) {
|
func (s *Session) runUntilStopAndNotify(command string, allowNextStateChange chan struct{}) {
|
||||||
state, err := s.runUntilStop(command, allowNextStateChange)
|
state, err := s.runUntilStop(command, allowNextStateChange)
|
||||||
|
|||||||
@ -2099,7 +2099,7 @@ func TestVariablesLoading(t *testing.T) {
|
|||||||
checkChildren(t, c1sa, "c1.sa", 3)
|
checkChildren(t, c1sa, "c1.sa", 3)
|
||||||
ref = checkVarRegex(t, c1sa, 0, `\[0\]`, `c1\.sa\[0\]`, `\*\(\*main\.astruct\)\(0x[0-9a-f]+\)`, `\*main\.astruct`, hasChildren)
|
ref = checkVarRegex(t, c1sa, 0, `\[0\]`, `c1\.sa\[0\]`, `\*\(\*main\.astruct\)\(0x[0-9a-f]+\)`, `\*main\.astruct`, hasChildren)
|
||||||
if ref > 0 {
|
if ref > 0 {
|
||||||
// Auto-loading of fully missing struc children happens here
|
// Auto-loading of fully missing struct children happens here
|
||||||
client.VariablesRequest(ref)
|
client.VariablesRequest(ref)
|
||||||
c1sa0 := client.ExpectVariablesResponse(t)
|
c1sa0 := client.ExpectVariablesResponse(t)
|
||||||
checkChildren(t, c1sa0, "c1.sa[0]", 1)
|
checkChildren(t, c1sa0, "c1.sa[0]", 1)
|
||||||
@ -4161,7 +4161,7 @@ func TestVariableValueTruncation(t *testing.T) {
|
|||||||
|
|
||||||
// Compound map keys may be truncated even further
|
// Compound map keys may be truncated even further
|
||||||
// As the keys are always inside of a map container,
|
// As the keys are always inside of a map container,
|
||||||
// this applies to variables requests only, not evalute requests.
|
// this applies to variables requests only, not evaluate requests.
|
||||||
|
|
||||||
// key - compound, value - scalar (inlined key:value display) => truncate key if too long
|
// key - compound, value - scalar (inlined key:value display) => truncate key if too long
|
||||||
ref := checkVarExact(t, locals, -1, "m5", "m5", "map[main.C]int [{s: "+longstr+"}: 1, ]", "map[main.C]int", hasChildren)
|
ref := checkVarExact(t, locals, -1, "m5", "m5", "map[main.C]int [{s: "+longstr+"}: 1, ]", "map[main.C]int", hasChildren)
|
||||||
@ -6717,7 +6717,7 @@ func (s *MultiClientCloseServerMock) acceptNewClient(t *testing.T) *daptest.Clie
|
|||||||
func (s *MultiClientCloseServerMock) stop(t *testing.T) {
|
func (s *MultiClientCloseServerMock) stop(t *testing.T) {
|
||||||
close(s.forceStop)
|
close(s.forceStop)
|
||||||
// If the server doesn't have an active session,
|
// If the server doesn't have an active session,
|
||||||
// closing it would leak the debbuger with the target because
|
// closing it would leak the debugger with the target because
|
||||||
// they are part of dap.Session.
|
// they are part of dap.Session.
|
||||||
// We must take it down manually as if we are in rpccommon::ServerImpl::Stop.
|
// We must take it down manually as if we are in rpccommon::ServerImpl::Stop.
|
||||||
if s.debugger.IsRunning() {
|
if s.debugger.IsRunning() {
|
||||||
@ -6733,7 +6733,7 @@ func (s *MultiClientCloseServerMock) verifyStopped(t *testing.T) {
|
|||||||
verifyServerStopped(t, s.impl)
|
verifyServerStopped(t, s.impl)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestAttachRemoteMultiClientDisconnect tests that that remote attach doesn't take down
|
// TestAttachRemoteMultiClientDisconnect tests that remote attach doesn't take down
|
||||||
// the server in multi-client mode unless terminateDebuggee is explicitly set.
|
// the server in multi-client mode unless terminateDebuggee is explicitly set.
|
||||||
func TestAttachRemoteMultiClientDisconnect(t *testing.T) {
|
func TestAttachRemoteMultiClientDisconnect(t *testing.T) {
|
||||||
closingClientSessionOnly := fmt.Sprintf(daptest.ClosingClient, "halted")
|
closingClientSessionOnly := fmt.Sprintf(daptest.ClosingClient, "halted")
|
||||||
@ -7039,7 +7039,7 @@ func TestDisassemble(t *testing.T) {
|
|||||||
t.Errorf("\ngot %#v\nwant instructions[1].Address = %s", dr, pc)
|
t.Errorf("\ngot %#v\nwant instructions[1].Address = %s", dr, pc)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Request zero instrutions.
|
// Request zero instructions.
|
||||||
client.DisassembleRequest(pc, 0, 0)
|
client.DisassembleRequest(pc, 0, 0)
|
||||||
dr = client.ExpectDisassembleResponse(t)
|
dr = client.ExpectDisassembleResponse(t)
|
||||||
if len(dr.Body.Instructions) != 0 {
|
if len(dr.Body.Instructions) != 0 {
|
||||||
|
|||||||
@ -106,7 +106,7 @@ type LaunchConfig struct {
|
|||||||
// "buildFlags": "-tags=integration -mod=vendor -cover -v"
|
// "buildFlags": "-tags=integration -mod=vendor -cover -v"
|
||||||
BuildFlags string `json:"buildFlags,omitempty"`
|
BuildFlags string `json:"buildFlags,omitempty"`
|
||||||
|
|
||||||
// Output path for the binary of the debugee.
|
// Output path for the binary of the debuggee.
|
||||||
// Relative path is interpreted as the path relative to
|
// Relative path is interpreted as the path relative to
|
||||||
// the Delve's current working directory.
|
// the Delve's current working directory.
|
||||||
// This is deleted after the debug session ends.
|
// This is deleted after the debug session ends.
|
||||||
@ -191,7 +191,7 @@ type LaunchAttachCommonConfig struct {
|
|||||||
// SubstitutePath defines a mapping from a local path to the remote path.
|
// SubstitutePath defines a mapping from a local path to the remote path.
|
||||||
// Both 'from' and 'to' must be specified and non-null.
|
// Both 'from' and 'to' must be specified and non-null.
|
||||||
// Empty values can be used to add or remove absolute path prefixes when mapping.
|
// Empty values can be used to add or remove absolute path prefixes when mapping.
|
||||||
// For example, mapping with empy 'to' can be used to work with binaries with trimmed paths.
|
// For example, mapping with empty 'to' can be used to work with binaries with trimmed paths.
|
||||||
type SubstitutePath struct {
|
type SubstitutePath struct {
|
||||||
// The local path to be replaced when passing paths to the debugger.
|
// The local path to be replaced when passing paths to the debugger.
|
||||||
From string `json:"from,omitempty"`
|
From string `json:"from,omitempty"`
|
||||||
|
|||||||
@ -547,7 +547,7 @@ func (c *RPCClient) FollowExec(v bool, regex string) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// FollowExecEnabled returns true if follow exex mode is enabled.
|
// FollowExecEnabled returns true if follow exec mode is enabled.
|
||||||
func (c *RPCClient) FollowExecEnabled() bool {
|
func (c *RPCClient) FollowExecEnabled() bool {
|
||||||
out := &FollowExecEnabledOut{}
|
out := &FollowExecEnabledOut{}
|
||||||
_ = c.call("FollowExecEnabled", FollowExecEnabledIn{}, out)
|
_ = c.call("FollowExecEnabled", FollowExecEnabledIn{}, out)
|
||||||
|
|||||||
@ -5,7 +5,7 @@ type RPCCallback interface {
|
|||||||
Return(out interface{}, err error)
|
Return(out interface{}, err error)
|
||||||
|
|
||||||
// SetupDoneChan returns a channel that should be closed to signal that the
|
// SetupDoneChan returns a channel that should be closed to signal that the
|
||||||
// asynchornous method has completed setup and the server is ready to
|
// asynchronous method has completed setup and the server is ready to
|
||||||
// receive other requests.
|
// receive other requests.
|
||||||
SetupDoneChan() chan struct{}
|
SetupDoneChan() chan struct{}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -858,7 +858,7 @@ func Test1Issue355(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func Test1Disasm(t *testing.T) {
|
func Test1Disasm(t *testing.T) {
|
||||||
// Tests that disassembling by PC, range, and current PC all yeld similar results
|
// Tests that disassembling by PC, range, and current PC all yield similar results
|
||||||
// Tests that disassembly by current PC will return a disassembly containing the instruction at PC
|
// Tests that disassembly by current PC will return a disassembly containing the instruction at PC
|
||||||
// Tests that stepping on a calculated CALL instruction will yield a disassembly that contains the
|
// Tests that stepping on a calculated CALL instruction will yield a disassembly that contains the
|
||||||
// effective destination of the CALL instruction
|
// effective destination of the CALL instruction
|
||||||
|
|||||||
@ -1360,7 +1360,7 @@ func TestIssue355(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestDisasm(t *testing.T) {
|
func TestDisasm(t *testing.T) {
|
||||||
// Tests that disassembling by PC, range, and current PC all yeld similar results
|
// Tests that disassembling by PC, range, and current PC all yield similar results
|
||||||
// Tests that disassembly by current PC will return a disassembly containing the instruction at PC
|
// Tests that disassembly by current PC will return a disassembly containing the instruction at PC
|
||||||
// Tests that stepping on a calculated CALL instruction will yield a disassembly that contains the
|
// Tests that stepping on a calculated CALL instruction will yield a disassembly that contains the
|
||||||
// effective destination of the CALL instruction
|
// effective destination of the CALL instruction
|
||||||
@ -1962,7 +1962,7 @@ func TestClientServerConsistentExit(t *testing.T) {
|
|||||||
|
|
||||||
// Ensure future commands also return the correct exit status.
|
// Ensure future commands also return the correct exit status.
|
||||||
// Previously there was a bug where the command which prompted the
|
// Previously there was a bug where the command which prompted the
|
||||||
// process to exit (continue, next, etc...) would return the corrent
|
// process to exit (continue, next, etc...) would return the current
|
||||||
// exit status but subsequent commands would return an incorrect exit
|
// exit status but subsequent commands would return an incorrect exit
|
||||||
// status of 0. To test this we simply repeat the 'next' command and
|
// status of 0. To test this we simply repeat the 'next' command and
|
||||||
// ensure we get the correct response again.
|
// ensure we get the correct response again.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user