[Lldb-commits] [PATCH] D127038: Add some documentation for the "breakpoint name" feature

[Jim Ingham via Phabricator via lldb-commits]

jingham added a comment.

Mostly reworking the paragraph on breakpoint hiding.



================
Comment at: lldb/source/Commands/CommandObjectBreakpoint.cpp:2088
+The "liveness" of these settings is one way, from name to breakpoint.  
+If you use break modify to change an option that is also configured on a name 
+which that breakpoint has, the "break modify" command will override the setting 
----------------
mib wrote:
> Can we add some kind of quoting (backticks maybe) to this ?
I don't think we use backticks anywhere in the help, but that should have quotes.


================
Comment at: lldb/source/Commands/CommandObjectBreakpoint.cpp:2099-2102
+5) You can also use breakpoint names to hide breakpoints from normal breakpoint
+operations (list, delete and disable) by running "break name configure -N 
+<Name>" and specifying the --allow-{list,delete,disable} options and then adding 
+that name to a breakpoint.  This won't keep the breakpoint from being deleted 
----------------
mib wrote:
> Does it mean that giving a breakpoint a name will hide it by default to the `list,delete,disable` commands ?
Not sure what you are asking.  These options are all off by default, so if you add a name that doesn't have the --allow-list, --allow-delete or --allow-disable explicitly configured, it won't affect how the breakpoint shows up.  But if you do configure these to true, the indeed, the breakpoint won't show up.

IDE's often want to use some breakpoints for their own purposes, and it's annoying when a user does "break delete" and then messes up their IDE because they deleted breakpoints it was relying on.  This is a mechanism to protect those breakpoints, but it is purely opt in.


================
Comment at: lldb/source/Commands/CommandObjectBreakpoint.cpp:2103-2106
+or disabled if you refer to it specifically by ID, but "break delete" and 
+"break disable" to delete or disable ALL breakpoints won't delete the ones 
+sharing the name, and "break list" won't show them.
+
----------------
mib wrote:
> This sentences is already very long. I'd either surround `to delete or disable ALL breakpoints` between commas or rephrase it like this.
That was a little contorted.  I rewrote it to be clearer, see what you think.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D127038/new/

https://reviews.llvm.org/D127038