Skip to content

[easy] Fix spacing in help message of 'process save-core' command #89445

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.

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

Merged
merged 1 commit into from
Jun 4, 2024

Conversation

mdko
Copy link
Contributor

@mdko mdko commented Apr 19, 2024

Very minor change to help message on process save-core. Adds space between two sentences explaining the -p option:

"Specify a plugin name to create the core file.This allows core files to be saved in different formats."
-->
"Specify a plugin name to create the core file. This allows core files to be saved in different formats."

Before:

(lldb) help process save-core
Save the current process as a core file using an appropriate file type.

Syntax: process save-core [-s corefile-style -p plugin-name] FILE

Command Options Usage:
  process save-core [-p[<plugin>]] [-s <corefile-style>] <path>

       -p[<plugin>] ( --plugin-name=[<plugin>] )
            Specify a plugin name to create the core file.This allows core files to be saved in different formats.

       -s <corefile-style> ( --style <corefile-style> )
            Request a specific style of corefile to be saved.
            Values: full | modified-memory | stack

     This command takes options and free-form arguments.  If your arguments resemble option specifiers (i.e., they start with a -
     or --), you must use ' -- ' between the end of the command options and the beginning of the arguments.

After:

michristensen@devbig356 build/Debug » $HOME/llvm-sand/build/Debug/bin/lldb -x
(lldb) help process save-core
Save the current process as a core file using an appropriate file type.

Syntax: process save-core [-s corefile-style -p plugin-name] FILE

Command Options Usage:
  process save-core [-p[<plugin>]] [-s <corefile-style>] <path>

       -p[<plugin>] ( --plugin-name=[<plugin>] )
            Specify a plugin name to create the core file. This allows core files to be saved in different formats.

       -s <corefile-style> ( --style <corefile-style> )
            Request a specific style of corefile to be saved.
            Values: full | modified-memory | stack

     This command takes options and free-form arguments.  If your arguments resemble option specifiers (i.e., they start with a -
     or --), you must use ' -- ' between the end of the command options and the beginning of the arguments.

@mdko mdko requested a review from JDevlieghere as a code owner April 19, 2024 19:53
@llvmbot llvmbot added the lldb label Apr 19, 2024
@llvmbot
Copy link
Member

llvmbot commented Apr 19, 2024

@llvm/pr-subscribers-lldb

Author: Michael Christensen (mdko)

Changes

Very minor change to help message on process save-core. Adds space between two sentences explaining the -p option:

"Specify a plugin name to create the core file.This allows core files to be saved in different formats."
-->
"Specify a plugin name to create the core file. This allows core files to be saved in different formats."

Before:

(lldb) help process save-core
Save the current process as a core file using an appropriate file type.

Syntax: process save-core [-s corefile-style -p plugin-name] FILE

Command Options Usage:
  process save-core [-p[&lt;plugin&gt;]] [-s &lt;corefile-style&gt;] &lt;path&gt;

       -p[&lt;plugin&gt;] ( --plugin-name=[&lt;plugin&gt;] )
            Specify a plugin name to create the core file.This allows core files to be saved in different formats.

       -s &lt;corefile-style&gt; ( --style &lt;corefile-style&gt; )
            Request a specific style of corefile to be saved.
            Values: full | modified-memory | stack

     This command takes options and free-form arguments.  If your arguments resemble option specifiers (i.e., they start with a -
     or --), you must use ' -- ' between the end of the command options and the beginning of the arguments.

After:

michristensen@<!-- -->devbig356 build/Debug » $HOME/llvm-sand/build/Debug/bin/lldb -x
(lldb) help process save-core
Save the current process as a core file using an appropriate file type.

Syntax: process save-core [-s corefile-style -p plugin-name] FILE

Command Options Usage:
  process save-core [-p[&lt;plugin&gt;]] [-s &lt;corefile-style&gt;] &lt;path&gt;

       -p[&lt;plugin&gt;] ( --plugin-name=[&lt;plugin&gt;] )
            Specify a plugin name to create the core file. This allows core files to be saved in different formats.

       -s &lt;corefile-style&gt; ( --style &lt;corefile-style&gt; )
            Request a specific style of corefile to be saved.
            Values: full | modified-memory | stack

     This command takes options and free-form arguments.  If your arguments resemble option specifiers (i.e., they start with a -
     or --), you must use ' -- ' between the end of the command options and the beginning of the arguments.

Full diff: https://github.com/llvm/llvm-project/pull/89445.diff

1 Files Affected:

  • (modified) lldb/source/Commands/Options.td (+1-1)
diff --git a/lldb/source/Commands/Options.td b/lldb/source/Commands/Options.td
index 62bbfdc117834f..00238d67d73215 100644
--- a/lldb/source/Commands/Options.td
+++ b/lldb/source/Commands/Options.td
@@ -784,7 +784,7 @@ let Command = "process save_core" in {
     EnumArg<"SaveCoreStyle">, Desc<"Request a specific style "
     "of corefile to be saved.">;
   def process_save_core_plugin_name : Option<"plugin-name", "p">,
-    OptionalArg<"Plugin">, Desc<"Specify a plugin name to create the core file."
+    OptionalArg<"Plugin">, Desc<"Specify a plugin name to create the core file. "
     "This allows core files to be saved in different formats.">;
 }
 

Copy link
Member

@bulbazord bulbazord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@GeorgeHuyubo GeorgeHuyubo merged commit 679f75e into llvm:main Jun 4, 2024
@mdko mdko deleted the process-save-core-help-message branch June 4, 2024 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants