[Lldb-commits] [lldb] 0f3254b - [lldb] Improve help for platform put-file

[Keith Smiley via lldb-commits]

Author: Keith Smiley
Date: 2021-10-05T10:29:37-07:00
New Revision: 0f3254b29f375d449e815e91d63bef78d9e81354

URL: https://github.com/llvm/llvm-project/commit/0f3254b29f375d449e815e91d63bef78d9e81354
DIFF: https://github.com/llvm/llvm-project/commit/0f3254b29f375d449e815e91d63bef78d9e81354.diff

LOG: [lldb] Improve help for platform put-file

Previously it was not clear what arguments this required, or what it would do if you didn't pass the destination argument.

Differential Revision: https://reviews.llvm.org/D110981

Added: 
    

Modified: 
    lldb/source/Commands/CommandObjectPlatform.cpp

Removed: 
    


################################################################################
diff  --git a/lldb/source/Commands/CommandObjectPlatform.cpp b/lldb/source/Commands/CommandObjectPlatform.cpp
index c4444d4d880e7..6bfb4c8a0689c 100644
--- a/lldb/source/Commands/CommandObjectPlatform.cpp
+++ b/lldb/source/Commands/CommandObjectPlatform.cpp
@@ -1067,7 +1067,18 @@ class CommandObjectPlatformPutFile : public CommandObjectParsed {
   CommandObjectPlatformPutFile(CommandInterpreter &interpreter)
       : CommandObjectParsed(
             interpreter, "platform put-file",
-            "Transfer a file from this system to the remote end.", nullptr, 0) {
+            "Transfer a file from this system to the remote end.",
+            "platform put-file <source> [<destination>]", 0) {
+    SetHelpLong(
+        R"(Examples:
+
+(lldb) platform put-file /source/foo.txt /destination/bar.txt
+
+(lldb) platform put-file /source/foo.txt
+
+    Relative source file paths are resolved against lldb's local working directory.
+
+    Omitting the destination places the file in the platform working directory.)");
   }
 
   ~CommandObjectPlatformPutFile() override = default;