[Lldb-commits] [lldb] 9b1cb0e - Platform gdb RSP packet doc fixes based on implementation behavior

[Jason Molenda via lldb-commits]

Author: Jason Molenda
Date: 2022-02-07T23:51:46-08:00
New Revision: 9b1cb0e171a35bf9034663566bb3400f668769b0

URL: https://github.com/llvm/llvm-project/commit/9b1cb0e171a35bf9034663566bb3400f668769b0
DIFF: https://github.com/llvm/llvm-project/commit/9b1cb0e171a35bf9034663566bb3400f668769b0.diff

LOG: Platform gdb RSP packet doc fixes based on implementation behavior

Reviewing some recent fixes to the platform packet implementations
in lldb, I saw the docs were out of sync in a few spots.  Updated them.

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

Added: 
    

Modified: 
    lldb/docs/lldb-platform-packets.txt

Removed: 
    


################################################################################
diff  --git a/lldb/docs/lldb-platform-packets.txt b/lldb/docs/lldb-platform-packets.txt
index 691a4412ea630..4cf575e5ee8ad 100644
--- a/lldb/docs/lldb-platform-packets.txt
+++ b/lldb/docs/lldb-platform-packets.txt
@@ -94,7 +94,7 @@ incompatible with the flags that gdb specifies.
 //     2. file path in ascii-hex encoding
 //
 //  response is F followed by the return value of the mkdir() call,
-//  base 10 encoded.
+//  base 16 encoded.
 
 //----------------------------------------------------------------------
 // qPlatform_shell:
@@ -270,7 +270,7 @@ incompatible with the flags that gdb specifies.
 //  send:    Fc008
 //
 //  response is "F" followed by the file size in base 16.
-//  "F-1,errno" with the errno if an error occurs.
+//  "F-1,errno" with the errno if an error occurs, base 16.
 
 
 //----------------------------------------------------------------------
@@ -286,7 +286,7 @@ incompatible with the flags that gdb specifies.
 //
 //  response is "F" followed by the mode bits in base 16, this 0x1ed would 
 //  correspond to 0755 in octal.  
-//  "F-1,errno" with the errno if an error occurs.
+//  "F-1,errno" with the errno if an error occurs, base 16.
 
 //----------------------------------------------------------------------
 // vFile:unlink:
@@ -300,7 +300,9 @@ incompatible with the flags that gdb specifies.
 //  send:    F0
 //
 //  Argument is a file path in ascii-hex encoding.
-//  Response is "F" plus the return value of unlink(), base 10 encoding.
+//  Response is "F" plus the return value of unlink(), base 16 encoding.
+//  Return value may optionally be followed by a comma and the base16
+//  value of errno if unlink failed.
 
 //----------------------------------------------------------------------
 // vFile:symlink:
@@ -314,7 +316,8 @@ incompatible with the flags that gdb specifies.
 //  send:    F0,0
 //
 //  Argument file paths are in ascii-hex encoding.
-//  Response is "F" plus the return value of symlink(), base 10 encoding, twice.
+//  Response is "F" plus the return value of symlink(), base 16 encoding, 
+//  optionally followed by the value of errno if it failed, also base 16.
 
 //----------------------------------------------------------------------
 // vFile:chmod:
@@ -330,7 +333,7 @@ incompatible with the flags that gdb specifies.
 //
 //  Arguments are the mode bits to set, base 16, and a file path in 
 //  ascii-hex encoding.
-//  Response is "F" plus the return value of chmod(), base 10 encoding.
+//  Response is "F" plus the return value of chmod(), base 16 encoding.
 //
 //  I don't know why there are two packets for the same thing, v.
 //  vFile:chmod:.
@@ -370,7 +373,7 @@ incompatible with the flags that gdb specifies.
 //     3. mode bits, base 16
 //  
 //  response is F followed by the opened file descriptor in base 16.
-//  "F-1,errno" with the errno if an error occurs.
+//  "F-1,errno" with the errno if an error occurs, base 16.
 //
 //----------------------------------------------------------------------
 // vFile:close:
@@ -384,7 +387,8 @@ incompatible with the flags that gdb specifies.
 //  send:    F0
 //
 //  File descriptor is in base 16.
-//  "F-1,errno" with the errno if an error occurs.
+//  "F-1,errno" with the errno if an error occurs,
+//  errno is base 16.
 
 
 //----------------------------------------------------------------------