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

Add Environment Variables documentation to the book #125

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

satk0
Copy link

@satk0 satk0 commented Jul 11, 2024

It aims to resolve the rizin issue rizinorg/rizin#4445, but its NOT yet ready to merge !

While trying to solve it, I've met 2 problems:

  • I don't know where to put rizin env vars doc (in a 16. Build Variables or create a new chapter?)
  • rz-test is not documented, so nowhere to put env var doc (should I also document rz-test?)

@wargio
Copy link
Member

wargio commented Jul 12, 2024

Yes add a new section called Run-Time Variables after the Build Variables and probably we could rename Build Variables to Compile-Time Variables

@wargio
Copy link
Member

wargio commented Jul 12, 2024

@XVilka @kazarmy what do you think?

@wargio wargio marked this pull request as draft July 12, 2024 03:07
@wargio wargio self-assigned this Jul 12, 2024
@wargio wargio added the section label Jul 12, 2024
@wargio
Copy link
Member

wargio commented Jul 12, 2024

Regarding rz-test, it's not mapped in the book, because it is supposed to not be used by a user. its usage is available on the rizin repo itself: https://github.com/rizinorg/rizin/tree/dev/test#usage

@satk0
Copy link
Author

satk0 commented Jul 12, 2024

Thanks for the answer. So I will just omit rz-test and focus on adding the new section and renaming Build Variables one.

@satk0
Copy link
Author

satk0 commented Jul 12, 2024

Done, let me know how it looks

_quarto.yml Outdated
Comment on lines 41 to 42
- src/configuration/compile-time_variables.md
- src/configuration/run-time_variables.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe use underscores instead of dashes for the files.

@@ -0,0 +1,34 @@
## Run-Time Variables

After successful compilation, run-time variables will be exposed to change the default behavior of rizin.
Copy link
Member

@wargio wargio Jul 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After successful compilation, run-time variables will be exposed to change the default behavior of rizin.
Run-time variables (also known as environment variables) can be used to change the default behavior when running rizin or tools.


After successful compilation, run-time variables will be exposed to change the default behavior of rizin.

Description of these run-time variables can be accessed by executing the command `rizin -hh` on a terminal.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Description of these run-time variables can be accessed by executing the command `rizin -hh` on a terminal.
The description of these run-time variables can be accessed by executing the command `rizin -hh` on a terminal.

@satk0
Copy link
Author

satk0 commented Jul 12, 2024

Done, that's the whole list of env vars that you can print with -hh command.

@wargio wargio marked this pull request as ready for review July 14, 2024 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants