Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
.. _release-4.0.0:

4.0.0
=====

*Release date: TBD*

.. rubric:: Changes

.. rubric:: Contributors

`Martin Schwan <https://github.com/mschwan-phytec>`__

.. _release-3.0.1:

3.0.1
Expand Down
35 changes: 34 additions & 1 deletion doc/layout-config-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,23 @@ Disk Options
particular, this can be used to flash devices with raw disk images that
already contain a partition table and associated partitions.

.. _alignment:

``alignment`` (string)
Alignment type of all partitions to be written to the device. This specifies
how the partitions' start and end sector are placed.

The following alignment types are currently supported:

- ``minimal``/``minimum``: Align partitions to the minimum hardware
requirements.
- ``optimal``/``optimum``: Align partitions on the device for optimal
performance.

The default alignment type is ``optimal``.

Available since: :ref:`release-4.0.0`

Clean Data
..........

Expand All @@ -71,6 +88,11 @@ following options:
``size`` (integer/string)
Size of the cleaned space.

It is possible set a string with a unit after the size number, e.g. ``12kiB``
or ``34MB``. Possible units are the same as specified by `GNU parted's unit
command <https://www.gnu.org/software/parted/manual/parted.html#unit>`_. When
no unit is specified, the default is sectors.

Raw Data
........

Expand Down Expand Up @@ -138,6 +160,11 @@ options:
``size`` (integer/string)
The size of the partition.

It is possible set a string with a unit after the size number, e.g. ``12kiB``
or ``34MB``. Possible units are the same as specified by `GNU parted's unit
command <https://www.gnu.org/software/parted/manual/parted.html#unit>`_. When
no unit is specified, the default is sectors.

``expand`` (boolean)
Expands the partition to fill the rest of the flash device. If multiple
partitions are specified to be expanding, then the space is equally divided
Expand All @@ -148,7 +175,8 @@ options:

``block-size`` (integer/string)
Set the partition size to a multiple of the specified value. The default is
2 sectors, which is almost always equal to 1KiB.
the device's alignment grain size. This depends on the selected alignment
type. See :ref:`alignment` for more information.

``flags`` (sequence)
Set flags for this partition. Flags to be enabled should be provided as a
Expand Down Expand Up @@ -247,6 +275,11 @@ contained partitions of an MTD. Each entry may contain the following options:
zero. The size must also be a multiple of the underlying device's erase block
size, if not using an expanding partition.

It is possible set a string with a unit after the size number, e.g. ``12kiB``
or ``34MB``. Possible units are the same as specified by `GNU parted's unit
command <https://www.gnu.org/software/parted/manual/parted.html#unit>`_. When
no unit is specified, the default is sectors.

Available since: :ref:`release-3.0.0`

``offset`` (integer/string)
Expand Down
2 changes: 1 addition & 1 deletion meson.build
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
project(
'partup', 'c',
version : '3.0.1',
version : '4.0.0',
license : 'GPL-3.0-or-later',
default_options : [
'c_std=c99',
Expand Down
Loading
Loading