Merge pull request dotnet/coreclr#20409 from lol768/patch-1
authorBruce Forstall <brucefo@microsoft.com>
Tue, 8 Jan 2019 22:02:15 +0000 (14:02 -0800)
committerGitHub <noreply@github.com>
Tue, 8 Jan 2019 22:02:15 +0000 (14:02 -0800)
Add a note to clarify debugging w/ dotnet is fine

Commit migrated from https://github.com/dotnet/coreclr/commit/d73e20f6cb12d7cf4c9909ff70a8920c978a1ce3

1  2 
docs/coreclr/building/debugging-instructions.md

@@@ -54,40 -54,42 +54,42 @@@ You can combine steps 4-8 and pass ever
  
  For .NET Core version 1.x and 2.0.x, libsosplugin.so is built for and will only work with version 3.6 of lldb. For .NET Core 2.1, the plugin is built for 3.9 lldb and will work with 3.8 and 3.9 lldb.
  
+ **Note:** _corerun_ is a simple host that does not support resolving NuGet dependencies. It relies on libraries being locatable via the `CORE_LIBRARIES` environment variable or present in the same directory as the corerun executable. The instructions above are equally applicable to the _dotnet_ host, however - e.g. for step 4 `lldb-3.9 dotnet bin/Debug/netcoreapp2.1/MvcApplication.dll` will let you debug _MvcApplication_ in the same manner.
  ### SOS commands ###
  
 -This is the full list of commands currently supported by SOS. lldb is case-sensitive unlike windbg.
 -
 -      Type "soshelp <functionname>" for detailed info on that function.
 -
 -      Object Inspection                  Examining code and stacks
 -      -----------------------------      -----------------------------
 -      DumpObj (dumpobj)                  Threads (clrthreads)
 -      DumpArray                          ThreadState
 -      DumpStackObjects (dso)             IP2MD (ip2md)
 -      DumpHeap (dumpheap)                u (clru)
 -      DumpVC                             DumpStack (dumpstack)
 -      GCRoot (gcroot)                    EEStack (eestack)
 -      PrintException (pe)                ClrStack (clrstack)
 -                                         GCInfo
 -                                         EHInfo
 -                                         bpmd (bpmd)
 -
 -      Examining CLR data structures      Diagnostic Utilities
 -      -----------------------------      -----------------------------
 -      DumpDomain                         VerifyHeap
 -      EEHeap (eeheap)                    FindAppDomain
 -      Name2EE (name2ee)                  DumpLog (dumplog)
 -      DumpMT (dumpmt)                    CreateDump (createdump)
 -      DumpClass (dumpclass)
 -      DumpMD (dumpmd)
 -      Token2EE
 -      DumpModule (dumpmodule)
 -      DumpAssembly
 -      DumpRuntimeTypes
 -      DumpIL (dumpil)
 -      DumpSig
 -      DumpSigElem
 +This is the full list of commands currently supported by SOS. lldb is case-sensitive, unlike windbg.
 +
 +    Type "soshelp <functionname>" for detailed info on that function.
 +
 +    Object Inspection                  Examining code and stacks
 +    -----------------------------      -----------------------------
 +    DumpObj (dumpobj)                  Threads (clrthreads)
 +    DumpArray                          ThreadState
 +    DumpStackObjects (dso)             IP2MD (ip2md)
 +    DumpHeap (dumpheap)                u (clru)
 +    DumpVC                             DumpStack (dumpstack)
 +    GCRoot (gcroot)                    EEStack (eestack)
 +    PrintException (pe)                ClrStack (clrstack)
 +                                       GCInfo
 +                                       EHInfo
 +                                       bpmd (bpmd)
 +
 +    Examining CLR data structures      Diagnostic Utilities
 +    -----------------------------      -----------------------------
 +    DumpDomain                         VerifyHeap
 +    EEHeap (eeheap)                    FindAppDomain
 +    Name2EE (name2ee)                  DumpLog (dumplog)
 +    DumpMT (dumpmt)                    CreateDump (createdump)
 +    DumpClass (dumpclass)
 +    DumpMD (dumpmd)
 +    Token2EE
 +    DumpModule (dumpmodule)
 +    DumpAssembly
 +    DumpRuntimeTypes
 +    DumpIL (dumpil)
 +    DumpSig
 +    DumpSigElem
  
      Examining the GC history           Other
      -----------------------------      -----------------------------