vitessio · rohit-nayak-ps · Dec 14, 2024 · Dec 14, 2024 · Dec 14, 2024 · Dec 14, 2024
diff --git a/Makefile b/Makefile
@@ -42,101 +42,29 @@ check-all-links: clean build link-checker-setup
 	bin/htmltest --conf .htmltest.external.yml
 
 ifndef COBRADOC_VERSION_PAIRS
-export COBRADOC_VERSION_PAIRS="main:22.0,v21.0.0:21.0,v20.0.3:20.0,v19.0.7:19.0,v18.0.8:18.0"
+export COBRADOC_VERSION_PAIRS="main:22.0,v21.0.0:21.0,v20.0.3:20.0,v19.0.7:19.0"
 endif
 
-generated-docs: mysqlctl-docs \
-	mysqlctld-docs \
-	topo2topo-docs \
-	vtaclcheck-docs \
-	vtbackup-docs \
-	vtbench-docs \
-	vtclient-docs \
-	vtcombo-docs \
-	vtctld-docs \
-	vtctldclient-docs \
-	vtgate-docs \
-	vtgateclienttest-docs \
-	vtorc-docs \
-	vttablet-docs \
-	vttestserver-docs \
-	vttlstest-docs \
-	zk-docs \
-	zkctl-docs \
-	zkctld-docs
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make mysqlctl-docs
-mysqlctl-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" mysqlctl
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make mysqlctld-docs
-mysqlctld-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" mysqlctld
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtaclcheck-docs
-vtaclcheck-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtaclcheck
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make topo2topo-docs
-topo2topo-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" topo2topo
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtbackup-docs
-vtbackup-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtbackup
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtbench-docs
-vtbench-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtbench
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtclient-docs
-vtclient-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtclient
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtcombo-docs
-vtcombo-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtcombo
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtctld-docs
-vtctld-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtctld
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtctldclient-docs
-vtctldclient-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtctldclient
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtgate-docs
-vtgate-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtgate
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtgateclienttest-docs
-vtgateclienttest-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtgateclienttest
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtorc-docs
-vtorc-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtorc
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vttablet-docs
-vttablet-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vttablet
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vttestserver-docs
-vttestserver-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vttestserver
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vttlstest-docs
-vttlstest-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vttlstest
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make zk-docs
-zk-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" zk
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make zkctl-docs
-zkctl-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" zkctl
-
-# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make zkctld-docs
-zkctld-docs:
-	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" zkctld
+BINS := mysqlctl mysqlctld vtaclcheck topo2topo vtbackup vtclient vtcombo \
+        vtctld vtctldclient vtgate vtgateclienttest vtorc vttablet vttestserver \
+        vttlstest zk zkctl zkctld
+
+# Pattern rule for building docs for a single binary.
+# Running `make mysqlctl-docs` will trigger this rule, for example.
+# VITESS_DIR should be specified as an environment variable, pointing to the root of the local Vitess repository
+# with most recent code and all release branches fetched, for which the docs are being generated.
+# Example, to make all current release  versions:
+# `make mysqlctl-docs VITESS_DIR=~/go/src/github.com/vitessio/vitess`
+# For a specific version, you can specify COBRADOC_VERSION_PAIRS as an environment variable, Example:
+# `make mysqlctl-docs COBRADOC_VERSION_PAIRS="main:22.0" VITESS_DIR=~/go/src/github.com/vitessio/vitess`
+%-docs:
+	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" $(patsubst %-docs,%,$@)
+	COMMIT_HASH=$(shell cd $(VITESS_DIR) && git rev-parse --short HEAD); \
+    	git add -u content && \
+    	if ! git diff --cached --quiet HEAD --; then \
+    	  git commit -s -m "Update cobradocs for $$COMMIT_HASH for $(patsubst %-docs,%,$@)"; \
+    	fi
+
+# Target to run them all.
+.PHONY: generated-docs
+generated-docs: $(BINS:%=%-docs)
diff --git a/content/en/docs/22.0/reference/programs/mysqlctl/_index.md b/content/en/docs/22.0/reference/programs/mysqlctl/_index.md
@@ -1,7 +1,6 @@
 ---
 title: mysqlctl
 series: mysqlctl
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## mysqlctl
 

diff --git a/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_init.md b/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_init.md
@@ -1,7 +1,6 @@
 ---
 title: init
 series: mysqlctl
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## mysqlctl init
 

diff --git a/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_init_config.md b/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_init_config.md
@@ -1,7 +1,6 @@
 ---
 title: init config
 series: mysqlctl
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## mysqlctl init_config
 

diff --git a/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_position.md b/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_position.md
@@ -1,7 +1,6 @@
 ---
 title: position
 series: mysqlctl
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## mysqlctl position
 

diff --git a/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md b/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md
@@ -1,7 +1,6 @@
 ---
 title: reinit config
 series: mysqlctl
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## mysqlctl reinit_config
 

diff --git a/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_shutdown.md b/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_shutdown.md
@@ -1,7 +1,6 @@
 ---
 title: shutdown
 series: mysqlctl
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## mysqlctl shutdown
 

