Skip to content

Latest commit

 

History

History
35 lines (29 loc) · 1.49 KB

README.md

File metadata and controls

35 lines (29 loc) · 1.49 KB

crates.io crates.io CircleCI CI

Form

A library for splitting apart a large file with multiple modules into the idiomatic rust directory structure, intended for use with svd2rust. Creates a lib.rs as well as a subdirectory structure in the target directory. It does NOT create the cargo project or the cargo manifest file.

It's advised (but not necessary) to use rustfmt afterwards, or you can pass -f to use prettyplease.

Usage:

Arguments:

    -i, --input FILE    OPTIONAL: input file to read, defaults to stdin
    -o, --outdir DIR    set output directory
    -h, --help          print this help menu
    -v, --version       print version information
    -f                  format files with `prettyplease`

Intended usage (using svd2rust 0.12.1 and before):

svd2rust -i FOO.svd | form -o ~/private/code/form/test/src

Usage with svd2rust 0.13.0 and later can be found in svd2rust's documentation.

Advanced usage:

cargo install form
export RUST_LOG=form=debug
export RUST_BACKTRACE=1
form -i ~/private/code/form/resources/full-lib.rs -o ~/private/code/form/test/src