From 4e7a895938a92ac29b7b923e958fd256f6eef6ad Mon Sep 17 00:00:00 2001 From: Fabio Erculiani Date: Sat, 19 Nov 2011 18:01:45 +0100 Subject: [PATCH] [eit] add "eit graph", "eit revgraph" man pages --- server/doc/mansrc/eit-graph.1.txt | 67 ++++++++++++++++++++++++++++ server/doc/mansrc/eit-revgraph.1.txt | 67 ++++++++++++++++++++++++++++ server/doc/mansrc/eit.1.txt | 4 +- server/eit/commands/graph.py | 13 ++++++ server/eit/commands/revgraph.py | 13 ++++++ 5 files changed, 162 insertions(+), 2 deletions(-) create mode 100644 server/doc/mansrc/eit-graph.1.txt create mode 100644 server/doc/mansrc/eit-revgraph.1.txt diff --git a/server/doc/mansrc/eit-graph.1.txt b/server/doc/mansrc/eit-graph.1.txt new file mode 100644 index 000000000..10d81f852 --- /dev/null +++ b/server/doc/mansrc/eit-graph.1.txt @@ -0,0 +1,67 @@ +eit-graph(1) +============ +:man source: eit {eitversion} +:man manual: eit {eitversion} + + +NAME +---- +eit-graph - show dependency graph for packages + + +SYNOPSIS +-------- +eit graph [-h] [--in ] [--complete] [--quiet] + [ ...] + + +INTRODUCTION +------------ +Show direct dependency graph (printed as tree, actually) for given +package dependencies. +For a reverse dependency graph, please see *eit revgraph*. + + + +OPTIONS +------- +"eit graph" supports the following options which alters its behaviour. + + +POSITIONAL ARGUMENTS +~~~~~~~~~~~~~~~~~~~~ +**:: + package name + +OPTIONAL ARGUMENTS +~~~~~~~~~~~~~~~~~~ +*--help*:: + show this help message and exit + +*--in*=:: + search packages in given repository + +*--complete*:: + show system packages, build deps, circular deps + +*-q*:: + quiet output, for scripting purposes + + + +AUTHORS +------- +Eit has been accidentally prototyped during a rainy Sunday by Fabio +Erculiani who was looking for innovative ways of handling package +bumps in Sabayon Entropy repositories. +A few months later, Eit saw the light. + + +REPORTING BUGS +-------------- +Report bugs to https://bugs.sabayon.org or directly to the author at +lxnay@sabayon.org. + +SEE ALSO +-------- + eit(1), eit-revgraph(1) diff --git a/server/doc/mansrc/eit-revgraph.1.txt b/server/doc/mansrc/eit-revgraph.1.txt new file mode 100644 index 000000000..b0dd127b1 --- /dev/null +++ b/server/doc/mansrc/eit-revgraph.1.txt @@ -0,0 +1,67 @@ +eit-revgraph(1) +=============== +:man source: eit {eitversion} +:man manual: eit {eitversion} + + +NAME +---- +eit-revgraph - show reverse dependency graph for packages + + +SYNOPSIS +-------- +eit revgraph [-h] [--in ] [--complete] [--quiet] + [ ...] + + +INTRODUCTION +------------ +Show reverse dependency graph (printed as tree, actually) for given +package dependencies. +For a direct dependency graph, please see *eit graph*. + + + +OPTIONS +------- +"eit revgraph" supports the following options which alters its behaviour. + + +POSITIONAL ARGUMENTS +~~~~~~~~~~~~~~~~~~~~ +**:: + package name + +OPTIONAL ARGUMENTS +~~~~~~~~~~~~~~~~~~ +*--help*:: + show this help message and exit + +*--in*=:: + search packages in given repository + +*--complete*:: + show system packages, build deps, circular deps + +*-q*:: + quiet output, for scripting purposes + + + +AUTHORS +------- +Eit has been accidentally prototyped during a rainy Sunday by Fabio +Erculiani who was looking for innovative ways of handling package +bumps in Sabayon Entropy repositories. +A few months later, Eit saw the light. + + +REPORTING BUGS +-------------- +Report bugs to https://bugs.sabayon.org or directly to the author at +lxnay@sabayon.org. + +SEE ALSO +-------- + eit(1), eit-graph(1) diff --git a/server/doc/mansrc/eit.1.txt b/server/doc/mansrc/eit.1.txt index a56266616..23b354127 100644 --- a/server/doc/mansrc/eit.1.txt +++ b/server/doc/mansrc/eit.1.txt @@ -162,6 +162,6 @@ lxnay@sabayon.org. SEE ALSO -------- eit-add(1), eit-branch(1), eit-bump(1), eit-checkout(1), eit-cleanup(1) - eit-commit(1), eit-cp(1), eit-files(1), eit-log(1), eit-mv(1) - eit-notice(1), eit-own(1), eit-repack(1) + eit-commit(1), eit-cp(1), eit-files(1), eit-graph(1), eit-log(1) + eit-mv(1), eit-notice(1), eit-own(1), eit-repack(1), eit-revgraph(1) diff --git a/server/eit/commands/graph.py b/server/eit/commands/graph.py index f68239aa3..bbbb45cd6 100644 --- a/server/eit/commands/graph.py +++ b/server/eit/commands/graph.py @@ -57,6 +57,19 @@ class EitGraph(EitCommand): return parser + INTRODUCTION = """\ +Show direct dependency graph (printed as tree, actually) for given +package dependencies. +For a reverse dependency graph, please see *eit revgraph*. +""" + SEE_ALSO = "eit-revgraph(1)" + + def man(self): + """ + Overridden from EitCommand. + """ + return self._man() + def parse(self): parser = self._get_parser() try: diff --git a/server/eit/commands/revgraph.py b/server/eit/commands/revgraph.py index 2686855e1..ce7825e53 100644 --- a/server/eit/commands/revgraph.py +++ b/server/eit/commands/revgraph.py @@ -58,6 +58,19 @@ class EitRevgraph(EitCommand): return parser + INTRODUCTION = """\ +Show reverse dependency graph (printed as tree, actually) for given +package dependencies. +For a direct dependency graph, please see *eit graph*. +""" + SEE_ALSO = "eit-graph(1)" + + def man(self): + """ + Overridden from EitCommand. + """ + return self._man() + def parse(self): """ Overridden from EitCommand """ parser = self._get_parser()