Skip to content

Commit 242b224

Browse files
michaelklishinmichaelklishin
committed
First man page updates for 4.0
1 parent e396c16 commit 242b224

11 files changed

+35
-27
lines changed

‎deps/rabbit/docs/README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,36 @@
11
# Manual Pages and Documentation Extras
22

3-
This directory contains [CLI tool](https://rabbitmq.com/cli.html) man page sources as well as a few documentation extras:
3+
This directory contains [CLI tools](https://rabbitmq.com/docs/cli/) man page sources as well as a few documentation extras:
44

5-
* An [annotated rabbitmq.conf example](./rabbitmq.conf.example) (see [new style configuration format](https://www.rabbitmq.com/configure.html#config-file-formats))
6-
* An [annotated advanced.config example](./advanced.config.example) (see [The advanced.config file](https://www.rabbitmq.com/configure.html#advanced-config-file))
5+
* An [annotated rabbitmq.conf example](./rabbitmq.conf.example) (see [new style configuration format](https://www.rabbitmq.com/docs/configure#config-file-formats))
6+
* An [annotated advanced.config example](./advanced.config.example) (see [The advanced.config file](https://www.rabbitmq.com/docs/configure#advanced-config-file))
77
* A [systemd unit file example](./rabbitmq-server.service.example)
88

9-
Please [see rabbitmq.com](https://rabbitmq.com/documentation.html) for documentation guides.
9+
Please [see rabbitmq.com](https://rabbitmq.com/docs/) for documentation guides.
1010

1111

12-
## Classic Config File Format Example
13-
14-
Feeling nostalgic and looking for the [classic configuration file example](https://github.com/rabbitmq/rabbitmq-server/blob/v3.7.x/docs/rabbitmq.config.example)?
15-
Now that's old school! Keep in mind that classic configuration file **should be considered deprecated**.
16-
Prefer `rabbitmq.conf` (see [new style configuration format](https://www.rabbitmq.com/configure.html#config-file-formats))
17-
with an `advanced.config` to complement it as needed.
1812

1913

2014
## man Pages
2115

2216
### Source Files
2317

24-
This directory contains man pages that are converted to HTML using `mandoc`:
18+
This directory contains man pages in ntroff, the man page format.
19+
20+
To inspect a local version, use `man`:
21+
22+
``` shell
23+
man docs/rabbitmq-diagnostics.8
24+
25+
man docs/rabbitmq-queues.8
26+
```
27+
28+
29+
To converted all man pages to HTML using `mandoc`:
2530

26-
gmake web-manpages
31+
``` shell
32+
gmake web-manpages
33+
```
2734

2835
The result is then copied to the [website repository](https://github.com/rabbitmq/rabbitmq-website/tree/live/site/man)
2936

‎deps/rabbit/docs/rabbitmq-diagnostics.8

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -697,10 +697,10 @@ See
697697
.Cm quorum_status
698698
in
699699
.Xr rabbitmq-queues 8
700-
.It Cm check_if_node_is_mirror_sync_critical
700+
.It Cm check_if_cluster_has_classic_queue_mirroring_policy
701701
.Pp
702702
See
703-
.Cm check_if_node_is_mirror_sync_critical
703+
.Cm check_if_cluster_has_classic_queue_mirroring_policy
704704
in
705705
.Xr rabbitmq-queues 8
706706
.It Cm check_if_node_is_quorum_critical
@@ -723,4 +723,4 @@ in
723723
.\" ------------------------------------------------------------------
724724
.Sh AUTHOR
725725
.\" ------------------------------------------------------------------
726-
.An The RabbitMQ Team Aq Mt [email protected].com
726+
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com

‎deps/rabbit/docs/rabbitmq-echopid.8

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ The short-name form of the RabbitMQ node name.
6767
.\" ------------------------------------------------------------------
6868
.Sh AUTHOR
6969
.\" ------------------------------------------------------------------
70-
.An The RabbitMQ Team Aq Mt [email protected].com
70+
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com

‎deps/rabbit/docs/rabbitmq-env.conf.5

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,4 @@ file RabbitMQ configuration file location is changed to "/data/services/rabbitmq
8484
.\" ------------------------------------------------------------------
8585
.Sh AUTHOR
8686
.\" ------------------------------------------------------------------
87-
.An The RabbitMQ Team Aq Mt [email protected].com
87+
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com

‎deps/rabbit/docs/rabbitmq-plugins.8

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,4 +252,4 @@ plugin and its dependencies and disables everything else:
252252
.\" ------------------------------------------------------------------
253253
.Sh AUTHOR
254254
.\" ------------------------------------------------------------------
255-
.An The RabbitMQ Team Aq Mt [email protected].com
255+
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com

‎deps/rabbit/docs/rabbitmq-queues.8

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -182,13 +182,14 @@ This command is currently only supported by quorum queues.
182182
Example:
183183
.Sp
184184
.Dl rabbitmq-queues peek --vhost Qo a-vhost Qc Qo a-queue Qc Qo 1 Qc
185-
.It Cm check_if_node_is_mirror_sync_critical
185+
.It Cm check_if_cluster_has_classic_queue_mirroring_policy
186186
.Pp
187-
Health check that exits with a non-zero code if there are classic mirrored queues without online synchronised mirrors (queues that would potentially lose data if the target node is shut down).
187+
Health check that exits with a non-zero code if there are policies in the cluster that enable classic queue mirroring.
188+
Classic queue mirroring has been deprecated since 2021 and was completely removed in the RabbitMQ 4.0 development cycle.
188189
.Pp
189190
Example:
190191
.Sp
191-
.Dl rabbitmq-queues check_if_node_is_mirror_sync_critical
192+
.Dl rabbitmq-queues check_if_cluster_has_classic_queue_mirroring_policy
192193
.It Cm check_if_node_is_quorum_critical
193194
.Pp
194195
Health check that exits with a non-zero code if there are queues with minimum online quorum (queues that would lose their quorum if the target node is shut down).
@@ -210,4 +211,4 @@ Example:
210211
.\" ------------------------------------------------------------------
211212
.Sh AUTHOR
212213
.\" ------------------------------------------------------------------
213-
.An The RabbitMQ Team Aq Mt [email protected].com
214+
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com

‎deps/rabbit/docs/rabbitmq-server.8

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,4 @@ For example, runs RabbitMQ AMQP server in the background:
9696
.\" ------------------------------------------------------------------
9797
.Sh AUTHOR
9898
.\" ------------------------------------------------------------------
99-
.An The RabbitMQ Team Aq Mt [email protected].com
99+
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com

‎deps/rabbit/docs/rabbitmq-service.8

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,4 +150,4 @@ is to discard the server output.
150150
.\" ------------------------------------------------------------------
151151
.Sh AUTHOR
152152
.\" ------------------------------------------------------------------
153-
.An The RabbitMQ Team Aq Mt [email protected].com
153+
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com

‎deps/rabbit/docs/rabbitmq-streams.8

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -447,4 +447,4 @@ for each consumer attached to the stream-1 stream and belonging to the stream-1
447447
.\" ------------------------------------------------------------------
448448
.Sh AUTHOR
449449
.\" ------------------------------------------------------------------
450-
.An The RabbitMQ Team Aq Mt [email protected].com
450+
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com

‎deps/rabbit/docs/rabbitmq-upgrade.8

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,4 +127,4 @@ To learn more, see the
127127
.\" ------------------------------------------------------------------
128128
.Sh AUTHOR
129129
.\" ------------------------------------------------------------------
130-
.An The RabbitMQ Team Aq Mt [email protected].com
130+
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com

‎deps/rabbit/docs/rabbitmqctl.8

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2457,4 +2457,4 @@ Reset the stats database for all nodes in the cluster.
24572457
.\" ------------------------------------------------------------------------------------------------
24582458
.Sh AUTHOR
24592459
.\" ------------------------------------------------------------------------------------------------
2460-
.An The RabbitMQ Team Aq Mt [email protected].com
2460+
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com

0 commit comments

Comments
 (0)