syntax: Use __PATTERNS__ instead of @PATTERNS@ in podwrapper man pages.

It is slightly dangerous to use @PATTERNS@, since these might be substituted by autoconf when they appear in Makefile.am files.
2026-03-21 22:53:37 +00:00 · 2012-10-03 09:15:37 +01:00
parent df2469a48f
commit 4a4ca0c01d
9 changed files with 35 additions and 35 deletions
--- a/fish/Makefile.am
+++ b/fish/Makefile.am
@@ -185,8 +185,8 @@ stamp-guestfish.pod: guestfish.pod guestfish-actions.pod guestfish-commands.pod
 	$(PODWRAPPER) \
 	  --man guestfish.1 \
 	  --html $(top_builddir)/html/guestfish.1.html \
-	  --insert $(srcdir)/guestfish-actions.pod:@ACTIONS@ \
-	  --insert $(srcdir)/guestfish-commands.pod:@FISH_COMMANDS@ \
+	  --insert $(srcdir)/guestfish-actions.pod:__ACTIONS__ \
+	  --insert $(srcdir)/guestfish-commands.pod:__FISH_COMMANDS__ \
 	  --license GPLv2+ \
 	  $<
 	touch $@
--- a/fish/guestfish.pod
+++ b/fish/guestfish.pod
@@ -1121,11 +1121,11 @@ With a C<cmd> parameter, this displays detailed help for that command.

 This exits guestfish.  You can also use C<^D> key.

-@FISH_COMMANDS@
+__FISH_COMMANDS__

 =head1 COMMANDS

-@ACTIONS@
+__ACTIONS__

 =head1 EXIT STATUS

--- a/po-docs/ja/Makefile.am
+++ b/po-docs/ja/Makefile.am
@@ -81,9 +81,9 @@ guestfs.3: guestfs.pod guestfs-actions.pod guestfs-availability.pod guestfs-stru
 	  --man $@ \
 	  --section 3 \
 	  --license LGPLv2+ \
-	  --insert $(srcdir)/guestfs-actions.pod:@ACTIONS@ \
-	  --insert $(srcdir)/guestfs-availability.pod:@AVAILABILITY@ \
-	  --insert $(srcdir)/guestfs-structs.pod:@STRUCTS@ \
+	  --insert $(srcdir)/guestfs-actions.pod:__ACTIONS__ \
+	  --insert $(srcdir)/guestfs-availability.pod:__AVAILABILITY__ \
+	  --insert $(srcdir)/guestfs-structs.pod:__STRUCTS__ \
 	  $<

 guestfish.1: guestfish.pod guestfish-actions.pod guestfish-commands.pod
@@ -91,8 +91,8 @@ guestfish.1: guestfish.pod guestfish-actions.pod guestfish-commands.pod
 	  --no-strict-checks \
 	  --man $@ \
 	  --license GPLv2+ \
-	  --insert $(srcdir)/guestfish-actions.pod:@ACTIONS@ \
-	  --insert $(srcdir)/guestfish-commands.pod:@FISH_COMMANDS@ \
+	  --insert $(srcdir)/guestfish-actions.pod:__ACTIONS__ \
+	  --insert $(srcdir)/guestfish-commands.pod:__FISH_COMMANDS__ \
 	  $<

 virt-sysprep.1: virt-sysprep.pod sysprep-extra-options.pod sysprep-operations.pod
@@ -100,8 +100,8 @@ virt-sysprep.1: virt-sysprep.pod sysprep-extra-options.pod sysprep-operations.po
 	  --no-strict-checks \
 	  --man $@ \
 	  --license GPLv2+ \
-          --insert sysprep-extra-options.pod:@EXTRA_OPTIONS@ \
-          --insert sysprep-operations.pod:@OPERATIONS@ \
+          --insert sysprep-extra-options.pod:__EXTRA_OPTIONS__ \
+          --insert sysprep-operations.pod:__OPERATIONS__ \
 	  $<

 %.1: %.pod
--- a/po-docs/uk/Makefile.am
+++ b/po-docs/uk/Makefile.am
@@ -81,9 +81,9 @@ guestfs.3: guestfs.pod guestfs-actions.pod guestfs-availability.pod guestfs-stru
 	  --man $@ \
 	  --section 3 \
 	  --license LGPLv2+ \
-	  --insert $(srcdir)/guestfs-actions.pod:@ACTIONS@ \
-	  --insert $(srcdir)/guestfs-availability.pod:@AVAILABILITY@ \
-	  --insert $(srcdir)/guestfs-structs.pod:@STRUCTS@ \
+	  --insert $(srcdir)/guestfs-actions.pod:__ACTIONS__ \
+	  --insert $(srcdir)/guestfs-availability.pod:__AVAILABILITY__ \
+	  --insert $(srcdir)/guestfs-structs.pod:__STRUCTS__ \
 	  $<

 guestfish.1: guestfish.pod guestfish-actions.pod guestfish-commands.pod
@@ -91,8 +91,8 @@ guestfish.1: guestfish.pod guestfish-actions.pod guestfish-commands.pod
 	  --no-strict-checks \
 	  --man $@ \
 	  --license GPLv2+ \
