Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Request: Core VM Operation Instructions in fift #1328

Open
zqy-691001 opened this issue Oct 30, 2024 · 0 comments
Open

Documentation Request: Core VM Operation Instructions in fift #1328

zqy-691001 opened this issue Oct 30, 2024 · 0 comments

Comments

@zqy-691001
Copy link

Description of the Issue:
Several core virtual machine operation instructions in the fift language, including (vmopdump), vmcont, vmcont@, and (vmoplen), are present in the core Fift library and its C++ implementation but are undocumented in the official Fift whitepaper or other official documentation. This lack of documentation can lead to confusion and hinder the ability of developers and users to understand and effectively use the fift language and its VM operations.

For example
(vmopdump)

Relevant Links:

Suggested Action:
It would be beneficial to include documentation for the(vmopdump) instruction in the official fift documentation to ensure clarity and ease of use for the community. The documentation should explain the purpose, usage, and any relevant details about the instruction.

Additional Information:

  • I have verified that the instruction is not mentioned in the fift whitepaper or any official documentation.
  • The implementation suggests that (vmopdump)is used for dumping VM operations and core with Disasm.fif, but without documentation, it's difficult to understand its full functionality and usage context.

Steps to Reproduce:

  • N/A (This is a documentation request, not a bug report)

Expected Behavior:

  • The(vmopdump)instruction should be documented in the official fift documentation.

Actual Behavior:

  • The (vmopdump) instruction is undocumented.

Environment:

  • Operating System: [kaili_linux]
  • Version: [TON v2024.10]

Additional Comments:

  • I believe that documenting this instruction will greatly improve the usability and understanding of the fift language for developers.

Modification Suggestions:
1.Add a New Section in the Fift Whitepaper:
Create a new text in the Fift whitepaper dedicated to the (vmopdump) instruction. This text should provide an overview of the instruction, its syntax, parameters, and output.
2.Include Detailed Usage Examples:
Provide one or more detailed usage examples that demonstrate how to use the (vmopdump) instruction effectively. These examples should cover typical use cases and edge cases.
Syntax:
(vmopdump) ( s cp -- s' dump )
s: The cell slice (vm::CellSlice) containing the VM instruction to be dumped.
cp: The code page identifier, an integer within the range of -0x80000000 to 0x7fffffff.
s': The remaining cell slice after the dumped instruction has been processed.
dump: A string representation of the dumped VM instruction.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant