Skip to content

Commit

Permalink
refactor!: rename repository to machine-guest-tools
Browse files Browse the repository at this point in the history
  • Loading branch information
edubart committed Jan 16, 2025
1 parent 37b1e25 commit 9518d03
Show file tree
Hide file tree
Showing 11 changed files with 39 additions and 39 deletions.
2 changes: 1 addition & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
machine-emulator-tools-*.ext2
machine-guest-tools-*.ext2
rootfs*
.clang-format
.github
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
*.ext2
machine-emulator-tools-*.tar.gz
machine-guest-tools-*.tar.gz
rootfs.*
package.json
*.bin
Expand Down
42 changes: 21 additions & 21 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,24 +178,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [0.2.0]
- [0.1.0]

[Unreleased]: https://github.com/cartesi/machine-emulator-tools/compare/v0.16.1...HEAD
[0.16.1]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.16.1
[0.16.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.16.0
[0.15.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.15.0
[0.14.1]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.14.1
[0.14.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.14.0
[0.13.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.13.0
[0.12.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.12.0
[0.11.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.11.0
[0.10.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.10.0
[0.9.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.9.0
[0.8.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.8.0
[0.7.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.7.0
[0.6.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.6.0
[0.5.1]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.5.1
[0.5.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.5.0
[0.4.1]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.4.1
[0.4.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.4.0
[0.3.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.3.0
[0.2.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.2.0
[0.1.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.1.0
[Unreleased]: https://github.com/cartesi/machine-guest-tools/compare/v0.16.1...HEAD
[0.16.1]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.16.1
[0.16.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.16.0
[0.15.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.15.0
[0.14.1]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.14.1
[0.14.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.14.0
[0.13.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.13.0
[0.12.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.12.0
[0.11.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.11.0
[0.10.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.10.0
[0.9.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.9.0
[0.8.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.8.0
[0.7.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.7.0
[0.6.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.6.0
[0.5.1]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.5.1
[0.5.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.5.0
[0.4.1]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.4.1
[0.4.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.4.0
[0.3.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.3.0
[0.2.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.2.0
[0.1.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.1.0
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ RUN make -j$(nproc) libcmt
RUN make -j$(nproc) sys-utils
RUN make -j$(nproc) rollup-http
RUN make install DESTDIR=$(pwd)/_install PREFIX=/usr
ARG TOOLS_TARGZ=machine-emulator-tools.tar.gz
ARG TOOLS_TARGZ=machine-guest-tools.tar.gz
RUN cd _install && tar -czf /work/${TOOLS_TARGZ} *
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ PATCH := 2
LABEL := -test2
VERSION := $(MAJOR).$(MINOR).$(PATCH)$(LABEL)

TOOLS_TARGZ := machine-emulator-tools-v$(VERSION).tar.gz
TOOLS_IMAGE := cartesi/machine-emulator-tools:$(VERSION)
TOOLS_TARGZ := machine-guest-tools-v$(VERSION).tar.gz
TOOLS_IMAGE := cartesi/machine-guest-tools:$(VERSION)
TOOLS_ROOTFS := rootfs-tools-v$(VERSION).ext2
TOOLS_ROOTFS_IMAGE := cartesi/rootfs-tools:$(VERSION)

Expand Down Expand Up @@ -117,8 +117,8 @@ shell: ## Spawn a cross compilation shell with tools Docker image
-e UID=$$(id -u) \
-e GID=$$(id -g) \
-u $$(id -u):$$(id -g) \
-v `pwd`:/work/machine-emulator-tools \
-w /work/machine-emulator-tools \
-v `pwd`:/work/machine-guest-tools \
-w /work/machine-guest-tools \
$(TOOLS_IMAGE)-tools-env /bin/bash

libcmt: ## Compile libcmt
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cartesi Machine Emulator Tools
# Cartesi Machine Guest Tools

The Cartesi Machine Emulator Tools is a repository that contains a set of tools developed for the RISC-V Linux OS. It provides a RISC-V Debian package and a root filesystem for Ubuntu 24.04.
The Cartesi Machine Guest Tools is a repository that contains a set of tools developed for the RISC-V Linux OS. It provides a RISC-V Debian package and a root filesystem for Ubuntu 24.04.

## Getting Started

Expand Down Expand Up @@ -37,7 +37,7 @@ In case you need to patch and develop tools, you can cross compile using Docker
make build
```

This creates the `machine-emulator-tools-$VERSION.tar.gz` archive and the `rootfs-tools-$VERSION.ext2` root filesystem artifacts.
This creates the `machine-guest-tools-$VERSION.tar.gz` archive and the `rootfs-tools-$VERSION.ext2` root filesystem artifacts.
Both should only be use for testing and development purposes, not directly in dapps.

#### Makefile targets
Expand All @@ -53,5 +53,5 @@ Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it in

## License

The machine-emulator-tools repository and all contributions are licensed under
The machine-guest-tools repository and all contributions are licensed under
[APACHE 2.0](https://www.apache.org/licenses/LICENSE-2.0). Please review our [LICENSE](LICENSE) file.
2 changes: 1 addition & 1 deletion fs/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Final image
FROM --platform=linux/riscv64 ubuntu:24.04
ARG TOOLS_TARGZ=machine-emulator-tools.tar.gz
ARG TOOLS_TARGZ=machine-guest-tools.tar.gz
ADD ${TOOLS_TARGZ} /
RUN apt-get update && \
apt-get upgrade -y --no-install-recommends && \
Expand Down
2 changes: 1 addition & 1 deletion package.json.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"name": "machine-emulator-tools",
"name": "cartesi-machine-guest-tools",
"version": "ARG_VERSION"
}
4 changes: 2 additions & 2 deletions rollup-http/echo-dapp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ To install Rust follow the instructions [here](https://www.rust-lang.org/tools/i
This DApp is built during the docker build process:

```shell
$ cd machine-emulator-tools
$ cd machine-guest-tools
$ make
```

## Execution

Utility script `rollup-init` is used to start simultaneously DApp application and Rollup HTTP server (available in `linux/utils` folder of the root `machine-emulator-tools` project).
Utility script `rollup-init` is used to start simultaneously DApp application and Rollup HTTP server (available in `linux/utils` folder of the root `machine-guest-tools` project).

After build copy Dapp and http dispatcher application to the new directory. Create ext2 filesystem image from that directory.

Expand Down
4 changes: 2 additions & 2 deletions rollup-http/rollup-http-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ To install Rust follow the instructions [here](https://www.rust-lang.org/tools/i
This service is built within the docker build step when building all other tools:

```shell
cd machine-emulator-tools
cd machine-guest-tools
make
```

### Build using the libcmt mock version (for development and tests)
First build libcmt mock on host:

```shell
cd machine-emulator-tools/sys-utils/libcmt/
cd machine-guest-tools/sys-utils/libcmt/
make host
```

Expand Down
2 changes: 1 addition & 1 deletion sys-utils/libcmt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ And finally, a couple of utility modules used by the high level API are also exp
- @ref libcmt\_merkle is a sparse merkle tree implementation on top of keccak.
- @ref libcmt\_keccak is the hashing function used extensively by Ethereum.

The header files and a compiled RISC-V version of this library can be found [here](https://github.com/cartesi/machine-emulator-tools/).
The header files and a compiled RISC-V version of this library can be found [here](https://github.com/cartesi/machine-guest-tools/).
We also provide `.pc` (pkg-config) files to facilitate linking.

# mock and testing
Expand Down

0 comments on commit 9518d03

Please sign in to comment.