summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorMichał Górny <mgorny@gentoo.org>2018-02-10 12:29:39 +0100
committerMichał Górny <mgorny@gentoo.org>2018-02-10 12:29:39 +0100
commit36e60e5d5b1ef17ad53a890dc6f572333711df70 (patch)
tree266bf4a935a24af35a639091ad5815695f5b1ed0 /README.rst
parent383020f4fa10b949ed7a8abdd95723a85919f98e (diff)
downloadgemato-36e60e5d5b1ef17ad53a890dc6f572333711df70.tar.gz
README: document the two other main commands
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 56a934f..5d684fa 100644
--- a/README.rst
+++ b/README.rst
@@ -30,6 +30,31 @@ and check the specified directory recursively. If a subdirectory
of the Manifest tree is specified, only the specified leaf is checked.
+Creating new Manifest tree
+--------------------------
+Creating a new Manifest tree can be accomplished using the ``gemato
+create`` command against the top directory of the new Manifest tree::
+
+ gemato create -p ebuild /var/db/repos/gentoo
+
+Note that for the ``create`` command you always need to specify either
+a profile (via ``-p``) or at least a hash set (via ``-H``).
+
+
+Updating existing Manifests
+---------------------------
+The ``gemato update`` command is provided to update an existing Manifest
+tree::
+
+ gemato update -p ebuild /var/db/repos/gentoo
+
+Alike ``create``, ``update`` also requires specifying a profile (``-p``)
+or a hash set (``-H``). The command locates the appropriate top-level
+Manifest and updates the specified directory recursively.
+If a subdirectory of the Manifest tree is specified, the entries
+for the specified leaf and respective Manifest files are updated.
+
+
Requirements
============
gemato is written in Python and compatible with implementations