[Lldb-commits] [PATCH] D118842: Small fixes to platform packet documentation

[Jason Molenda via Phabricator via lldb-commits]

jasonmolenda created this revision.
jasonmolenda added a reviewer: mgorny.
jasonmolenda added a project: LLDB.
Herald added a subscriber: JDevlieghere.
jasonmolenda requested review of this revision.
Herald added a subscriber: lldb-commits.

I have a standalone implementation of the lldb platform packets for Darwin systems, and in the process of updating it to match the fixes from Michał in https://reviews.llvm.org/D107475 , I found a few places where the documentation needed to be updated to match lldb/gdb's actual behavior.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D118842

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


Index: lldb/docs/lldb-platform-packets.txt
===================================================================
--- lldb/docs/lldb-platform-packets.txt
+++ lldb/docs/lldb-platform-packets.txt
@@ -94,7 +94,7 @@
 //     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 @@
 //  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 @@
 //
 //  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 @@
 //  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 @@
 //  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 @@
 //
 //  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 @@
 //     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 @@
 //  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.
 
 
 //----------------------------------------------------------------------


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D118842.405397.patch
Type: text/x-patch
Size: 2941 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20220202/47634dd1/attachment.bin>