An open API service indexing awesome lists of open source software.

https://github.com/sifis-home/manifest

Produce an application manifest file containing SIFIS API information extracted from a determined binary
https://github.com/sifis-home/manifest

manifest-producer

Last synced: about 2 months ago
JSON representation

Produce an application manifest file containing SIFIS API information extracted from a determined binary

Awesome Lists containing this project

README

        

# Manifest Producer

This tool produces an application manifest file containing
SIFIS-Home API information extracted from a determined binary.

A *manifest* is a JSON file consisting of application information and
API hazards.

## Build

To build both `lib` and `manifest` code:

```
cargo build
```

## Run tests

Verify whether all tests pass with the command:

```
cargo test
```

## Produce docs

Generate the final documentation with the command:

```
cargo doc --open --no-deps
```

Remove the `--no-deps` option to build documentation for each dependency.

## View options

To view the list of `manifest` options, run:

```
cargo run -- --help
```

## Usage

To write a *manifest* on `stdout` run:

```
cargo run -- -b /path/to/your/binary -l your-sifis-home-library-version
```

To write a *manifest* on a file run:

```
cargo run -- -b /path/to/your/binary -l your-sifis-home-library-version -o /path/to/your/manifest/file
```

The option `your-sifis-home-library-version` can assume only two kind of values:
- The version of the Sifis-Home library used in your binary i.e. `0.1`
- The path to the file containing the Sifis-Home library version APIs used in
your binary starting with the prefix `file://`

## License

Released under the [MIT License](LICENSE).

## Acknowledgements

This software has been developed in the scope of the H2020 project SIFIS-Home with GA n. 952652.