You are viewing a plain text version of this content. The canonical link for it is here.

Posted to notifications@pekko.apache.org by "pjfanning (via GitHub)" <gi...@apache.org> on 2026/10/08 14:19:01 UTC

[PR] docs: fix outdated content and wrong config keys and API names [pekko]

pjfanning opened a new pull request, #3583:
URL: https://github.com/apache/pekko/pull/3583

   ### Motivation
   A review of the docs found statements that are out of date for Pekko 2.0 (JDK 8 advice, removed features described as current, old build tool versions and syntax, deprecated APIs presented as the main approach) and config keys, class names and method names that do not exist and would fail if copied.
   
   ### Modification
   **Outdated for 2.0**
   - `split-brain-resolver.md`: auto-down described as removed, not as an opt-in feature
   - `cluster-usage.md`: `pekko-cluster` script "may be removed in a future release"; explain where `jmxsh-R5.jar` comes from (the script downloads it); JDK 17 JMX link
   - `io-dns.md`: async-dns "may become the default in a future release"
   - `common/binary-compatibility-rules.md`, `common/may-change.md`: removed 1.1.0 / Java 8 wording
   - `additional/deploying.md`: replace the removed `UseCGroupMemoryLimitForHeap` flag with container-support / `MaxRAMPercentage` guidance
   - `additional/packaging.md`: sbt 1.13.0, `com.github.sbt` sbt-native-packager 1.13.0, maven-shade 3.6.2, heading matches content; Gradle snippets moved to `com.gradleup.shadow` 9.6.1 (rewritten because the old Kotlin snippet no longer compiles against Shadow 9 — **not tried in a Gradle build**, reviewers familiar with Shadow please check)
   - `project/immutable.md`: Lombok 1.18.48 (1.18.10 does not run on JDK 16+)
   - `general/configuration.md`: lightbend/config links; JDK 17 REPL banner
   - `dispatchers.md`, `typed/dispatchers.md`: drop "Java 9+" qualifier; JDK 17 javadoc links
   - `multi-jvm-testing.md`, `multi-node-testing.md`: sbt slash syntax, Scala 3 compatible `main`, JDK 17/21 paths
   - `persistence.md`, `persistence-plugins.md`: LevelDB 0.12, document both native and Java-port dependencies
   - `remoting.md`: `Props.create`; `supervision-classic.md`: no Akka version, `whenTerminated`; `testing.md`: Pekko not Akka 2.x
   - `io-udp.md`: drop SecurityManager note; `coordinated-shutdown.md`: drop pre-fork issue link; `distributed-pub-sub.md`: drop dead Activator link
   - `discovery/index.md`: remove the "Migrating from Pekko Management Discovery (before 1.0.0)" section (no such pre-1.0 release existed)
   - `fault-tolerance.md`: Java text matches `Duration.ofMinutes` snippet
   - `typed/cluster-sharding.md`: drop `-2.3` flag from the remove-internal-data example; `typed/actors.md`: correct Java pattern matching versions
   - stream docs: `MaterializedMap`, `flatMap` note and `mapConcat` signatures (`IterableOnce` / `java.lang.Iterable`), stale "stub" notes, SI-2712/Dotty text, `Source.queue` prose rewritten for `BoundedSourceQueue` (deprecated overloads moved to a note), `PubSub.source`/`sink` headings, `TestSink()`/`TestSource()` instead of removed `probe`, `Source.actorRef` completion via `completionMatcher`, `Sink.collection` uses `scala.collection.Factory`, ActorFlow ask timeout is `java.util.concurrent.TimeoutException`, real description for `javaCollectorParallelUnordered`
   
   **Wrong config keys**
   - `persistence-plugins.md`: `auto-start-journals` / `auto-start-snapshot-stores` take config paths
   - `remoting.md`: `pekko.remote.classic.retry-gate-closed-for`; `multi-jvm-testing.md`: `pekko.remote.artery.canonical.port` and a real multi-jvm test name
   - `typed/cluster.md`: `pekko.cluster.failure-detector.implementation-class`, `new Down(address)`
   - `remoting-artery.md`: `pekko.remote.artery.advanced.aeron.aeron-dir`
   - `cluster-client.md`, `cluster-metrics.md`: `pekko.actor.provider`, fully qualified extension class names
   - `typed/cluster-concepts.md`: monitored by up to 9 nodes; `typed/persistence.md`: `stash-capacity` default 4096 and overflow strategy
   - `additional/operations.md`: JMX MBean `pekko:type=Cluster`
   
   **Wrong API names**
   - `ProducerController`, `ShardRegion.CurrentShardRegionState`, `extractShardId`, `BackoffOnStopOptions`/`BackoffOnFailureOptions`, `Replicator.DeleteFailure`/`StoreFailure`, no `RefreshInterval` hint, `org.apache.pekko.actor.typed.ActorSystem`, `pekko-cluster-typed` artifact for singleton, Pekko Projections has its own version, `Compression.inflate`, `RunnableGraph.fromGraph` / `BidiFlow` in stream composition
   
   Each change was checked against the source, `reference.conf` or build files in this repo.
   
   Not included (source changes, can follow separately): the Scaladoc of `RemoveInternalClusterShardingData` still documents `-2.3`, the `Cluster.scala` warning still says "auto-down has been removed in Akka 2.6.0", and the `Sink.collection` Scaladoc still mentions `CanBuildFrom`.
   
   ### Result
   The docs match the 2.0 code, and copied config keys and API names work.
   
   ### Tests
   - Not run - docs only
   
   ### References
   None - found during a review of the docs
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org