--- /dev/null
+# public-inbox data flow
+#
+# Note: choose either "delivery tools" OR "git mirroring tools"
+# for a given inboxdir. Combining them for the SAME inboxdir
+# will cause conflicts. Of course, different inboxdirs may
+# choose different means of getting mail into them.
+
+graph { flow: down }
+
+[delivery tools:\n
+ public-inbox-mda\n
+ public-inbox-watch\n
+ public-inbox-learn] -> [inboxdir]
+
+[git mirroring tools:\n
+ grok-pull,\n
+ various scripts
+] -- git (clone|fetch) &&\n
+ public-inbox-index --> [inboxdir]
+
+[inboxdir] ->
+[read-only daemons:\n
+ public-inbox-httpd\n
+ public-inbox-nntpd]
+
+# Copyright 2020 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
--- /dev/null
+# public-inbox data flow
+#
+# Note: choose either "delivery tools" OR "git mirroring tools"
+# for a given inboxdir. Combining them for the SAME inboxdir
+# will cause conflicts. Of course, different inboxdirs may
+# choose different means of getting mail into them.
+
+ +--------------------+
+ | delivery tools: |
+ | public-inbox-mda |
+ | public-inbox-watch |
+ | public-inbox-learn |
+ +--------------------+
+ |
+ |
+ v
++----------------------+ +--------------------+
+| git mirroring tools: | git (clone|fetch) && | |
+| grok-pull, | public-inbox-index | inboxdir |
+| various scripts | ----------------------> | |
++----------------------+ +--------------------+
+ |
+ |
+ v
+ +--------------------+
+ | read-only daemons: |
+ | public-inbox-httpd |
+ | public-inbox-nntpd |
+ +--------------------+
+
+# Copyright 2020 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
# this is "xml" on FreeBSD and maybe some other distros:
XMLSTARLET = xmlstarlet
+# libgraph-easy-perl from Debian, Graph::Easy from CPAN
+GRAPH_EASY = graph-easy
+
# same as pod2text
COLUMNS = 76
touch -r Documentation/standards.perl $@+
mv $@+ $@
+# flow.txt is checked into git since Graph::Easy isn't in many distros
+Documentation/flow.txt : Documentation/flow.ge
+ (sed -ne '1,/^$$/p' <Documentation/flow.ge; \
+ $(GRAPH_EASY) Documentation/flow.ge || \
+ cat Documentation/flow.txt; \
+ echo; \
+ sed -ne '/^# Copyright/,$$p' <Documentation/flow.ge \
+ ) >$@+
+ touch -r Documentation/flow.ge $@+
+ mv $@+ $@
+
NEWS NEWS.atom NEWS.html : $(news_deps)
$(PERL) -I lib -w Documentation/mknews.perl $@ $(RELEASES)
clean-doc:
$(RM_F) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) \
$(mantxt) $(rsync_xdocs) \
- NEWS NEWS.atom NEWS.html Documentation/standards.txt
+ NEWS NEWS.atom NEWS.html Documentation/standards.txt \
+ Documentation/flow.html Documentation/flow.html.gz \
+ Documentation/flow.txt.gz
clean :: clean-doc
$v->{txt} = [ qw(INSTALL README COPYING TODO HACKING) ];
my @dtxt = grep(m!\ADocumentation/[^/]+\.txt\z!, @manifest);
push @dtxt, 'Documentation/standards.txt';
+push @dtxt, 'Documentation/flow.txt';
push @dtxt, @{$v->{txt}};
for my $txt (@dtxt) {
my $html = $txt;