Skip to content

Commit

Permalink
[docgen] Rewrite docgen on Move model v2 (#20865)
Browse files Browse the repository at this point in the history
## Description 

- Docs are now on the AST
- Docgen uses move-model-2
  - There is a big knot of work in the package system for this
  - The tests are their own crate due to circular dep issues
- Functionally, there is not much of a change, except that we use named
addresses in docs! Seems like a win to me but we should discuss as its a
bit confusing

## Test plan 

- Migrated tests
- Regenerated docs 

---

## Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

- [ ] Protocol: 
- [ ] Nodes (Validators and Full nodes): 
- [ ] gRPC:
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [X] CLI: Move docgen now uses named addresses. This will change some directory structures in the output format, which may break any tools targeting a rigid directory structure. 
- [ ] Rust SDK:

---------

Co-authored-by: ronny-mysten <[email protected]>
Co-authored-by: Ronny Roland <[email protected]>
  • Loading branch information
3 people authored Jan 16, 2025
1 parent 3f1540b commit 885c2c0
Show file tree
Hide file tree
Showing 369 changed files with 60,246 additions and 61,731 deletions.
86 changes: 30 additions & 56 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ exclude = [
"external-crates/move/crates/move-model",
"external-crates/move/crates/move-package",
"external-crates/move/crates/move-proc-macros",
"external-crates/move/crates/move-prover",
"external-crates/move/crates/move-prover-test-utils",
"external-crates/move/crates/move-stackless-bytecode",
"external-crates/move/crates/move-stdlib",
Expand Down Expand Up @@ -566,7 +565,6 @@ move-vm-profiler = { path = "external-crates/move/crates/move-vm-profiler" }
move-command-line-common = { path = "external-crates/move/crates/move-command-line-common" }
move-transactional-test-runner = { path = "external-crates/move/crates/move-transactional-test-runner" }
move-ir-types = { path = "external-crates/move/crates/move-ir-types" }
move-prover = { path = "external-crates/move/crates/move-prover" }
move-stackless-bytecode = { path = "external-crates/move/crates/move-stackless-bytecode" }
move-symbol-pool = { path = "external-crates/move/crates/move-symbol-pool" }
move-abstract-interpreter = { path = "external-crates/move/crates/move-abstract-interpreter" }
Expand Down
6 changes: 3 additions & 3 deletions crates/sui-framework/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
This file contains useful information and troubleshooting advice for those wishing to contribute to `sui-framework` crate.

## Framework Move source code changes
## Framework Move source code changes

If changes need to be made to the framework's Move code, additional actions need to be taken to ensure that the system builds and runs correctly. In particular, one needs to make sure that the framework snapshot tests are up-to-date and that any new native functions are correctly handled by the [Move Prover](https://github.com/move-language/move/tree/main/language/move-prover).
If changes need to be made to the framework's Move code, additional actions need to be taken to ensure that the system builds and runs correctly. In particular, one needs to make sure that the framework snapshot tests are up-to-date and that any new native functions are correctly handled.

### Snapshot tests update

Run the following commands in Sui's [root directory](../../) and accept the changes, if any (if you do not have `cargo-insta` command installed, please run the `cargo install cargo-insta` command first):

``` bash
```bash
cargo insta test -p sui-swarm-config --review
```

Expand Down
Loading

0 comments on commit 885c2c0

Please sign in to comment.