This is an archive of the discontinued LLVM Phabricator instance.

Differential D89383

[lldb] Correct vFile:pread/pwrite packet docs
ClosedPublic

Authored by DavidSpickett on Oct 14 2020, 4:21 AM.

Details

Reviewers
jasonmolenda
Commits
rGf8a3b9b06c4a: [lldb] Correct vFile:pread/pwrite packet docs
Summary

The statement that lldb-server can handle
decimal and hex numbers is misleading.
(it can only handle hex with 0x prefix)

Mentioning non decimal numbers at all
is just creating more confusion for anyone
who tries to use them with lldb-server.

Diff Detail

Event Timeline

DavidSpickett created this revision.Oct 14 2020, 4:21 AM
Herald added a project: Restricted Project. · View Herald TranscriptOct 14 2020, 4:21 AM
Herald added a subscriber: lldb-commits. · View Herald Transcript
DavidSpickett requested review of this revision.Oct 14 2020, 4:21 AM
Herald added a subscriber: JDevlieghere. · View Herald TranscriptOct 14 2020, 4:21 AM
DavidSpickett added a reviewer: jasonmolenda.Oct 14 2020, 4:22 AM
DavidSpickett mentioned this in D89227: [lldb] Note difference in vFile:pread/pwrite format for lldb.
Harbormaster completed remote builds in B75060: Diff 298111.Oct 14 2020, 4:52 AM
DavidSpickett updated this revision to Diff 298954.Oct 19 2020, 2:12 AM
  • listing what we use decimal for is redundant
  • correct spelling of hexadecimal
Harbormaster completed remote builds in B75492: Diff 298954.Oct 19 2020, 3:00 AM
This revision was not accepted when it landed; it landed in state Needs Review.Oct 27 2020, 4:47 AM
Closed by commit rGf8a3b9b06c4a: [lldb] Correct vFile:pread/pwrite packet docs (authored by DavidSpickett). · Explain Why
This revision was automatically updated to reflect the committed changes.
DavidSpickett added a commit: rGf8a3b9b06c4a: [lldb] Correct vFile:pread/pwrite packet docs.
DavidSpickett added a comment.Oct 27 2020, 4:49 AM

Landed as already agreed on in https://reviews.llvm.org/D89227.

Revision Contents

PathSize
lldb/
docs/
9 lines

Diff 300953

lldb/docs/lldb-platform-packets.txt

Show First 20 Lines • Show All 408 Lines • ▼ Show 20 Lines
// 2. number of bytes to be read, base 10 // 2. number of bytes to be read, base 10
// 3. offset into file to start from, base 10 // 3. offset into file to start from, base 10
// //
// Response is F, followed by the number of bytes read (base 10), a // Response is F, followed by the number of bytes read (base 10), a
// semicolon, followed by the data in the binary-escaped-data encoding. // semicolon, followed by the data in the binary-escaped-data encoding.
// //
// COMPATIBILITY // COMPATIBILITY
// The gdb-remote serial protocol documentation says that numbers // The gdb-remote serial protocol documentation says that numbers
// in "vFile:" packets should be hexidecimal. Instead lldb uses // in "vFile:" packets should be hexadecimal. Instead lldb uses
// decimal for the number of bytes and offset. // decimal.
// lldb-server can process either format.
//---------------------------------------------------------------------- //----------------------------------------------------------------------
// vFile:pwrite: // vFile:pwrite:
// //
// BRIEF // BRIEF
// Write data to a previously opened file descriptor. // Write data to a previously opened file descriptor.
// //
// EXAMPLE // EXAMPLE
// //
// receive: vFile:pwrite:8,0,\cf\fa\ed\fe\0c\00\00 // receive: vFile:pwrite:8,0,\cf\fa\ed\fe\0c\00\00
// send: F1024 // send: F1024
// //
// request packet has the fields: // request packet has the fields:
// 1. file descriptor, base 10 // 1. file descriptor, base 10
// 2. offset into file to start from, base 10 // 2. offset into file to start from, base 10
// 3. binary-escaped-data to be written // 3. binary-escaped-data to be written
// //
// Response is F, followed by the number of bytes written (base 10) // Response is F, followed by the number of bytes written (base 10)
// //
// COMPATIBILITY // COMPATIBILITY
// The gdb-remote serial protocol documentation says that numbers // The gdb-remote serial protocol documentation says that numbers
// in "vFile:" packets should be hexidecimal. Instead lldb uses // in "vFile:" packets should be hexadecimal. Instead lldb uses
// decimal for the offset. lldb-server can process either format. // decimal.
Finally, the platform must be able to launch processes so that debugserver Finally, the platform must be able to launch processes so that debugserver
can attach to them. To do this, the following packets should be handled: can attach to them. To do this, the following packets should be handled:
Show All 13 Lines