rust2rpm/README.md
Fabio Valentini f579129792
docs: add docs for rust2rpm + config formats in man-friendly format
Remove documentation for rust2rpm.conf file format from the README. The
custom INI-based format is deprecated in favor of rust2rpm.toml. Both
formats are documented, including a migration guide from the old to the
new format.

The included build script shows how to build man pages from the asciidoc
source files.
2023-10-09 22:18:40 +02:00

31 lines
863 B
Markdown

# rust2rpm
rust2rpm is a tool for automatically generating RPM spec files for Rust crates.
## Testing
### tox
Invoking `tox` will automatically run the test suite for all supported versions
of Python. `tox -- -vv` can be used to show very verbose output from pytest.
### pytest
The tests can also be run manually in a virtualenv:
```shell
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt pytest
PYTHONPATH=. python3 -m pytest -vv
deactivate
```
The `UPDATE_FIXTURES=1` environment variable can be set to rewrite the test
fixtures for expected (!) changes in the spec file generator.
## Documentation
Documentation for rust2rpm and its configuration file formats is available in
the `docs/` directory in AsciiDoc format. The included build script shows how
to build man pages from the AsciiDoc source files with asciidoctor.