ch0ic3/cutter
1
0
Fork 0
mirror of https://github.com/rizinorg/cutter.git synced 2024-12-19 19:36:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add warning about json commands to docs

Browse Source
This commit is contained in:
Florian Märkl 2019-03-17 14:02:47 +01:00
parent 6f324496be
commit 8130e1c54f
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/plugins/tutorial-python.rst
View File

@ -143,6 +143,10 @@ Many commands in radare2 can be suffixed with a ``j`` to return JSON output.
``cmdj()`` will automatically deserialize the JSON into python dicts and lists, so the
information can be easily accessed.
.. warning::
When fetching data that is not meant to be used only as readable text, **always** use the JSON variant of a command!
Regular command output is not meant to be parsed and is subject to change at any time, which will break your code.
In our case, we use the two commands ``pd`` (Print Disassembly) and ``pdj`` (Print Disassembly as JSON)
with a parameter of 1 to fetch a single line of disassembly.