Commit d3f921d0 authored by Jason Hiser's avatar Jason Hiser 🚜

Merge branch 'master' of git.zephyr-software.com:opensrc/irdb-cookbook-examples

parents 3cd056da 41b19ed1
Pipeline #2716 passed with stages
in 16 minutes and 30 seconds
......@@ -39,15 +39,19 @@ This transform is only useful for demonstration and testing.
### Docker (Recommended)
Setup docker on your Linux-based host. See the [Docker homepage](https://docs.docker.com/install/linux/docker-ce/ubuntu/) for additional details on how to achieve this.
The easiest way to test these transforms is to use Zephyr's docker registry:
```
docker run git.zephyr-software.com:4567/opensrc/irdb-sdk/zipr-dev <args>
docker run -it git.zephyr-software.com:4567/opensrc/irdb-sdk/zipr-dev <args>
```
The recommended value for `<args>` is `help`. Follow the directions in the help to log in to the docker image. Once logged in,
you can `cd irdb-cookbook-examples` and run `scons`.
At this point, you should have the cookbook installed and built, along with the `pszr` infrascture in your `$PATH`.
### Manually (Not recommended)
......@@ -55,7 +59,7 @@ To build these examples by manually, one must:
1. Download the IRDB SDK and set the IRDB\_SDK environment variable appropriately. The IRDB SDK can be found [here](https://git.zephyr-software.com/opensrc/irdb-sdk).
1. Download the IRDB libraries, set IRDB\_LIBS environment variable appropriately and install `pszr`. Documentation on obtaining the these components not yet
available, however, they are available via this reduced docker image: `git.zephyr-software.com:4567/opensrc/irdb-sdk/zipr-dev`
available, however, they are available via this reduced docker image: `git.zephyr-software.com:4567/opensrc/irdb-sdk/zipr-bin`
1. Install g++ and scons.
1. Type `scons` to perform the build.
1. Set the `PSPATH` environment variable to include `$COOKBOOK_HOME/plugins_install`, e.g. in `bash`:
......@@ -68,10 +72,15 @@ available, however, they are available via this reduced docker image: `git.zephy
To use these transforms, one should:
1. Install and run `pszr` with the proper step enabled, e.g.:
1. Run `pszr` with the proper step enabled. For example, to enable the stack stamping transform, one should:
```
/path/to/pszr --step stack_stamp /bin/ls ./ls.stamped
pszr --step stack_stamp /bin/ls ./ls.stamped
```
This command should create a new ELF binary file called `ls.stamped` that's functionally equivilent to `/bin/ls`, but with stack stamping applied to return addresses.
Transformation steps can be combined and are applied in the order specified. See `pszr --help` for additional usage information.
Documentation on obtaining, building and running pszr without docker is not yet available.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment