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

Update docs/DEEP_DIVE.md for zig changes #1431

Merged
merged 2 commits into from Jan 18, 2024

Conversation

brson
Copy link
Contributor

@brson brson commented Jan 16, 2024

I discovered this useful doc and tried to run through it. It needs some updates.

  • Setting the log_level variable on config.zig does not work as described. It can be set on the command line while building.

  • The --pkg-begin flag no longer exists.


Also, the results I got running this tutorial contradicted what the text says should happen. I'll file a separate issue about it since I don't understand enough to just fix it. (#1432)

@brson
Copy link
Contributor Author

brson commented Jan 16, 2024

The failure is a spellcheck. It identifies one preexisting typo in DEEP_DIVE.md that I am not fixing here since presumably somebody else is looking at those.

@brson
Copy link
Contributor Author

brson commented Jan 16, 2024

Oh the spelling error is part of this diff so I guess I must fix it to pass CI.

@matklad
Copy link
Member

matklad commented Jan 17, 2024

@brson we have just rewrote the entire git history of TigerBeetle, to get rid of huge files that were accidentally commited in the early wild exploration days:

d7c3f46

Please resubmit on top of new history, and sorry for the inconvenience :-)

Copy link
Member

@matklad matklad left a comment

Choose a reason for hiding this comment

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

The diff itself looks great!

- Open `src/config.zig` in your editor and change `log_level` to `.debug`.

- Rebuild TigerBeetle using the new debug log level by running `zig/zig build -Drelease && mv zig-out/bin/tigerbeetle .`
- Rebuild TigerBeetle with the debug log level by running `zig/zig build -Drelease -Dconfig-log-level=debug`
Copy link
Member

Choose a reason for hiding this comment

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

One item in our infinite TODO list is "make log level configurable at runtime"

zig/zig run src/demos/demo_01_create_accounts.zig --pkg-begin vsr src/vsr.zig
zig/zig run src/demos/demo_02_lookup_accounts.zig --pkg-begin vsr src/vsr.zig
zig/zig run src/demos/demo_01_create_accounts.zig --deps vsr --mod vsr::src/vsr.zig
zig/zig run src/demos/demo_02_lookup_accounts.zig --deps vsr --mod vsr::src/vsr.zig
Copy link
Member

Choose a reason for hiding this comment

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

Ohhh, excellent catch!

@brson
Copy link
Contributor Author

brson commented Jan 18, 2024

@matklad I rebased this onto the new main branch.

@matklad matklad added this pull request to the merge queue Jan 18, 2024
Merged via the queue into tigerbeetle:main with commit a2594cf Jan 18, 2024
25 checks passed
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

Successfully merging this pull request may close these issues.

None yet

2 participants