From e0da9c381e361ad61cbfd63c72c59afb93584274 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 8 Nov 2026 13:03:52 +0100 Subject: [PATCH] Updated docs --- docs/history/2026_09_18_Yes_I_am_Angry.md | 2 ++ docs/source/protecting.rst | 6 +++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/history/2026_09_18_Yes_I_am_Angry.md b/docs/history/2026_09_18_Yes_I_am_Angry.md index 699ac182..ae962d09 100644 --- a/docs/history/2026_09_18_Yes_I_am_Angry.md +++ b/docs/history/2026_09_18_Yes_I_am_Angry.md @@ -204,6 +204,8 @@ Those people, are in their own words, "Killing Reticulum" (quote, Lew Palm, "aut And all of those are [void and null](https://reticulum.network/manual/brandolinis.html#void-grants-legal-foundations-of-machine-generated-code), because what they *really* chose is **copyright violation**, and complete disrespect ([as is now becoming tradition](https://reticulum.network/manual/brandolinis.html#licensing-analysis)) for open source development practices, attribution and basic decency. +*(**Important Note From The Future, added November 2026**: When the maintainer of Ratspeak discovered he had made made a mistake in the licensing, he promptly contacted me, and corrected everything within a few hours. As of this update, all the Ratspeak implementations and derivatives are correctly distributed under the Reticulum License.)* + > Underneath the licence choice sits a harder problem, and it is the one this site keeps coming back to: a system can be decentralised in its architecture and completely centralised in who decides things. Oooooh... Tension. Drama. Tell me more, let's have the juicy details, huh? Outrage incoming, I can feel it! Ramp up your audience like a good boy, Leo! diff --git a/docs/source/protecting.rst b/docs/source/protecting.rst index bea4a443..e701cf71 100644 --- a/docs/source/protecting.rst +++ b/docs/source/protecting.rst @@ -284,7 +284,7 @@ For Developers At some point during the ``1.6.x`` release cycle, RNS will move to using the ``required_only`` mode for *non-transport* instances by default. This means that applications will, in most cases, have to request what types of destinations they are interested in receiving announces from. -If your application is using only using the utility primitives included in RNS, or established protocols such as LXMF or LXST, **there is nothing you have to do**. The protocol primitives *themselves* request their required destination types, and this is the general pattern to follow here: +If your application is only using the utility primitives included in RNS, or established protocols such as LXMF or LXST, **there is nothing you have to do**. The protocol primitives *themselves* request their required destination types, and this is the general pattern to follow here: - If an application uses a common protocol or primitive, it is the importable primitive, protocol module, or relevant internal functionality that should request destination type requirements, at the point where they are actually needed. - Higher level application layers should not have to guess at or request destination types, unless it explicitly creates outbound destinations that are not covered by any already-used protocols or primitives. @@ -301,7 +301,7 @@ You do not *have to* explicitly deregister destination type requirements. Reticu RNS.Reticulum.get_instance().unwants_destination_type("my_app.service") -That's really all there is to it. If you already now want to make you application more CPU, memory and battery efficient, you can tell Reticulum to start serving only required destinations to it with only one line of additional code. A full setup of this functionality might look something like: +That's really all there is to it. If you already now want to make you application more CPU, memory and battery efficient, you can tell Reticulum to start serving only required destinations to it with only a few lines of additional code. A full setup of this functionality might look something like: .. code:: python @@ -320,7 +320,7 @@ In addition to the economic incentives created by stamps, Reticulum enforces a s At the most basic level, the ``announce_cap`` mechanism limits the bandwidth any interface will allocate to propagating announces and other network upkeep traffic, and prioritises the local topology. Destinations that rapidly re-announce are down-prioritised in the transmission queue, so attempting to gain reach through announce spam has the exact *opposite* effect. -On top of this, per-destination announce rate control can be configured on any interface, or as instance-wide defaults. Once configured, announces *received* for any one destination will only be re-broadcast to other interfaces at the configured target rate, no matter how often they are received. A grace period allows occasional rate violations, and a configurable penalty extends the interval between propagated announces for destinations that repeatedly exceed their target. +On top of this, per-destination announce rate control can be configured on any interface, or as instance-wide defaults. Once configured, announces *received* for any one destination will only be re-broadcast to other interfaces at the configured target rate, no matter how often they are received. The grace option allows occasional rate violations, and a configurable penalty extends the interval between propagated announces for destinations that repeatedly exceed their target. The final layer protects against bursts of announces for *newly created* destinations. If an interface receives a large influx of announces for previously unknown destinations in a short amount of time, these are held in a bounded queue, while announces for known and established destinations continue to be processed without interruption. After the burst subsides, and an additional waiting period has passed, held announces are released slowly until the queue is cleared.