Skip to content

Commit

Permalink
irmin-pack-tools: Move opam file & fix stanzas
Browse files Browse the repository at this point in the history
  • Loading branch information
clecat committed Sep 6, 2023
1 parent 18ee9ac commit f61a15c
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 17 deletions.
10 changes: 5 additions & 5 deletions src/irmin-pack-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Currently, there are the following tools:
This tool prints a control file in a human readable manner (json), allowing to fetch important informations easily.
It is fairly straightforward:
```shell
$ dune exec -- irmin-ppcf Upper|Volume <path-to-control-file>
$ dune exec -- src/irmin-pack-tools/ppcf/ppcf.exe Upper|Volume <path-to-control-file>
```
The first argument, either `Upper` or `Volume` tells the tool if you are trying to read the control file of a normal store, or from a volume store.
The second one is the path to the control file (e.g. `output/root/store.control`)
Expand All @@ -22,7 +22,7 @@ It will typically give the following json output:
```
Which can be further improved using the tool `jq`:
```shell
$ dune exec -- irmin-ppcf Upper|Volume <path-to-control-file> | jq
$ dune exec -- src/irmin-pack-tools/ppcf/ppcf.exe Upper|Volume <path-to-control-file> | jq
```
Will give:
```json
Expand Down Expand Up @@ -52,7 +52,7 @@ Will give:
This tool prints the informations stored in the index of a store in a human readable manner (json), allowing to fetch important informations easily.
It is fairly straightforward:
```shell
$ dune exec -- irmin-ppidx Irmin|Tezos <path-to-store>
$ dune exec -- src/irmin-pack-tools/ppidx/ppidx.exe Irmin|Tezos <path-to-store>
```
The first argument is the type of store, either:
- Irmin, which implies that we will use the SHA256 hash, and will print it has an hexadecimal representation of the hash.
Expand All @@ -69,7 +69,7 @@ It will typically give the following json output for Irmin, with one line per en
```
Which can be further improved using the tool `jq`:
```shell
$ dune exec -- irmin-ppidx <path-to-store> > index
$ dune exec -- src/irmin-pack-tools/ppidx/ppidx.exe <path-to-store> > index
$ jq -s '.' -- index
```
Will give:
Expand Down Expand Up @@ -107,7 +107,7 @@ TODO
This tool is a graphical UI, meant to allow the user to figure out rapidly the shape of a commit, giving him informations on it's content.
It can be launched using the following command:
```shell
$ dune exec -- irmin-tezos-explorer-gui <path-to-store> <path-to-ttf-font> <commit>
$ dune exec -- src/irmin-pack-tools/tezos_explorer_gui/tezos_explorer_gui.exe <path-to-store> <path-to-ttf-font> <commit>
```

The first argument is the path to the root of the store (e.g. `output/root/`).
Expand Down
File renamed without changes.
2 changes: 0 additions & 2 deletions src/irmin-pack-tools/ppcf/dune
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
(executable
(public_name irmin-ppcf)
(package irmin-pack-tools)
(name ppcf)
(modules ppcf)
(libraries irmin-pack irmin-pack.unix cmdliner)
Expand Down
2 changes: 0 additions & 2 deletions src/irmin-pack-tools/ppidx/dune
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
(executable
(public_name irmin-ppidx)
(package irmin-pack-tools)
(name ppidx)
(modules ppidx)
(libraries irmin-pack irmin-pack.unix irmin-tezos cmdliner)
Expand Down
6 changes: 2 additions & 4 deletions src/irmin-pack-tools/tezos_explorer/dune
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
(executable
(public_name irmin-tezos-explorer)
(package irmin-pack-tools)
(name main)
(modules main parse show files ring import)
(name tezos_explorer)
(modules tezos_explorer parse show files ring import)
(libraries
irmin-pack
irmin-pack.unix
Expand Down
File renamed without changes.
6 changes: 2 additions & 4 deletions src/irmin-pack-tools/tezos_explorer_gui/dune
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
(executable
(public_name irmin-tezos-explorer-gui)
(package irmin-pack-tools)
(name main)
(modules main context load_tree tree sdl_util layout loading)
(name tezos_explorer_gui)
(modules tezos_explorer_gui context load_tree tree sdl_util layout loading)
(libraries prettree tsdl tsdl-ttf fmt irmin_pack irmin_tezos cmdliner)
(preprocess
(pps ppx_repr)))

0 comments on commit f61a15c

Please sign in to comment.