From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id D43BB1F5AD for ; Mon, 13 Apr 2020 11:32:45 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH v2 0/2] rerolled doc updates Date: Mon, 13 Apr 2020 11:32:43 +0000 Message-Id: <20200413113245.9282-1-e@yhbt.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: Thanks to Kyle and Leah for comments. Eric Wong (2): doc: add technical/whyperl doc: start reproducibility document Documentation/reproducibility.txt | 29 +++++ Documentation/technical/whyperl.txt | 170 ++++++++++++++++++++++++++++ 2 files changed, 199 insertions(+) create mode 100644 Documentation/reproducibility.txt create mode 100644 Documentation/technical/whyperl.txt Interdiff against v1: diff --git a/Documentation/reproducibility.txt b/Documentation/reproducibility.txt index 4e56ada4..af3e5366 100644 --- a/Documentation/reproducibility.txt +++ b/Documentation/reproducibility.txt @@ -3,7 +3,7 @@ reproducibility => forkability The ability to fork a project is a checks and balances system for free software projects. Reproducibility is key -to forkability since every mirror is potential fork. +to forkability since every mirror is a potential fork. git makes the code history of projects fully reproducible. public-inbox uses git to make the email history of projects diff --git a/Documentation/technical/whyperl.txt b/Documentation/technical/whyperl.txt index b0a0d16b..11ae7c2a 100644 --- a/Documentation/technical/whyperl.txt +++ b/Documentation/technical/whyperl.txt @@ -11,7 +11,7 @@ Other languages and runtimes may eventually be a possibility for us, and this document can serve as our requirements list for possible replacements. -As always, comments and corrections and additions welcome at +As always, comments, corrections and additions are welcome at . We're not Perl experts, either. Good Things @@ -26,9 +26,9 @@ Good Things have to waste bandwidth or space with giant toolchains or architecture-specific binaries. - Furthermore, Perl documentation is typically installed as - manpages, allowing users to quickly access and learn it - offline. + Furthermore, Perl documentation is typically installed + locally as manpages, allowing users to quickly refer + to documentation as needed. * Scripted, always editable by the end user @@ -48,15 +48,14 @@ Good Things * Predictable performance While Perl is neither fast or memory-efficient, its - performance and memory use are predictable and does not - require GC tuning by the user. + performance and memory use are predictable. public-inbox is developed for (and mostly on) old hardware. Perl was fast enough to power the web of the late 1990s, and any cheap VPS today has more than enough RAM and CPU for handling plain-text email. - Low hardware requirements increases the reach of our software + Low hardware requirements increase the reach of our software to more users, improving centralization resistance. * Compatibility @@ -79,12 +78,12 @@ Good Things GNU/Linux distros and BSD ports. There should be no need to rely on language-specific - package managers such as cpan(1), those systems increase + package managers such as cpan(1). Those systems increase the learning curve for users and systems administrators. * Compactness and terseness - Less code generally means less bugs. We try to avoid the + Less code generally means fewer bugs. We try to avoid the "line noise" stereotype of some Perl codebases, yet still manage to write less code than one would with non-scripting languages. @@ -160,7 +159,7 @@ being used, they're just not interesting. * Lightweight threading While lightweight threading implementations are - convenient, they tend to be significantly heavier than a + convenient, they tend to be significantly heavier than pure event-loop systems (or multi-threaded event-loop systems)