diff --git a/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_start.md b/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_start.md
@@ -1,7 +1,6 @@
 ---
 title: start
 series: mysqlctl
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## mysqlctl start
 

diff --git a/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_teardown.md b/content/en/docs/22.0/reference/programs/mysqlctl/mysqlctl_teardown.md
@@ -1,7 +1,6 @@
 ---
 title: teardown
 series: mysqlctl
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## mysqlctl teardown
 

diff --git a/content/en/docs/22.0/reference/programs/mysqlctld/_index.md b/content/en/docs/22.0/reference/programs/mysqlctld/_index.md
@@ -1,7 +1,6 @@
 ---
 title: mysqlctld
 series: mysqlctld
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## mysqlctld
 

diff --git a/content/en/docs/22.0/reference/programs/topo2topo/_index.md b/content/en/docs/22.0/reference/programs/topo2topo/_index.md
@@ -1,7 +1,6 @@
 ---
 title: topo2topo
 series: topo2topo
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## topo2topo
 

diff --git a/content/en/docs/22.0/reference/programs/vtaclcheck/_index.md b/content/en/docs/22.0/reference/programs/vtaclcheck/_index.md
@@ -1,7 +1,6 @@
 ---
 title: vtaclcheck
 series: vtaclcheck
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## vtaclcheck
 

diff --git a/content/en/docs/22.0/reference/programs/vtbackup/_index.md b/content/en/docs/22.0/reference/programs/vtbackup/_index.md
@@ -1,7 +1,6 @@
 ---
 title: vtbackup
 series: vtbackup
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## vtbackup
 
@@ -209,6 +208,7 @@ vtbackup [flags]
       --remote_operation_timeout duration                           time to wait for a remote operation (default 15s)
       --restart_before_backup                                       Perform a mysqld clean/full restart after applying binlogs, but before taking the backup. Only makes sense to work around xtrabackup bugs.
       --s3_backup_aws_endpoint string                               endpoint of the S3 backend (region must be provided).
+      --s3_backup_aws_min_partsize int                              Minimum part size to use, defaults to 5MiB but can be increased due to the dataset size. (default 5242880)
       --s3_backup_aws_region string                                 AWS region to use. (default "us-east-1")
       --s3_backup_aws_retries int                                   AWS request retries. (default -1)
       --s3_backup_force_path_style                                  force the s3 path style.
@@ -245,6 +245,7 @@ vtbackup [flags]
       --topo_global_root string                                     the path of the global topology data in the global topology server
       --topo_global_server_address string                           the address of the global topology server
       --topo_implementation string                                  the topology implementation to use
+      --topo_read_concurrency int                                   Maximum concurrency of topo reads per global or local cell. (default 32)
       --topo_zk_auth_file string                                    auth to use when connecting to the zk topo server, file contents should be <scheme>:<auth>, e.g., digest:user:pass
       --topo_zk_base_timeout duration                               zk base timeout (see zk.Connect) (default 30s)
       --topo_zk_max_concurrency int                                 maximum number of pending requests to send to a Zookeeper server. (default 64)

diff --git a/content/en/docs/22.0/reference/programs/vtclient/_index.md b/content/en/docs/22.0/reference/programs/vtclient/_index.md
@@ -1,7 +1,6 @@
 ---
 title: vtclient
 series: vtclient
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## vtclient
 

diff --git a/content/en/docs/22.0/reference/programs/vtcombo/_index.md b/content/en/docs/22.0/reference/programs/vtcombo/_index.md
@@ -1,7 +1,6 @@
 ---
 title: vtcombo
 series: vtcombo
-commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
 ---
 ## vtcombo
 
@@ -35,15 +34,8 @@ vtcombo [flags]
       --backup_storage_compress                                          if set, the backup files will be compressed. (default true)
       --backup_storage_number_blocks int                                 if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, in parallel, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression. (default 2)
       --bind-address string                                              Bind address for the server. If empty, the server will listen on all available unicast and anycast IP addresses of the local system.
-      --binlog_host string                                               PITR restore parameter: hostname/IP of binlog server.
-      --binlog_password string                                           PITR restore parameter: password of binlog server.
+      --binlog-in-memory-decompressor-max-size uint                      This value sets the uncompressed transaction payload size at which we switch from in-memory buffer based decompression to the slower streaming mode. (default 134217728)
       --binlog_player_protocol string                                    the protocol to download binlogs from a vttablet (default "grpc")
