[Lldb-commits] [lldb] bd53c7c - [lldb][Docs] Document vFile "MD5" and "exists"

[David Spickett via lldb-commits]

Author: David Spickett
Date: 2024-04-26T09:45:17+01:00
New Revision: bd53c7cce418fe7f3e171859d4718df15d03dc2b

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

LOG: [lldb][Docs] Document vFile "MD5" and "exists"

This is a Markdown version of https://github.com/llvm/llvm-project/pull/89357.

Added: 
    

Modified: 
    lldb/docs/resources/lldbgdbremote.md

Removed: 
    


################################################################################
diff  --git a/lldb/docs/resources/lldbgdbremote.md b/lldb/docs/resources/lldbgdbremote.md
index 9a1032818af021..05e4f714f7f704 100644
--- a/lldb/docs/resources/lldbgdbremote.md
+++ b/lldb/docs/resources/lldbgdbremote.md
@@ -2621,4 +2621,46 @@ Request packet has the fields:
    2. Offset into file to start from, base 16
    3. binary-escaped-data to be written
 
-Response is `F`, followed by the number of bytes written (base 16).
\ No newline at end of file
+Response is `F`, followed by the number of bytes written (base 16).
+
+### vFile:MD5
+
+#### Brief
+
+Generate an MD5 hash of the file at the given path.
+
+#### Example
+
+```
+receive: vFile:MD5:2f746d702f61
+send (success): F,00000000000000001111111111111111
+send (failure): F,x
+```
+
+Request packet contains the ASCII hex encoded filename.
+
+If the hash succeeded, the response is `F,` followed by the low 64
+bits of the result, and finally the high 64 bits of the result. Both are in
+hex format without a prefix.
+
+The response is `F,`, followed by `x` if the file did not exist
+or failed to hash.
+
+### vFile:exists
+
+#### Brief
+
+Check whether the file at the given path exists.
+
+#### Example
+
+```
+receive: vFile:exists:2f746d702f61
+send         (exists): F,1
+send (does not exist): F,0
+```
+
+Request packet contains the ASCII hex encoded filename.
+
+The response is a return code where 1 means the file exists
+and 0 means it does not.
\ No newline at end of file