[gentoo-commits] proj/R_overlay:wip/addition_control commit in: doc/rst/

[gentoo-commits] proj/R_overlay:wip/addition_control commit in: doc/rst/

[André Erdmann]

commit:     ddc44b19a1310813ccbf1a533a1884685bd27ce3
Author:     André Erdmann <dywi <AT> mailerd <DOT> de>
AuthorDate: Fri Jul 18 14:53:53 2014 +0000
Commit:     André Erdmann <dywi <AT> mailerd <DOT> de>
CommitDate: Fri Jul 18 14:53:53 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=ddc44b19

doc/rst/usage.rst: document add-policy args

---
 doc/rst/usage.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/doc/rst/usage.rst b/doc/rst/usage.rst
index f841f36..c8ffff9 100644
--- a/doc/rst/usage.rst
+++ b/doc/rst/usage.rst
@@ -514,6 +514,51 @@ to know in detail what *roverlay* does before running it.
 --no-incremental
    Force recreation of existing ebuilds
 
+--package-revbump <package>
+   Enforces a revbump of ``<package>``.
+
+   ``<package>`` can be a package name (``${PN}``), a package name with
+   version (``${P}`` or ``${PF}``), optionally prefixed with its category
+   (``${CATEGORY}/${PN}``, ``${CATEGORY}/${PF}`` etc.).
+   Wildcard characters (``*``, ``?``) are supported, too.
+
+   Incremental overlay creation only.
+   A revbump only occurs if the package exists in the overlay and is queued
+   for overlay creation.
+
+--package-force-replace <package>
+   Enforces a recreation of ``<package>``.
+
+   See ``--package-revbump``.
+
+--package-replace-only <package>
+   Forbids ebuild creation for ``<package>`` if it does not exist in the
+   overlay already.
+
+   Useful in conjunction with ``--package-revbump``, ``--package-replace``,
+   ``--package-list`` or ``--ebuild-list``:
+
+   .. code:: text
+
+      roverlay --package-revbump "sci-R/*" --package-replace-only "*"
+
+
+--package-list <file>
+   A file that lists packages that should be revbumped.
+
+   Same as specifying ``--package-replace-only <pkg> --package-revbump <pkg>``
+   for each line in the file.
+
+   The file can also be in extended format. (TODO: NOT DOCUMENTED)
+
+
+--ebuild-list <file>
+   Same as ``--package-list``, but expects a file that lists ebuild files.
+
+   Useful in combination with ``grep -rl <expr> <overlay>`` scripts.
+
+   The file can also be in extended format. (TODO: NOT DOCUMENTED)
+
 --no-revbump
    Disable revbump checks in incremental overlay creation mode
 

[gentoo-commits] proj/R_overlay:master commit in: doc/rst/

[André Erdmann]

commit:     ddc44b19a1310813ccbf1a533a1884685bd27ce3
Author:     André Erdmann <dywi <AT> mailerd <DOT> de>
AuthorDate: Fri Jul 18 14:53:53 2014 +0000
Commit:     André Erdmann <dywi <AT> mailerd <DOT> de>
CommitDate: Fri Jul 18 14:53:53 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=ddc44b19

doc/rst/usage.rst: document add-policy args

---
 doc/rst/usage.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/doc/rst/usage.rst b/doc/rst/usage.rst
index f841f36..c8ffff9 100644
--- a/doc/rst/usage.rst
+++ b/doc/rst/usage.rst
@@ -514,6 +514,51 @@ to know in detail what *roverlay* does before running it.
 --no-incremental
    Force recreation of existing ebuilds
 
+--package-revbump <package>
+   Enforces a revbump of ``<package>``.
+
+   ``<package>`` can be a package name (``${PN}``), a package name with
+   version (``${P}`` or ``${PF}``), optionally prefixed with its category
+   (``${CATEGORY}/${PN}``, ``${CATEGORY}/${PF}`` etc.).
+   Wildcard characters (``*``, ``?``) are supported, too.
+
+   Incremental overlay creation only.
+   A revbump only occurs if the package exists in the overlay and is queued
+   for overlay creation.
+
+--package-force-replace <package>
+   Enforces a recreation of ``<package>``.
+
+   See ``--package-revbump``.
+
+--package-replace-only <package>
+   Forbids ebuild creation for ``<package>`` if it does not exist in the
+   overlay already.
+
+   Useful in conjunction with ``--package-revbump``, ``--package-replace``,
+   ``--package-list`` or ``--ebuild-list``:
+
+   .. code:: text
+
+      roverlay --package-revbump "sci-R/*" --package-replace-only "*"
+
+
+--package-list <file>
+   A file that lists packages that should be revbumped.
+
+   Same as specifying ``--package-replace-only <pkg> --package-revbump <pkg>``
+   for each line in the file.
+
+   The file can also be in extended format. (TODO: NOT DOCUMENTED)
+
+
+--ebuild-list <file>
+   Same as ``--package-list``, but expects a file that lists ebuild files.
+
+   Useful in combination with ``grep -rl <expr> <overlay>`` scripts.
+
+   The file can also be in extended format. (TODO: NOT DOCUMENTED)
+
 --no-revbump
    Disable revbump checks in incremental overlay creation mode