public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
* [gentoo-commits] proj/g-sorcery:master commit in: docs/
@ 2013-09-20  0:07 Jauhien Piatlicki
  0 siblings, 0 replies; 5+ messages in thread
From: Jauhien Piatlicki @ 2013-09-20  0:07 UTC (permalink / raw
  To: gentoo-commits

commit:     d6896d1dac321ddd19a96be72148a4e27c2567e1
Author:     Jauhien Piatlicki (jauhien) <piatlicki <AT> gmail <DOT> com>
AuthorDate: Fri Sep 20 00:07:45 2013 +0000
Commit:     Jauhien Piatlicki <piatlicki <AT> gmail <DOT> com>
CommitDate: Fri Sep 20 00:07:45 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/g-sorcery.git;a=commit;h=d6896d1d

docs: fixes

---
 docs/Makefile                 |  2 +-
 docs/gs-ctan.8                |  4 ++--
 docs/gs-ctan.8.rst            |  4 ++--
 docs/gs-elpa.8                |  4 ++--
 docs/gs-elpa.8.rst            |  4 ++--
 docs/{gs-ctan.8 => gs-pypi.8} | 46 +++++++++++++++++++++----------------------
 docs/gs-pypi.8.rst            |  4 ++--
 7 files changed, 34 insertions(+), 34 deletions(-)

diff --git a/docs/Makefile b/docs/Makefile
index b876790..cba7bc8 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,7 +1,7 @@
 HTML_SOURCES=developer_instructions
 HTML_DOCS=$(HTML_SOURCES:=.html)
 
-MAN_SOURCES=g-sorcery g-sorcery.cfg gs-elpa gs-ctan
+MAN_SOURCES=g-sorcery g-sorcery.cfg gs-elpa gs-pypi gs-ctan
 MANS=$(MAN_SOURCES:=.8)
 
 RST2HTML=rst2html.py

diff --git a/docs/gs-ctan.8 b/docs/gs-ctan.8
index 23c93b2..8c456be 100644
--- a/docs/gs-ctan.8
+++ b/docs/gs-ctan.8
@@ -52,8 +52,8 @@ There are two ways of using \fBgs\-ctan\fP:
 .IP \(bu 2
 use it with \fBlayman\fP
 .sp
-In this case all you need to do is install \fBlayman\-9999\fP, \fBg\-sorcery\fP
-and \fBgs\-ctan\fP. Then you should just run \fIlayman \-L\fP as
+In this case all you need to do is install \fBlayman\-9999\fP and \fBg\-sorcery\fP.
+Then you should just run \fIlayman \-L\fP as
 root and find an overlay you want. Type of overlay will be
 displayed as \fIg\-sorcery\fP. Then you add this overlay as
 usual. It\(aqs all you need to do and it\(aqs the recommended way of

diff --git a/docs/gs-ctan.8.rst b/docs/gs-ctan.8.rst
index 578b519..348617e 100644
--- a/docs/gs-ctan.8.rst
+++ b/docs/gs-ctan.8.rst
@@ -38,8 +38,8 @@ There are two ways of using **gs-ctan**:
 
     * use it with **layman**
 
-      In this case all you need to do is install **layman-9999**, **g-sorcery**
-      and **gs-ctan**. Then you should just run `layman -L` as
+      In this case all you need to do is install **layman-9999** and **g-sorcery**.
+      Then you should just run `layman -L` as
       root and find an overlay you want. Type of overlay will be
       displayed as *g-sorcery*. Then you add this overlay as
       usual. It's all you need to do and it's the recommended way of

diff --git a/docs/gs-elpa.8 b/docs/gs-elpa.8
index a1ba281..cd71794 100644
--- a/docs/gs-elpa.8
+++ b/docs/gs-elpa.8
@@ -53,8 +53,8 @@ There are two ways of using \fBgs\-elpa\fP:
 .IP \(bu 2
 use it with \fBlayman\fP
 .sp
-In this case all you need to do is install \fBlayman\-9999\fP, \fBg\-sorcery\fP
-and \fBgs\-elpa\fP. Then you should just run \fIlayman \-L\fP as
+In this case all you need to do is install \fBlayman\-9999\fP and \fBg\-sorcery\fP.
+Then you should just run \fIlayman \-L\fP as
 root and find an overlay you want. Type of overlay will be
 displayed as \fIg\-sorcery\fP. Then you add this overlay as
 usual. It\(aqs all you need to do and it\(aqs the recommended way of

diff --git a/docs/gs-elpa.8.rst b/docs/gs-elpa.8.rst
index 7c718fa..008c30e 100644
--- a/docs/gs-elpa.8.rst
+++ b/docs/gs-elpa.8.rst
@@ -39,8 +39,8 @@ There are two ways of using **gs-elpa**:
 
     * use it with **layman**
 
-      In this case all you need to do is install **layman-9999**, **g-sorcery**
-      and **gs-elpa**. Then you should just run `layman -L` as
+      In this case all you need to do is install **layman-9999** and **g-sorcery**.
+      Then you should just run `layman -L` as
       root and find an overlay you want. Type of overlay will be
       displayed as *g-sorcery*. Then you add this overlay as
       usual. It's all you need to do and it's the recommended way of

diff --git a/docs/gs-ctan.8 b/docs/gs-pypi.8
similarity index 71%
copy from docs/gs-ctan.8
copy to docs/gs-pypi.8
index 23c93b2..633de7d 100644
--- a/docs/gs-ctan.8
+++ b/docs/gs-pypi.8
@@ -1,8 +1,8 @@
 .\" Man page generated from reStructuredText.
 .
-.TH GS-CTAN 8 "2013-08-04" "0.1" "g-sorcery"
+.TH GS-PYPI 8 "2013-08-04" "0.1" "g-sorcery"
 .SH NAME
-gs-ctan \- manage overlays for CTAN repository
+gs-pypi \- manage overlays for PYPI repository
 .
 .nr rst2man-indent-level 0
 .
@@ -32,37 +32,37 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .SH SYNOPSIS
 .sp
-\fBgs\-ctan\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBsync\fP
+\fBgs\-pypi\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBsync\fP
 .sp
-\fBgs\-ctan\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBlist\fP
+\fBgs\-pypi\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBlist\fP
 .sp
-\fBgs\-ctan\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\fP \fIPACKAGE\fP
+\fBgs\-pypi\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\fP \fIPACKAGE\fP
 .sp
-\fBgs\-ctan\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBinstall\fP \fIPACKAGE\fP
+\fBgs\-pypi\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBinstall\fP \fIPACKAGE\fP
 .sp
-\fBgs\-ctan\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\-tree\fP [\fB\-d\fP]
+\fBgs\-pypi\fP \fB\-o\fP \fIOVERLAY\fP [\fB\-r\fP \fIREPO\fP] \fBgenerate\-tree\fP [\fB\-d\fP]
 .SH DESCRIPTION
 .sp
-\fBgs\-ctan\fP is an ebuild generator for CTAN TEXLIVE repository.
+\fBgs\-pypi\fP is an ebuild generator for PYPI PYTHON repository.
 .sp
-There are two ways of using \fBgs\-ctan\fP:
+There are two ways of using \fBgs\-pypi\fP:
 .INDENT 0.0
 .INDENT 3.5
 .INDENT 0.0
 .IP \(bu 2
 use it with \fBlayman\fP
 .sp
-In this case all you need to do is install \fBlayman\-9999\fP, \fBg\-sorcery\fP
-and \fBgs\-ctan\fP. Then you should just run \fIlayman \-L\fP as
+In this case all you need to do is install \fBlayman\-9999\fP and \fBg\-sorcery\fP.
+Then you should just run \fIlayman \-L\fP as
 root and find an overlay you want. Type of overlay will be
 displayed as \fIg\-sorcery\fP. Then you add this overlay as
 usual. It\(aqs all you need to do and it\(aqs the recommended way of
-using \fBgs\-ctan\fP.
+using \fBgs\-pypi\fP.
 .IP \(bu 2
 use it as stand\-alone tool
 .sp
 In this case you should create an overlay (see \fBportage\fP documentation), sync it and populate
-it with one or more ebuilds. Then ebuilds could be installed by emerge or by \fBgs\-ctan\fP tool.
+it with one or more ebuilds. Then ebuilds could be installed by emerge or by \fBgs\-pypi\fP tool.
 .UNINDENT
 .UNINDENT
 .UNINDENT
@@ -99,38 +99,38 @@ are no entries for them in Manifest files.
 .SH FILES
 .INDENT 0.0
 .TP
-.B \fB/etc/g\-sorcery/gs\-ctan.json\fP
+.B \fB/etc/g\-sorcery/gs\-pypi.json\fP
 Backend config.
 .TP
-.B \fB/etc/layman/overlays/gs\-ctan\-overlays.xml\fP
+.B \fB/etc/layman/overlays/gs\-pypi\-overlays.xml\fP
 List of available repositories.
 .UNINDENT
 .SH EXAMPLES
 .INDENT 0.0
 .TP
-.B Using gs\-ctan with layman
+.B Using gs\-pypi with layman
 Execute
 .sp
 \fBlayman \-L\fP
 .sp
-If you see there a \fBctan\fP overlay then anything should work.
+If you see there a \fBpypi\fP overlay then anything should work.
 .sp
-\fBlayman \-a ctan\fP
+\fBlayman \-a pypi\fP
 .sp
 Emerge any package from it using \fBemerge\fP.
 .TP
 .B Generating user ebuilds in user overlay
 Create new user overlay. Run
 .sp
-\fBgs\-ctan \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r ctan\fP \fBsync\fP
+\fBgs\-pypi \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r ctan\fP \fBsync\fP
 .sp
 List packages:
 .sp
-\fBgs\-ctan \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r ctan\fP \fBlist\fP
+\fBgs\-pypi \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r ctan\fP \fBlist\fP
 .sp
 Install any package you want:
 .sp
-\fBgs\-ctan \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r ctan\fP \fBinstall\fP \fIPACKAGE\fP
+\fBgs\-pypi \-o\fP \fIOVERLAY_DIRECTORY\fP \fB\-r ctan\fP \fBinstall\fP \fIPACKAGE\fP
 .sp
 Note, that if you call \fBgenerate\-tree\fP command your overlay
 will be wiped and overlay tree for a given repository will be generated. Be careful!
@@ -138,11 +138,11 @@ will be wiped and overlay tree for a given repository will be generated. Be care
 .SH NOTES
 .INDENT 0.0
 .IP 1. 3
-At the moment the only package mangler \fBgs\-ctan\fP supports is \fBportage\fP.
+At the moment the only package mangler \fBgs\-pypi\fP supports is \fBportage\fP.
 .UNINDENT
 .SH SEE ALSO
 .sp
-\fBgs\-pypi\fP(8), \fBgs\-elpa\fP(8), \fBg\-sorcery.cfg\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
+\fBgs\-elpa\fP(8), \fBgs\-ctan\fP(8), \fBg\-sorcery.cfg\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
 .SH AUTHOR
 Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
 and mentorship by Rafael Martins. Lots of help and improvements

diff --git a/docs/gs-pypi.8.rst b/docs/gs-pypi.8.rst
index 560a94c..d5c7c07 100644
--- a/docs/gs-pypi.8.rst
+++ b/docs/gs-pypi.8.rst
@@ -38,8 +38,8 @@ There are two ways of using **gs-pypi**:
 
     * use it with **layman**
 
-      In this case all you need to do is install **layman-9999**, **g-sorcery**
-      and **gs-pypi**. Then you should just run `layman -L` as
+      In this case all you need to do is install **layman-9999** and **g-sorcery**.
+      Then you should just run `layman -L` as
       root and find an overlay you want. Type of overlay will be
       displayed as *g-sorcery*. Then you add this overlay as
       usual. It's all you need to do and it's the recommended way of


^ permalink raw reply related	[flat|nested] 5+ messages in thread
* [gentoo-commits] proj/g-sorcery:master commit in: docs/
@ 2013-09-20 14:13 Jauhien Piatlicki
  0 siblings, 0 replies; 5+ messages in thread
From: Jauhien Piatlicki @ 2013-09-20 14:13 UTC (permalink / raw
  To: gentoo-commits

commit:     194ae823c3879e7a6431a944624db567697c16c6
Author:     Jauhien Piatlicki (jauhien) <piatlicki <AT> gmail <DOT> com>
AuthorDate: Fri Sep 20 14:13:29 2013 +0000
Commit:     Jauhien Piatlicki <piatlicki <AT> gmail <DOT> com>
CommitDate: Fri Sep 20 14:13:29 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/g-sorcery.git;a=commit;h=194ae823

developer instructions: fix typo

---
 docs/developer_instructions.html | 4 ++--
 docs/developer_instructions.rst  | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/developer_instructions.html b/docs/developer_instructions.html
index b8857ce..a9798cb 100644
--- a/docs/developer_instructions.html
+++ b/docs/developer_instructions.html
@@ -790,8 +790,8 @@ that will distinguish different entries of a tag.</p>
 </li>
 </ul>
 </div>
-<div class="section" id="data-dictinonary-format">
-<h2>Data dictinonary format</h2>
+<div class="section" id="data-dictionary-format">
+<h2>Data dictionary format</h2>
 <p>The part of ebuild data used for metadata generation should have data dictionary format
 also defined in g_sorcery.metadata.</p>
 <p>Keys correspond to tags from a schema with the same name.

diff --git a/docs/developer_instructions.rst b/docs/developer_instructions.rst
index 706dd83..b54adfa 100644
--- a/docs/developer_instructions.rst
+++ b/docs/developer_instructions.rst
@@ -468,7 +468,7 @@ Entry is a dictionary. Dictionary keys are:
 * **subtags**
    List of subtags.
 
-Data dictinonary format
+Data dictionary format
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 The part of ebuild data used for metadata generation should have data dictionary format


^ permalink raw reply related	[flat|nested] 5+ messages in thread
* [gentoo-commits] proj/g-sorcery:master commit in: docs/
@ 2013-09-20 14:11 Jauhien Piatlicki
  0 siblings, 0 replies; 5+ messages in thread
From: Jauhien Piatlicki @ 2013-09-20 14:11 UTC (permalink / raw
  To: gentoo-commits

commit:     9d43430df60ee21b8937662f5ffaffe8f02212f8
Author:     Jauhien Piatlicki (jauhien) <piatlicki <AT> gmail <DOT> com>
AuthorDate: Fri Sep 20 14:11:25 2013 +0000
Commit:     Jauhien Piatlicki <piatlicki <AT> gmail <DOT> com>
CommitDate: Fri Sep 20 14:11:25 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/g-sorcery.git;a=commit;h=9d43430d

note about gs-db-tool

---
 docs/developer_instructions.html | 1 +
 docs/developer_instructions.rst  | 2 ++
 2 files changed, 3 insertions(+)

diff --git a/docs/developer_instructions.html b/docs/developer_instructions.html
index a09d1b8..b8857ce 100644
--- a/docs/developer_instructions.html
+++ b/docs/developer_instructions.html
@@ -945,6 +945,7 @@ generator, two ebuild generators, eclass and metadata generators.</p>
 <p>Also you should write an executable that calls g-sorcery and some configs.</p>
 <p>To have better understanding you can look at gs-elpa, gs-ctan and gs-pypi backends available
 in g-sorcery repository. Also available tests could be usefull.</p>
+<p>Note that there is a tool for editing generated database named <strong>gs-db-tool</strong>.</p>
 </div>
 </div>
 </body>

diff --git a/docs/developer_instructions.rst b/docs/developer_instructions.rst
index 6c67538..706dd83 100644
--- a/docs/developer_instructions.rst
+++ b/docs/developer_instructions.rst
@@ -636,3 +636,5 @@ Also you should write an executable that calls g-sorcery and some configs.
 
 To have better understanding you can look at gs-elpa, gs-ctan and gs-pypi backends available
 in g-sorcery repository. Also available tests could be usefull.
+
+Note that there is a tool for editing generated database named **gs-db-tool**.


^ permalink raw reply related	[flat|nested] 5+ messages in thread
* [gentoo-commits] proj/g-sorcery:master commit in: docs/
@ 2013-09-20  0:03 Jauhien Piatlicki
  0 siblings, 0 replies; 5+ messages in thread
From: Jauhien Piatlicki @ 2013-09-20  0:03 UTC (permalink / raw
  To: gentoo-commits

commit:     93eaf0205b13d4f2ee59ab1f5806e22fa18ba05b
Author:     Jauhien Piatlicki (jauhien) <piatlicki <AT> gmail <DOT> com>
AuthorDate: Fri Sep 20 00:03:21 2013 +0000
Commit:     Jauhien Piatlicki <piatlicki <AT> gmail <DOT> com>
CommitDate: Fri Sep 20 00:03:21 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/g-sorcery.git;a=commit;h=93eaf020

docs/gs-pypi: man page added

---
 docs/g-sorcery.8                      |  2 +-
 docs/g-sorcery.8.rst                  |  2 +-
 docs/g-sorcery.cfg.8                  |  2 +-
 docs/g-sorcery.cfg.8.rst              |  2 +-
 docs/gs-ctan.8                        |  4 +--
 docs/gs-ctan.8.rst                    |  8 +++---
 docs/gs-elpa.8                        |  2 +-
 docs/gs-elpa.8.rst                    |  2 +-
 docs/{gs-ctan.8.rst => gs-pypi.8.rst} | 48 +++++++++++++++++------------------
 9 files changed, 36 insertions(+), 36 deletions(-)

diff --git a/docs/g-sorcery.8 b/docs/g-sorcery.8
index c810d57..1122fde 100644
--- a/docs/g-sorcery.8
+++ b/docs/g-sorcery.8
@@ -127,7 +127,7 @@ At the moment the only package mangler \fBg\-sorcery\fP supports is \fBportage\f
 .UNINDENT
 .SH SEE ALSO
 .sp
-\fBg\-sorcery.cfg\fP(8), \fBgs\-elpa\fP(8), \fBgs\-ctan\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
+\fBg\-sorcery.cfg\fP(8), \fBgs\-elpa\fP(8), \fBgs\-pypi\fP(8), \fBgs\-ctan\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
 .SH AUTHOR
 Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
 and mentorship by Rafael Martins. Lots of help and improvements

diff --git a/docs/g-sorcery.8.rst b/docs/g-sorcery.8.rst
index 72f6338..121b571 100644
--- a/docs/g-sorcery.8.rst
+++ b/docs/g-sorcery.8.rst
@@ -112,4 +112,4 @@ NOTES
 SEE ALSO
 ========
 
-**g-sorcery.cfg**\(8), **gs-elpa**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**g-sorcery.cfg**\(8), **gs-elpa**\(8), **gs-pypi**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)

diff --git a/docs/g-sorcery.cfg.8 b/docs/g-sorcery.cfg.8
index bc55811..0f11180 100644
--- a/docs/g-sorcery.cfg.8
+++ b/docs/g-sorcery.cfg.8
@@ -63,7 +63,7 @@ marmalade_packages = clojure\-mode clojurescript\-mode
 .UNINDENT
 .SH SEE ALSO
 .sp
-\fBg\-sorcery\fP(8), \fBgs\-elpa\fP(8), \fBgs\-ctan\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
+\fBg\-sorcery\fP(8), \fBgs\-elpa\fP(8), \fBgs\-pypi\fP(8), \fBgs\-ctan\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
 .SH AUTHOR
 Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
 and mentorship by Rafael Martins. Lots of help and improvements

diff --git a/docs/g-sorcery.cfg.8.rst b/docs/g-sorcery.cfg.8.rst
index 2a3b18a..50a732c 100644
--- a/docs/g-sorcery.cfg.8.rst
+++ b/docs/g-sorcery.cfg.8.rst
@@ -56,4 +56,4 @@ EXAMPLE
 SEE ALSO
 ========
 
-**g-sorcery**\(8), **gs-elpa**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**g-sorcery**\(8), **gs-elpa**\(8), **gs-pypi**\(8), **gs-ctan**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)

diff --git a/docs/gs-ctan.8 b/docs/gs-ctan.8
index 1cbe225..23c93b2 100644
--- a/docs/gs-ctan.8
+++ b/docs/gs-ctan.8
@@ -2,7 +2,7 @@
 .
 .TH GS-CTAN 8 "2013-08-04" "0.1" "g-sorcery"
 .SH NAME
-gs-ctan \- manage overlays for ELPA repositories
+gs-ctan \- manage overlays for CTAN repository
 .
 .nr rst2man-indent-level 0
 .
@@ -142,7 +142,7 @@ At the moment the only package mangler \fBgs\-ctan\fP supports is \fBportage\fP.
 .UNINDENT
 .SH SEE ALSO
 .sp
-\fBgs\-elpa\fP(8), \fBg\-sorcery.cfg\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
+\fBgs\-pypi\fP(8), \fBgs\-elpa\fP(8), \fBg\-sorcery.cfg\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
 .SH AUTHOR
 Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
 and mentorship by Rafael Martins. Lots of help and improvements

diff --git a/docs/gs-ctan.8.rst b/docs/gs-ctan.8.rst
index 68a749d..578b519 100644
--- a/docs/gs-ctan.8.rst
+++ b/docs/gs-ctan.8.rst
@@ -2,9 +2,9 @@
 gs-ctan
 =======
 
--------------------------------------
-manage overlays for ELPA repositories
--------------------------------------
+-----------------------------------
+manage overlays for CTAN repository
+-----------------------------------
 
 :Author: Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
 	 and mentorship by Rafael Martins. Lots of help and improvements
@@ -127,4 +127,4 @@ NOTES
 SEE ALSO
 ========
 
-**gs-elpa**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**gs-pypi**\(8), **gs-elpa**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)

diff --git a/docs/gs-elpa.8 b/docs/gs-elpa.8
index 2a3dfde..a1ba281 100644
--- a/docs/gs-elpa.8
+++ b/docs/gs-elpa.8
@@ -154,7 +154,7 @@ recommended way of using gs\-elpa is using it with layman. Even doing so you sho
 gnu\-elpa repository: \fBlayman \-a gnu\-elpa\fP.
 .SH SEE ALSO
 .sp
-\fBgs\-ctan\fP(8), \fBg\-sorcery.cfg\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
+\fBgs\-pypi\fP(8), \fBgs\-ctan\fP(8), \fBg\-sorcery.cfg\fP(8), \fBportage\fP(5), \fBemerge\fP(1), \fBlayman\fP(8)
 .SH AUTHOR
 Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
 and mentorship by Rafael Martins. Lots of help and improvements

diff --git a/docs/gs-elpa.8.rst b/docs/gs-elpa.8.rst
index 1104ef2..7c718fa 100644
--- a/docs/gs-elpa.8.rst
+++ b/docs/gs-elpa.8.rst
@@ -141,4 +141,4 @@ gnu-elpa repository: **layman -a gnu-elpa**.
 SEE ALSO
 ========
 
-**gs-ctan**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**gs-pypi**\(8), **gs-ctan**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)

diff --git a/docs/gs-ctan.8.rst b/docs/gs-pypi.8.rst
similarity index 64%
copy from docs/gs-ctan.8.rst
copy to docs/gs-pypi.8.rst
index 68a749d..560a94c 100644
--- a/docs/gs-ctan.8.rst
+++ b/docs/gs-pypi.8.rst
@@ -1,10 +1,10 @@
 =======
-gs-ctan
+gs-pypi
 =======
 
--------------------------------------
-manage overlays for ELPA repositories
--------------------------------------
+-----------------------------------
+manage overlays for PYPI repository
+-----------------------------------
 
 :Author: Written by Jauhien Piatlicki <piatlicki@gmail.com>. GSoC idea
 	 and mentorship by Rafael Martins. Lots of help and improvements
@@ -19,36 +19,36 @@ manage overlays for ELPA repositories
 SYNOPSIS
 ========
 
-**gs-ctan** **-o** *OVERLAY* [**-r** *REPO*] **sync**
+**gs-pypi** **-o** *OVERLAY* [**-r** *REPO*] **sync**
 
-**gs-ctan** **-o** *OVERLAY* [**-r** *REPO*] **list**
+**gs-pypi** **-o** *OVERLAY* [**-r** *REPO*] **list**
 
-**gs-ctan** **-o** *OVERLAY* [**-r** *REPO*] **generate** *PACKAGE*
+**gs-pypi** **-o** *OVERLAY* [**-r** *REPO*] **generate** *PACKAGE*
 
-**gs-ctan** **-o** *OVERLAY* [**-r** *REPO*] **install** *PACKAGE*
+**gs-pypi** **-o** *OVERLAY* [**-r** *REPO*] **install** *PACKAGE*
 
-**gs-ctan** **-o** *OVERLAY* [**-r** *REPO*] **generate-tree** [**-d**]
+**gs-pypi** **-o** *OVERLAY* [**-r** *REPO*] **generate-tree** [**-d**]
 
 DESCRIPTION
 ===========
 
-**gs-ctan** is an ebuild generator for CTAN TEXLIVE repository.
+**gs-pypi** is an ebuild generator for PYPI PYTHON repository.
 
-There are two ways of using **gs-ctan**:
+There are two ways of using **gs-pypi**:
 
     * use it with **layman**
 
       In this case all you need to do is install **layman-9999**, **g-sorcery**
-      and **gs-ctan**. Then you should just run `layman -L` as
+      and **gs-pypi**. Then you should just run `layman -L` as
       root and find an overlay you want. Type of overlay will be
       displayed as *g-sorcery*. Then you add this overlay as
       usual. It's all you need to do and it's the recommended way of
-      using **gs-ctan**.
+      using **gs-pypi**.
       
     * use it as stand-alone tool
 
       In this case you should create an overlay (see **portage** documentation), sync it and populate
-      it with one or more ebuilds. Then ebuilds could be installed by emerge or by **gs-ctan** tool.
+      it with one or more ebuilds. Then ebuilds could be installed by emerge or by **gs-pypi** tool.
 
 
 OPTIONS
@@ -83,38 +83,38 @@ COMMANDS
 
 FILES
 =====
-**/etc/g-sorcery/gs-ctan.json**
+**/etc/g-sorcery/gs-pypi.json**
     Backend config.
 
-**/etc/layman/overlays/gs-ctan-overlays.xml**
+**/etc/layman/overlays/gs-pypi-overlays.xml**
     List of available repositories.
 
 EXAMPLES
 ========
 
-Using gs-ctan with layman
+Using gs-pypi with layman
     Execute
 
     **layman -L**
 
-    If you see there a **ctan** overlay then anything should work.
+    If you see there a **pypi** overlay then anything should work.
 
-    **layman -a ctan**
+    **layman -a pypi**
 
     Emerge any package from it using **emerge**.
 
 Generating user ebuilds in user overlay
     Create new user overlay. Run
 
-    **gs-ctan -o** *OVERLAY_DIRECTORY* **-r ctan** **sync**
+    **gs-pypi -o** *OVERLAY_DIRECTORY* **-r ctan** **sync**
 
     List packages:
 
-    **gs-ctan -o** *OVERLAY_DIRECTORY* **-r ctan** **list**
+    **gs-pypi -o** *OVERLAY_DIRECTORY* **-r ctan** **list**
 
     Install any package you want:
 
-    **gs-ctan -o** *OVERLAY_DIRECTORY* **-r ctan** **install** *PACKAGE*
+    **gs-pypi -o** *OVERLAY_DIRECTORY* **-r ctan** **install** *PACKAGE*
 
     Note, that if you call **generate-tree** command your overlay
     will be wiped and overlay tree for a given repository will be generated. Be careful!
@@ -122,9 +122,9 @@ Generating user ebuilds in user overlay
 NOTES
 =====
 
-1. At the moment the only package mangler **gs-ctan** supports is **portage**.
+1. At the moment the only package mangler **gs-pypi** supports is **portage**.
 
 SEE ALSO
 ========
 
-**gs-elpa**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)
+**gs-elpa**\(8), **gs-ctan**\(8), **g-sorcery.cfg**\(8), **portage**\(5), **emerge**\(1), **layman**\(8)


^ permalink raw reply related	[flat|nested] 5+ messages in thread
* [gentoo-commits] proj/g-sorcery:master commit in: docs/
@ 2013-08-06 20:26 Jauhien Piatlicki
  0 siblings, 0 replies; 5+ messages in thread
From: Jauhien Piatlicki @ 2013-08-06 20:26 UTC (permalink / raw
  To: gentoo-commits

commit:     f6bfc7287febfb8a640530ab852daf6285087a53
Author:     Jauhien Piatlicki (jauhien) <piatlicki <AT> gmail <DOT> com>
AuthorDate: Tue Aug  6 20:27:12 2013 +0000
Commit:     Jauhien Piatlicki <piatlicki <AT> gmail <DOT> com>
CommitDate: Tue Aug  6 20:27:12 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/g-sorcery.git;a=commit;h=f6bfc728

developer_instructions: a link to already developed backends

---
 docs/developer_instructions.html | 1 +
 docs/developer_instructions.rst  | 2 ++
 2 files changed, 3 insertions(+)

diff --git a/docs/developer_instructions.html b/docs/developer_instructions.html
index db574e6..4c506af 100644
--- a/docs/developer_instructions.html
+++ b/docs/developer_instructions.html
@@ -940,6 +940,7 @@ that quacks like this class.</p>
 <p>Before doing it you should have defined classes you pass to it as parameters. They should be database
 generator, two ebuild generators, eclass and metadata generators.</p>
 <p>Also you should write an executable that calls g-sorcery and some configs.</p>
+<p>To have better understanding you can look at gs-elpa and gs-ctan backends available in g-sorcery repository.</p>
 </div>
 </div>
 </body>

diff --git a/docs/developer_instructions.rst b/docs/developer_instructions.rst
index cd95a2f..f561027 100644
--- a/docs/developer_instructions.rst
+++ b/docs/developer_instructions.rst
@@ -638,3 +638,5 @@ Before doing it you should have defined classes you pass to it as parameters. Th
 generator, two ebuild generators, eclass and metadata generators.
 
 Also you should write an executable that calls g-sorcery and some configs.
+
+To have better understanding you can look at gs-elpa and gs-ctan backends available in g-sorcery repository.


^ permalink raw reply related	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2013-09-20 14:14 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-09-20  0:07 [gentoo-commits] proj/g-sorcery:master commit in: docs/ Jauhien Piatlicki
  -- strict thread matches above, loose matches on Subject: below --
2013-09-20 14:13 Jauhien Piatlicki
2013-09-20 14:11 Jauhien Piatlicki
2013-09-20  0:03 Jauhien Piatlicki
2013-08-06 20:26 Jauhien Piatlicki

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox