nuttx/Documentation/components/tools/zipme.rst
Matteo Golin 53fdfa68b9 docs/components/tools: Give tools their own doc pages
All of the tools listed on the original documentation are now given
their own individual doc pages. This makes it much easier to
cross-reference them from other documentation locations (as many are
used in CI/for specific architectures) and it also makes it easier for
users to digest the information.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2026-03-05 18:12:54 +01:00

27 lines
857 B
ReStructuredText

============
``zipme.sh``
============
I use this script to create the nuttx-xx.yy.tar.gz tarballs for
release. It is handy because it also does the kind of clean up
that you need to do to make a clean code release.
It can also PGP sign the final tarballs and create their SHA512 hash.
Any VCS files or directories are excluded from the final tarballs.
Help:
.. code:: console
$ ./tools/zipme.sh -h
USAGE="USAGE: ./tools/zipme.sh [-d|h|v|s] [-b <build]> [-e <exclude>] [-k <key-id>] [<major.minor.patch>]"
Examples:
.. code:: console
$ ./tools/zipme.sh -s 9.0.0
# Create version 9.0.0 tarballs and sign them.
$ ./tools/zipme.sh -s -k XXXXXX 9.0.0
# Same as above but use the key-id XXXXXX to sign the tarballs
$ ./tools/zipme.sh -e "*.swp tmp" 9.0.0
# Create the tarballs but exclude any .swp file and the "tmp" directory.