From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.2 required=3.0 tests=ALL_TRUSTED,BAYES_00, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF shortcircuit=no autolearn=ham autolearn_force=no version=3.4.6 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id C3C2D1F629 for ; Wed, 15 Feb 2023 08:01:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=80x24.org; s=selector1; t=1676448072; bh=c0oCnwUGFHruFhF0PKYPtuleCjiNAR0aosUnLk5F7zE=; h=From:To:Subject:Date:In-Reply-To:References:From; b=4fk7ZnNcyg2fDkVM8L4xS9uWcUfPHn8CX3+OLdLWANSdCGanW/aNfsH7jrOIdsNSl HgNbgnfq7tAB3eLq5ZJkTiOZ/t6ekkx1L1uEz1Iys0DDhyZob1kJARLnbW5lnbK3Kg j329WuUWqIyj0u1KscY1ZSLQ1nHdrHHWdMkfxg94= From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 2/4] doc: flow: update with newer tools, note forkability Date: Wed, 15 Feb 2023 08:01:10 +0000 Message-Id: <20230215080112.1740815-3-e@80x24.org> In-Reply-To: <20230215080112.1740815-1-e@80x24.org> References: <20230215080112.1740815-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: public-inbox-{clone,fetch,netd} are all relatively new developments which we can document, here. We'll also update the generator Makefile snippet since there may be more Graph::Easy-based docs coming. --- Documentation/flow.ge | 13 +++++++++---- Documentation/flow.txt | 18 ++++++++++++------ Documentation/include.mk | 15 +++++++++------ 3 files changed, 30 insertions(+), 16 deletions(-) diff --git a/Documentation/flow.ge b/Documentation/flow.ge index 4308989a..5ad92fec 100644 --- a/Documentation/flow.ge +++ b/Documentation/flow.ge @@ -1,9 +1,11 @@ # 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. +# for a given inboxdir. Using them simultaneously for the +# SAME inboxdir will cause conflicts. Of course, different +# inboxdirs may choose different means of getting mail into them. +# You may fork any inbox by starting with "git mirroring tools", +# and switching to "delivery tools". graph { flow: down } @@ -13,6 +15,8 @@ graph { flow: down } public-inbox-learn] -> [inboxdir] [git mirroring tools:\n + public-inbox-clone,\n + public-inbox-fetch,\n grok-pull,\n various scripts ] -- git (clone|fetch) &&\n @@ -20,9 +24,10 @@ graph { flow: down } [inboxdir] -> [read-only daemons:\n + public-inbox-netd\n public-inbox-httpd\n public-inbox-imapd\n public-inbox-nntpd] -# Copyright 2020-2021 all contributors +# Copyright all contributors # License: AGPL-3.0+ diff --git a/Documentation/flow.txt b/Documentation/flow.txt index 1116a917..ed2dd80b 100644 --- a/Documentation/flow.txt +++ b/Documentation/flow.txt @@ -1,9 +1,11 @@ # 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. +# for a given inboxdir. Using them simultaneously for the +# SAME inboxdir will cause conflicts. Of course, different +# inboxdirs may choose different means of getting mail into them. +# You may fork any inbox by starting with "git mirroring tools", +# and switching to "delivery tools". +--------------------+ | delivery tools: | @@ -15,8 +17,10 @@ | v +----------------------+ +--------------------+ -| git mirroring tools: | git (clone|fetch) && | | -| grok-pull, | public-inbox-index | inboxdir | +| git mirroring tools: | | | +| public-inbox-clone, | | | +| public-inbox-fetch, | git (clone|fetch) && | inboxdir | +| grok-pull, | public-inbox-index | | | various scripts | ----------------------> | | +----------------------+ +--------------------+ | @@ -24,10 +28,12 @@ v +--------------------+ | read-only daemons: | + | public-inbox-netd | | public-inbox-httpd | | public-inbox-imapd | | public-inbox-nntpd | +--------------------+ -# Copyright 2020-2021 all contributors +# Copyright all contributors # License: AGPL-3.0+ +# This file was generated from flow.txt using Graph::Easy diff --git a/Documentation/include.mk b/Documentation/include.mk index bfbc495f..4395e4f4 100644 --- a/Documentation/include.mk +++ b/Documentation/include.mk @@ -1,4 +1,4 @@ -# Copyright (C) 2013-2021 all contributors +# Copyright (C) all contributors # License: AGPL-3.0+ all:: @@ -67,13 +67,16 @@ Documentation/standards.txt : Documentation/standards.perl # flow.txt is checked into git since Graph::Easy isn't in many distros Documentation/flow.txt : Documentation/flow.ge - (sed -ne '1,/^$$/p' $@+ - touch -r Documentation/flow.ge $@+ + echo >>$@+ \ + '# This file was generated from $(@F) using Graph::Easy' + touch -r $< $@+ mv $@+ $@ Documentation/lei-q.pod : lib/PublicInbox/Search.pm Documentation/common.perl