Skip to content

Enhancements to Aztec Documentation: Grammar and Clarity Improvements #9688

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.

Sign up for GitHub

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

Closed
Noisyxl wants to merge 3 commits into from
Closed

Enhancements to Aztec Documentation: Grammar and Clarity Improvements #9688

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec00f17
Update README.md
Noisyxl Nov 2, 2024
fba3e8e
Update instructions.rs
Noisyxl Nov 2, 2024
9afd62b
Update instructions.rs
ludamad Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions avm-transpiler/src/instructions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use crate::opcodes::AvmOpcode;

/// A simple representation of an AVM instruction for the purpose
/// of generating an AVM bytecode from Brillig.
/// Note: this does structure not impose rules like "ADD instruction must have 3 operands"
/// Note: this structure does not impose rules like "ADD instruction must have 3 operands"
/// That job is left to the instruction decoder, not this thin transpiler.
pub struct AvmInstruction {
pub opcode: AvmOpcode,
Expand All @@ -18,7 +18,7 @@ pub struct AvmInstruction {
/// The 0th bit corresponds to an instruction's 0th offset arg, 1st to 1st, etc...
pub indirect: Option<AvmOperand>,

/// Some instructions have a destination xor input tag
/// Some instructions have a destination or input tag

@ludamad ludamad Nov 2, 2024

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@fcarreiro is this correction correct?

@Noisyxl Noisyxl Nov 2, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Using ‘or’ is more appropriate here, as it indicates that the instruction can have either a destination tag or an input tag, but not necessarily both.

@ludamad ludamad Nov 2, 2024 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

the 'not necessarily both' part is what 'xor' would mean, though :) (exclusive-or)

@Noisyxl Noisyxl Nov 2, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

You're right! 'XOR' captures the idea that only one of the tags can be present, but using 'or' might make it clearer to those who aren't familiar with the terminology. Maybe we could stick with 'or' for simplicity?

@fcarreiro fcarreiro Nov 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The tag concept changed since this was written. Right now only 2 opcodes have (and must have) a tag: SET and CAST. In both cases, the tag is the expected destination type to be set. All other opcodes don't have (and cannot have) a tag.

I'm ok with "Some instructions have a tag, it's usage will depend on the instruction." at this level. I'm also ok with removing "xor" since it's not real english.

/// Its usage will depend on the instruction.
pub tag: Option<AvmTypeTag>,

Expand Down
12 changes: 6 additions & 6 deletions aztec-up/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ bash -i <(curl -s https://install.aztec.network)

That is all.

This will install into `~/.aztec/bin` a collection of scripts to help running aztec containers, and will update
a users `PATH` variable in their shell startup script so they can be found.
This will install into `~/.aztec/bin` a collection of scripts to help with running aztec containers, and will update
the user's `PATH` variable in their shell startup script so they can be found.

- `aztec` - The infrastructure container.
- `aztec-cli` - A command line tool for interacting with infrastructure.
- `aztec-nargo` - A build of `nargo` from `noir` that is guaranteed to be version aligned. Provides compiler, lsp and more.
- `aztec-cli` - A command-line tool for interacting with infrastructure.
- `aztec-nargo` - A build of `nargo` from `noir` that is guaranteed to be version-aligned. Provides compiler, lsp and more.
- `aztec-sandbox` - A wrapper around docker-compose that launches services needed for sandbox testing.
- `aztec-up` - A tool to upgrade the aztec toolchain to the latest, or specific versions.
- `aztec-builder` - A useful tool for projects to generate ABIs and update their dependencies.
Expand All @@ -22,10 +22,10 @@ After installed, you can use `aztec-up` to upgrade or install specific versions.
VERSION=master aztec-up
```

This will install the container built from master branch.
This will install the container built from the master branch.

```
VERSION=1.2.3 aztec-up
```

This will install tagged release version 1.2.3.
This will install the tagged release version 1.2.3.