Remove some TODOs (#6488)

* Remove stale TODOs

* Ban TODO markers from markdown

* Scrub all TODOs from ci/ and book/

ci/README.md

@@ -20,7 +20,7 @@ Create a new Azure-based "queue=default" agent by running the following command:
 ```
 $ az vm create \
    --resource-group ci \
-   --name XXX \
+   --name XYZ \
    --image boilerplate \
    --admin-username $(whoami) \
    --ssh-key-value ~/.ssh/id_rsa.pub
@@ -42,11 +42,11 @@ Creating a "queue=cuda" agent follows the same process but additionally:
 1. When ready, ssh into the instance and start a root shell with `sudo -i`.  Then
    prepare it for deallocation by running:
    `waagent -deprovision+user; cd /etc; ln -s ../run/systemd/resolve/stub-resolv.conf resolv.conf`
-1. Run `az vm deallocate --resource-group ci --name XXX`
-1. Run `az vm generalize --resource-group ci --name XXX`
-1. Run `az image create --resource-group ci --source XXX --name boilerplate`
+1. Run `az vm deallocate --resource-group ci --name XYZ`
+1. Run `az vm generalize --resource-group ci --name XYZ`
+1. Run `az image create --resource-group ci --source XYZ --name boilerplate`
 1. Goto the `ci` resource group in the Azure portal and remove all resources
-   with the XXX name in them
+   with the XYZ name in them
 
 ## Reference
 
@@ -95,7 +95,7 @@ VM Instances in each group is manually adjusted.
 Each Instance group has its own disk image, `ci-default-vX` and
 `ci-cuda-vY`, where *X* and *Y* are incremented each time the image is changed.
 
-The process to update a disk image is as follows (TODO: make this less manual):
+The manual process to update a disk image is as follows:
 
 1. Create a new VM Instance using the disk image to modify.
 2. Once the VM boots, ssh to it and modify the disk as desired.

ci/buildkite.yml

@@ -29,12 +29,6 @@ steps:
   - command: ". ci/rust-version.sh; ci/docker-run.sh $$rust_nightly_docker_image ci/test-coverage.sh"
     name: "coverage"
     timeout_in_minutes: 40
-  # TODO: Fix and re-enable test-large-network.sh
-  # - command: "ci/test-large-network.sh || true"
-  #   name: "large-network [ignored]"
-  #   timeout_in_minutes: 20
-  #   agents:
-  #     - "queue=large"
   - wait
   - trigger: "solana-secondary"
     branches: "!pull/*"

ci/nits.sh

@@ -57,7 +57,7 @@ declare useGithubIssueInsteadOf=(
   #'TODO'  # TODO: Uncomment this line to disable TODOs
 )
 
-if _ git --no-pager grep -n --max-depth=0 "${useGithubIssueInsteadOf[@]/#/-e }" -- '*.rs' '*.sh'; then
+if _ git --no-pager grep -n --max-depth=0 "${useGithubIssueInsteadOf[@]/#/-e }" -- '*.rs' '*.sh' '*.md'; then
     exit 1
 fi
 

ci/order-crates-for-publishing.py

@@ -46,7 +46,7 @@ def get_packages():
     max_iterations = pow(len(dependency_graph),2)
     while dependency_graph:
         if max_iterations == 0:
-            # TODO: Be more helpful and find the actual cycle for the user
+            # One day be more helpful and find the actual cycle for the user...
             sys.exit('Error: Circular dependency suspected between these packages: {}\n'.format(' '.join(dependency_graph.keys())))
 
         max_iterations -= 1

ci/publish-crate.sh

@@ -50,8 +50,8 @@ for Cargo_toml in $Cargo_tomls; do
   (
     set -x
     crate=$(dirname "$Cargo_toml")
-    # TODO: the rocksdb package does not build with the stock rust docker image,
-    # so use the solana rust docker image until this is resolved upstream
+    # The rocksdb package does not build with the stock rust docker image so use
+    # the solana rust docker image
     cargoCommand="cargo publish --token $CRATES_IO_TOKEN"
     ci/docker-run.sh "$rust_stable_docker_image" bash -exc "cd $crate; $cargoCommand"
   ) || true # <-- Don't fail.  We want to be able to retry the job in cases when a publish fails halfway due to network/cloud issues

ci/publish-metrics-dashboard.sh

@@ -46,7 +46,6 @@ beta)
   ;;
 stable)
   # Set to whatever branch 'testnet' is on.
-  # TODO: Revert to $STABLE_CHANNEL for TdS
   CHANNEL_BRANCH=$BETA_CHANNEL
   ;;
 *)

ci/test-bench.sh

@@ -70,9 +70,9 @@ _ cargo +$rust_nightly bench --manifest-path programs/bpf/Cargo.toml ${V:+--verb
 # Run banking bench. Doesn't require nightly, but use since it is already built.
 _ cargo +$rust_nightly run --release --manifest-path banking_bench/Cargo.toml ${V:+--verbose} | tee -a "$BENCH_FILE"
 
-# TODO: debug why solana-upload-perf takes over 30 minutes to complete.
+# `solana-upload-perf` disabled as it can take over 30 minutes to complete for some
+# reason
 exit 0
-
 _ cargo +$rust_nightly run --release --package solana-upload-perf \
   -- "$BENCH_FILE" "$TARGET_BRANCH" "$UPLOAD_METRICS" | tee "$BENCH_ARTIFACT"
 

ci/test-large-network.sh

@@ -1,41 +0,0 @@
-#!/usr/bin/env bash
-set -e
-
-here=$(dirname "$0")
-cd "$here"/..
-
-source ci/rust-version.sh stable
-
-export RUST_BACKTRACE=1
-
-rm -rf target/perf-libs
-./fetch-perf-libs.sh
-export LD_LIBRARY_PATH=$PWD/target/perf-libs:$LD_LIBRARY_PATH
-
-export RUST_LOG=multinode=info
-
-source scripts/ulimit-n.sh
-
-if [[ $(sysctl -n net.core.rmem_default) -lt 1610612736 ]]; then
-  echo 'Error: rmem_default too small, run "sudo sysctl -w net.core.rmem_default=1610612736" to continue'
-  exit 1
-fi
-
-if [[ $(sysctl -n net.core.rmem_max) -lt 1610612736 ]]; then
-  echo 'Error: rmem_max too small, run "sudo sysctl -w net.core.rmem_max=1610612736" to continue'
-  exit 1
-fi
-
-if [[ $(sysctl -n net.core.wmem_default) -lt 1610612736 ]]; then
-  echo 'Error: rmem_default too small, run "sudo sysctl -w net.core.wmem_default=1610612736" to continue'
-  exit 1
-fi
-
-if [[ $(sysctl -n net.core.wmem_max) -lt 1610612736 ]]; then
-  echo 'Error: rmem_max too small, run "sudo sysctl -w net.core.wmem_max=1610612736" to continue'
-  exit 1
-fi
-
-set -x
-export SOLANA_DYNAMIC_NODES=120
-exec cargo +"$rust_stable" test --release --features=erasure test_multi_node_dynamic_network -- --ignored

ci/testnet-manager.sh

@@ -636,20 +636,7 @@ sanity-or-restart)
   else
     echo "+++ Sanity failed, updating the network"
     $metricsWriteDatapoint "testnet-manager sanity-failure=1"
-
-    # TODO: Restore attempt to restart the cluster before recreating it
-    #       See https://github.com/solana-labs/solana/issues/3774
-    if false; then
-      if start; then
-        echo Update successful
-      else
-        echo "+++ Update failed, restarting the network"
-        $metricsWriteDatapoint "testnet-manager update-failure=1"
-        create-and-start
-      fi
-    else
-      create-and-start
-    fi
+    create-and-start
   fi
   ;;
 *)