Skip to content

doc: rouge: add mtools to the requirements for vfat images #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
rshym wants to merge 1 commit into from
Closed

doc: rouge: add mtools to the requirements for vfat images #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/rouge.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,18 @@ Requirements
------------

To do its job `rouge` invokes number of external utilities. Most of
them are available on every system, except Android tools that usually
should be installed separately. There is a list:
them are available on every system with the following exceptions:

- To work with `vfat`, install the `mtools` package.
- To work with Android, install the `simg2img` package.

There is a list of external tools used for the generation of images:

- `dd` - used to copy raw images
- `mkfs.ext4` - creates ext4 FS
- `mkfs.vfat` - creates vfat FS
- `simg2img` - used to unpack Android sparse image files
- `mcopy` - populates vfat images with files
- `mcopy` and `mdd` - to handle vfat images


Invoking `rouge`
Expand Down Expand Up @@ -314,6 +318,7 @@ partitions, where you store kernel, initial ramdisk and so on.

:code:`type` is required. Defines the filesystem type,
currently `ext4` and `vfat` are supported.
You need to install the `mtools` package to work with `vfat`.

:code:`items:` section is optional. It defines :code:`remote:local`
mapping of files that should be presented on newly created
Expand Down