From cb3ff6ed4336af9e4c0643d8224d5bc3d790a655 Mon Sep 17 00:00:00 2001 From: David Steele Date: Sat, 23 Sep 2023 13:41:03 -0400 Subject: [PATCH] Fix command reference example for the filter option. This example was broken by 24f7252. Revert to (almost) the prior code to fix this example until something better can be committed. The something better is in progress but it adds new build requirements so it is too late to include it for the release. Technically this breaks some other examples, but they are all internal and not visible in the user-facing documentation. --- doc/lib/pgBackRestDoc/Common/DocConfig.pm | 16 ++++------------ doc/xml/release/2023/2.48.xml | 8 ++++++++ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/lib/pgBackRestDoc/Common/DocConfig.pm b/doc/lib/pgBackRestDoc/Common/DocConfig.pm index c9dd44574..d2cb3bae7 100644 --- a/doc/lib/pgBackRestDoc/Common/DocConfig.pm +++ b/doc/lib/pgBackRestDoc/Common/DocConfig.pm @@ -889,20 +889,12 @@ sub helpOptionGet } else { - foreach my $strLine (split('\\|', $$oOptionHash{&CONFIG_HELP_EXAMPLE})) + if (defined($strCommand)) { - if ($strExample ne '') - { - $strExample .= ' '; - } - - if (defined($strCommand)) - { - $strExample .= '--'; - } - - $strExample .= "${strOptionIndex}=${strLine}"; + $strExample = '--'; } + + $strExample .= "${strOptionIndex}=" . $$oOptionHash{&CONFIG_HELP_EXAMPLE}; } $strCodeBlock .= (defined($strCodeBlock) ? "\n" : '') . "example: ${strExample}"; diff --git a/doc/xml/release/2023/2.48.xml b/doc/xml/release/2023/2.48.xml index dd7ad326e..0593a35d1 100644 --- a/doc/xml/release/2023/2.48.xml +++ b/doc/xml/release/2023/2.48.xml @@ -183,6 +183,14 @@

Fix configuration reference example for the tls-server-address option.

+ + + + + + +

Fix command reference example for the filter option.

+