ctubbsii commented on code in PR #2162:
URL: https://github.com/apache/zookeeper/pull/2162#discussion_r1588539152


##########
zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md:
##########
@@ -436,7 +436,7 @@ in the unlikely event a recent log has become corrupted). 
This
 can be run as a cron job on the ZooKeeper server machines to
 clean up the logs daily.
 
-    java -cp 
zookeeper.jar:lib/slf4j-api-1.7.30.jar:lib/logback-classic-1.2.10.jar:lib/logback-core-1.2.10.jar:conf
 org.apache.zookeeper.server.PurgeTxnLog <dataDir> <snapDir> -n <count>
+    java -cp 
zookeeper.jar:lib/slf4j-api-2.0.13.jar:lib/logback-classic-1.2.10.jar:lib/logback-core-1.2.10.jar:conf
 org.apache.zookeeper.server.PurgeTxnLog <dataDir> <snapDir> -n <count>

Review Comment:
   A few comments about this particular documentation:
   
   1. You updated the slf4j version here, but not the logback version
   2. The documentation should probably be written to not depend on a specific 
version, so it doesn't need to constantly be updated.
   3. Not related to your change, but people really should stop specifying 
class paths using `-cp`, because it makes it hard to override via environment 
config files, and it can result in very long command-lines (sometimes too big 
for the OS, or for tools like pgrep/pkill). It's better to set the `CLASSPATH` 
environment instead of the command-line argument, and depending on the context, 
to append or prepend to any existing value (just like `$PATH`). For here, for 
the example, it's probably enough to just keep it simple:
   ```suggestion
       CLASSPATH='lib/*:conf' java org.apache.zookeeper.server.PurgeTxnLog 
<dataDir> <snapDir> -n <count>
   ```
   



##########
zookeeper-server/src/test/java/org/apache/zookeeper/test/ReconfigExceptionTest.java:
##########
@@ -48,7 +48,7 @@ public class ReconfigExceptionTest extends ZKTestCase {
     // Use DigestAuthenticationProvider.base64Encode or
     // run ZooKeeper jar with 
org.apache.zookeeper.server.auth.DigestAuthenticationProvider to generate 
password.
     // An example:
-    // java -cp 
zookeeper.jar:lib/slf4j-api-1.7.30.jar:lib/logback-classic-1.2.10.jar:lib/logback-core-1.2.10.jar:conf
+    // java -cp 
zookeeper.jar:lib/slf4j-api-2.0.13.jar:lib/logback-classic-1.2.10.jar:lib/logback-core-1.2.10.jar:conf

Review Comment:
   Again, don't need the specific versions in the example.
   
   ```suggestion
       // CLASSPATH='lib/*:conf' java
   ```



-- 
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-unsubscr...@zookeeper.apache.org

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

Reply via email to