-	  --insert $(srcdir)/guestfish-actions.pod:@ACTIONS@ \
-	  --insert $(srcdir)/guestfish-commands.pod:@FISH_COMMANDS@ \
+	  --insert $(srcdir)/guestfish-actions.pod:__ACTIONS__ \
+	  --insert $(srcdir)/guestfish-commands.pod:__FISH_COMMANDS__ \
 	  $<

 virt-sysprep.1: virt-sysprep.pod sysprep-extra-options.pod sysprep-operations.pod
@@ -100,8 +100,8 @@ virt-sysprep.1: virt-sysprep.pod sysprep-extra-options.pod sysprep-operations.po
 	  --no-strict-checks \
 	  --man $@ \
 	  --license GPLv2+ \
-          --insert sysprep-extra-options.pod:@EXTRA_OPTIONS@ \
-          --insert sysprep-operations.pod:@OPERATIONS@ \
+          --insert sysprep-extra-options.pod:__EXTRA_OPTIONS__ \
+          --insert sysprep-operations.pod:__OPERATIONS__ \
 	  $<

 %.1: %.pod
--- a/podwrapper.pl.in
+++ b/podwrapper.pl.in
@@ -79,17 +79,17 @@ given, then no web page output is produced.

 my @inserts;

-=item B<--insert=filename:@PATTERN@>
+=item B<--insert=filename:__PATTERN__>

-In the input file, replace the literal text C<@PATTERN@> with the
+In the input file, replace the literal text C<__PATTERN__> with the
 replacement file C<filename>.  You can give this option multiple
 times.

 The contents of C<filename> are treated as POD.
 Compare and contrast with I<--verbatim>.

-Although it is conventional to use C<@...@> for patterns, in fact
-you can use any string as the pattern.
+Although it is conventional to use C<__...__> (double underscores) for
+patterns, in fact you can use any string as the pattern.

 =cut

@@ -154,7 +154,7 @@ my @verbatims;

 =item B<--verbatim=filename:@PATTERN@>

-In the input file, replace the literal text C<@PATTERN@> with the
+In the input file, replace the literal text C<__PATTERN__> with the
 replacement file C<filename>.  You can give this option multiple
 times.

@@ -162,8 +162,8 @@ The contents of C<filename> are inserted as verbatim text, and
 are I<not> interpreted as POD.
 Compare and contrast with I<--insert>.

-Although it is conventional to use C<@...@> for patterns, in fact
-you can use any string as the pattern.
+Although it is conventional to use C<__...__> (double underscores) for
+patterns, in fact you can use any string as the pattern.

 =cut

--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -224,9 +224,9 @@ stamp-guestfs.pod: guestfs.pod \
 	  --section 3 \
 	  --man guestfs.3 \
 	  --html $(top_builddir)/html/guestfs.3.html \
-	  --insert $(srcdir)/guestfs-actions.pod:@ACTIONS@ \
-	  --insert $(srcdir)/guestfs-availability.pod:@AVAILABILITY@ \
-	  --insert $(srcdir)/guestfs-structs.pod:@STRUCTS@ \
+	  --insert $(srcdir)/guestfs-actions.pod:__ACTIONS__ \
+	  --insert $(srcdir)/guestfs-availability.pod:__AVAILABILITY__ \
+	  --insert $(srcdir)/guestfs-structs.pod:__STRUCTS__ \
 	  --license LGPLv2+ \
 	  $<
 	touch $@
--- a/src/guestfs.pod
+++ b/src/guestfs.pod
@@ -1788,11 +1788,11 @@ This returns the current out of memory handler.

 =head1 API CALLS

-@ACTIONS@
+__ACTIONS__

 =head1 STRUCTURES

-@STRUCTS@
+__STRUCTS__

 =head1 AVAILABILITY

@@ -1803,7 +1803,7 @@ the following groups of functions.  This test queries the
 appliance to see if the appliance you are currently using
 supports the functionality.

-@AVAILABILITY@
+__AVAILABILITY__

 =head2 FILESYSTEM AVAILABLE

--- a/sysprep/Makefile.am
+++ b/sysprep/Makefile.am
@@ -129,8 +129,8 @@ virt-sysprep.1 $(top_builddir)/html/virt-sysprep.1.html: stamp-virt-sysprep.pod
 stamp-virt-sysprep.pod: virt-sysprep.pod sysprep-extra-options.pod sysprep-operations.pod
 	$(PODWRAPPER) \
 	  --man virt-sysprep.1 \
-          --insert sysprep-extra-options.pod:@EXTRA_OPTIONS@ \
-          --insert sysprep-operations.pod:@OPERATIONS@ \
+          --insert sysprep-extra-options.pod:__EXTRA_OPTIONS__ \
+          --insert sysprep-operations.pod:__OPERATIONS__ \
 	  --html $(top_builddir)/html/virt-sysprep.1.html \
 	  --license GPLv2+ \
 	  $<
--- a/sysprep/virt-sysprep.pod
+++ b/sysprep/virt-sysprep.pod
@@ -180,7 +180,7 @@ Display version number and exit.

 Enable tracing of libguestfs API calls.

-@EXTRA_OPTIONS@
+__EXTRA_OPTIONS__

 =back

@@ -205,7 +205,7 @@ operations that you want to have enabled.

 C<*> = enabled by default when no I<--enable> option is given.

-@OPERATIONS@
+__OPERATIONS__

 =head1 COPYING AND CLONING