aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 00:47:35 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 00:47:35 +0000
commit5a59baf6f8273c97533f03ceaa67d4e0ecca2d0b (patch)
tree6c71b2bc0a41fd6c23f65e6600bdfe0b78255c9b
parentea49bc09f8941d11bcc734859426d6553fbdcd24 (diff)
downloadpaludis-5a59baf6f8273c97533f03ceaa67d4e0ecca2d0b.tar.gz
paludis-5a59baf6f8273c97533f03ceaa67d4e0ecca2d0b.tar.xz
Fetchers, syncers documented
-rw-r--r--doc/configuration/Makefile.am72
-rw-r--r--doc/configuration/index.html.part7
-rw-r--r--doc/index.html.part.in6
3 files changed, 77 insertions, 8 deletions
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index a70a689..7044665 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -5,24 +5,90 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \
toplinks.html.part \
footer.html.part \
index.html \
- hooks.html
+ hooks.html \
+ syncers.html.part \
+ syncers.html \
+ fetchers.html.part \
+ fetchers.html \
+ synclist \
+ fetchlist
MAINTAINERCLEANFILES = Makefile.in
EXTRA_DIST = \
toplinks.html.part.in \
index.html.part \
- hooks.html.part
+ hooks.html.part \
+ syncers.html.part.in \
+ fetchers.html.part.in
paludisconfigurationhtmldir = $(htmldir)/configuration
paludisconfigurationhtml_DATA = \
index.html \
- hooks.html
+ hooks.html \
+ syncers.html \
+ fetchers.html
index.html : header.html.part $(srcdir)/index.html.part footer.html.part
cat header.html.part $(srcdir)/index.html.part footer.html.part > $@
+synclist :
+ find $(top_srcdir)/paludis/syncers $(top_builddir)/paludis/syncers -type f \
+ | while read a ; do \
+ basename $$a ; \
+ done | sort -u | \
+ while read a ; do \
+ if echo $$a | grep '.in$$' >/dev/null ; then \
+ : ; \
+ elif ! echo $$a | grep '^do' >/dev/null ; then \
+ : ; \
+ else \
+ echo "<strong>$$a</strong>" | sed -e 's/>do/>/' ; \
+ if test -f $(top_builddir)/paludis/syncers/$$a ; then \
+ env PALUDIS_EBUILD_DIR="$(top_srcdir)/paludis/repositories/e/ebuild" \
+ bash $(top_builddir)/paludis/syncers/$$a --help || exit 1 ; \
+ else \
+ env PALUDIS_EBUILD_DIR="$(top_srcdir)/paludis/repositories/e/ebuild" \
+ bash $(top_srcdir)/paludis/syncers/$$a --help || exit 1 ; \
+ fi ; \
+ echo ; \
+ fi ; \
+ done > synclist
+
+fetchlist :
+ find $(top_srcdir)/paludis/fetchers $(top_builddir)/paludis/fetchers -type f \
+ | while read a ; do \
+ basename $$a ; \
+ done | sort -u | \
+ while read a ; do \
+ if echo $$a | grep '.in$$' >/dev/null ; then \
+ : ; \
+ elif ! echo $$a | grep '^do' >/dev/null ; then \
+ : ; \
+ else \
+ echo "<li>$$a</li>" | sed -e 's/>do/>/' ; \
+ fi ; \
+ done > fetchlist
+
+syncers.html.part : $(srcdir)/syncers.html.part.in synclist
+ sed \
+ -e '/###SYNCERS###/r synclist' \
+ -e 's,###SYNCERS###,,g' \
+ < $(srcdir)/syncers.html.part.in > syncers.html.part
+
+fetchers.html.part : $(srcdir)/fetchers.html.part.in fetchlist
+ sed \
+ -e '/###FETCHERS###/r fetchlist' \
+ -e 's,###FETCHERS###,,g' \
+ < $(srcdir)/fetchers.html.part.in > fetchers.html.part
+
+syncers.html : header.html.part syncers.html.part footer.html.part
+ cat header.html.part syncers.html.part footer.html.part > $@
+
+fetchers.html : header.html.part fetchers.html.part footer.html.part
+ cat header.html.part fetchers.html.part footer.html.part > $@
+
hooks.html : header.html.part $(srcdir)/hooks.html.part footer.html.part
cat header.html.part $(srcdir)/hooks.html.part footer.html.part > $@
diff --git a/doc/configuration/index.html.part b/doc/configuration/index.html.part
index 216c705..d87c025 100644
--- a/doc/configuration/index.html.part
+++ b/doc/configuration/index.html.part
@@ -6,9 +6,10 @@
<ul>
<li><a href="hooks.html">Hooks</a>: how to execute additional code at well defined points.</li>
- <li><a href="syncers.html">Syncers</a>: how to implement custom sync protocols, and replace built-in syncers.</li>
- <li><a href="fetchers.html">Fetchers</a>: how to implement custom URI fetching protocols, and replace built-in
- fetchers.</li>
+ <li><a href="syncers.html">Syncers</a>: options for built-in syncers, and how to implement custom sync protocols
+ or override built-in syncers.</li>
+ <li><a href="fetchers.html">Fetchers</a>: options for built-in fetchers, and how to implement custom URI fetching
+ protocols or replace built-in fetchers.</li>
<li><a href="envvars.html">Environment variables</a> that Paludis itself recognises.</li>
</ul>
diff --git a/doc/index.html.part.in b/doc/index.html.part.in
index f7c746c..d12e3ab 100644
--- a/doc/index.html.part.in
+++ b/doc/index.html.part.in
@@ -37,8 +37,10 @@
<ul>
<li><a href="configuration/hooks.html">Hooks</a>: how to execute additional code at well defined points.</li>
- <li><a href="configuration/syncers.html">Syncers</a>: how to implement custom sync protocols, and replace built-in syncers.</li>
- <li><a href="configuration/fetchers.html">Fetchers</a>: how to implement custom URI fetching protocols, and replace built-in
+ <li><a href="configuration/syncers.html">Syncers</a>: options for built-in syncers, and how to implement custom sync protocols
+ or override built-in syncers.</li>
+ <li><a href="configuration/fetchers.html">Fetchers</a>: options for built-in fetchers, and how to implement custom URI fetching
+ protocols or replace built-in fetchers.</li>
fetchers.</li>
<li><a href="configuration/envvars.html">Environment variables</a> that Paludis itself recognises.</li>
</ul>