-      --binlog_port int                                                  PITR restore parameter: port of binlog server.
-      --binlog_ssl_ca string                                             PITR restore parameter: Filename containing TLS CA certificate to verify binlog server TLS certificate against.
-      --binlog_ssl_cert string                                           PITR restore parameter: Filename containing mTLS client certificate to present to binlog server as authentication.
-      --binlog_ssl_key string                                            PITR restore parameter: Filename containing mTLS client private key for use in binlog server authentication.
-      --binlog_ssl_server_name string                                    PITR restore parameter: TLS server name (common name) to verify against for the binlog server we are connecting to (If not set: use the hostname or IP supplied in --binlog_host).
-      --binlog_user string                                               PITR restore parameter: username of binlog server.
       --buffer_drain_concurrency int                                     Maximum number of requests retried simultaneously. More concurrency will increase the load on the PRIMARY vttablet when draining the buffer. (default 1)
       --buffer_keyspace_shards string                                    If not empty, limit buffering to these entries (comma separated). Entry format: keyspace or keyspace/shard. Requires --enable_buffer=true.
       --buffer_max_failover_duration duration                            Stop buffering completely if a failover takes longer than this duration. (default 20s)
@@ -274,7 +266,6 @@ vtcombo [flags]
       --onclose_timeout duration                                         wait no more than this for OnClose handlers before stopping (default 10s)
       --onterm_timeout duration                                          wait no more than this for OnTermSync handlers before stopping (default 10s)
       --pid_file string                                                  If set, the process will write its pid to the named file, and delete it on graceful shutdown.
-      --pitr_gtid_lookup_timeout duration                                PITR restore parameter: timeout for fetching gtid from timestamp. (default 1m0s)
       --planner-version string                                           Sets the default planner to use when the session has not changed it. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right
       --pool_hostname_resolve_interval duration                          if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled)
       --port int                                                         port for the server
@@ -387,7 +378,7 @@ vtcombo [flags]
       --topo_global_root string                                          the path of the global topology data in the global topology server
       --topo_global_server_address string                                the address of the global topology server
       --topo_implementation string                                       the topology implementation to use
-      --topo_read_concurrency int                                        Concurrency of topo reads. (default 32)
+      --topo_read_concurrency int                                        Maximum concurrency of topo reads per global or local cell. (default 32)
       --topo_zk_auth_file string                                         auth to use when connecting to the zk topo server, file contents should be <scheme>:<auth>, e.g., digest:user:pass
       --topo_zk_base_timeout duration                                    zk base timeout (see zk.Connect) (default 30s)
       --topo_zk_max_concurrency int                                      maximum number of pending requests to send to a Zookeeper server. (default 64)
@@ -408,8 +399,7 @@ vtcombo [flags]
       --transaction_limit_per_user float                                 Maximum number of transactions a single user is allowed to use at any time, represented as fraction of -transaction_cap. (default 0.4)
       --transaction_mode string                                          SINGLE: disallow multi-db transactions, MULTI: allow multi-db transactions with best effort commit, TWOPC: allow multi-db transactions with 2pc commit (default "MULTI")
       --truncate-error-len int                                           truncate errors sent to client if they are longer than this value (0 means do not truncate)
-      --twopc_abandon_age float                                          time in seconds. Any unresolved transaction older than this time will be sent to the coordinator to be resolved.
-      --twopc_enable                                                     if the flag is on, 2pc is enabled. Other 2pc flags must be supplied.
+      --twopc_abandon_age time.Duration                                  Any unresolved transaction older than this time will be sent to the coordinator to be resolved. NOTE: Providing time as seconds (float64) is deprecated. Use time.Duration format (e.g., '1s', '2m', '1h'). (default 15m0s)
       --tx-throttler-config string                                       Synonym to -tx_throttler_config (default "target_replication_lag_sec:2 max_replication_lag_sec:10 initial_rate:100 max_increase:1 emergency_decrease:0.5 min_duration_between_increases_sec:40 max_duration_between_increases_sec:62 min_duration_between_decreases_sec:20 spread_backlog_across_sec:20 age_bad_rate_after_sec:180 bad_rate_increase:0.1 max_rate_approach_threshold:0.9")
       --tx-throttler-default-priority int                                Default priority assigned to queries that lack priority information (default 100)
       --tx-throttler-dry-run                                             If present, the transaction throttler only records metrics about requests received and throttled, but does not actually throttle any requests.
@@ -427,7 +417,7 @@ vtcombo [flags]
       --vreplication_copy_phase_duration duration                        Duration for each copy phase loop (before running the next catchup: default 1h) (default 1h0m0s)
       --vreplication_copy_phase_max_innodb_history_list_length int       The maximum InnoDB transaction history that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 1000000)
       --vreplication_copy_phase_max_mysql_replication_lag int            The maximum MySQL replication lag (in seconds) that can exist on a vstreamer (source) before starting another round of copying rows. This helps to limit the impact on the source tablet. (default 43200)
-      --vreplication_experimental_flags int                              (Bitmask) of experimental features in vreplication to enable (default 3)
+      --vreplication_experimental_flags int                              (Bitmask) of experimental features in vreplication to enable (default 7)
       --vreplication_heartbeat_update_interval int                       Frequency (in seconds, default 1, max 60) at which the time_updated column of a vreplication stream when idling (default 1)
       --vreplication_max_time_to_retry_on_error duration                 stop automatically retrying when we've had consecutive failures with the same error for this long after the first occurrence
       --vreplication_net_read_timeout int                                Session value of net_read_timeout for vreplication, in seconds (default 300)