From f346abfb412b772d57da1c58037bce7120534814 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Wed, 3 Oct 2012 09:15:37 +0100 Subject: [PATCH] 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. (cherry picked from commit 4a4ca0c01da3307b69fc4925c5f2ece1e728d4b3) --- fish/Makefile.am | 4 ++-- fish/guestfish.pod | 4 ++-- po-docs/ja/Makefile.am | 14 +++++++------- po-docs/uk/Makefile.am | 14 +++++++------- podwrapper.pl.in | 14 +++++++------- src/Makefile.am | 6 +++--- src/guestfs.pod | 6 +++--- sysprep/Makefile.am | 4 ++-- sysprep/virt-sysprep.pod | 4 ++-- 9 files changed, 35 insertions(+), 35 deletions(-) diff --git a/fish/Makefile.am b/fish/Makefile.am index 908464228..b2cb973e2 100644 --- 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 $@ diff --git a/fish/guestfish.pod b/fish/guestfish.pod index 7dacb64f0..62bad2bf1 100644 --- a/fish/guestfish.pod +++ b/fish/guestfish.pod @@ -1117,11 +1117,11 @@ With a C 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 diff --git a/po-docs/ja/Makefile.am b/po-docs/ja/Makefile.am index 58c7170d0..6ef2045c1 100644 --- a/po-docs/ja/Makefile.am +++ b/po-docs/ja/Makefile.am @@ -79,9 +79,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 @@ -89,8 +89,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 @@ -98,8 +98,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 diff --git a/po-docs/uk/Makefile.am b/po-docs/uk/Makefile.am index 58c7170d0..6ef2045c1 100644 --- a/po-docs/uk/Makefile.am +++ b/po-docs/uk/Makefile.am @@ -79,9 +79,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 @@ -89,8 +89,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 @@ -98,8 +98,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 diff --git a/podwrapper.pl.in b/podwrapper.pl.in index b8b045935..46c71f2e9 100755 --- 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. You can give this option multiple times. The contents of C 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. You can give this option multiple times. @@ -162,8 +162,8 @@ The contents of C are inserted as verbatim text, and are I 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 diff --git a/src/Makefile.am b/src/Makefile.am index 111e1799b..bfd319b6d 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -219,9 +219,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 $@ diff --git a/src/guestfs.pod b/src/guestfs.pod index c2bf9a6a2..ce5359c7c 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -1697,11 +1697,11 @@ This returns the current out of memory handler. =head1 API CALLS -@ACTIONS@ +__ACTIONS__ =head1 STRUCTURES -@STRUCTS@ +__STRUCTS__ =head1 AVAILABILITY @@ -1712,7 +1712,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 GUESTFISH supported COMMAND diff --git a/sysprep/Makefile.am b/sysprep/Makefile.am index 98ecbaf41..38c68f623 100644 --- a/sysprep/Makefile.am +++ b/sysprep/Makefile.am @@ -100,8 +100,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+ \ $< diff --git a/sysprep/virt-sysprep.pod b/sysprep/virt-sysprep.pod index 6e0fc0a8a..521e03317 100755 --- a/sysprep/virt-sysprep.pod +++ b/sysprep/virt-sysprep.pod @@ -179,7 +179,7 @@ Display version number and exit. Enable tracing of libguestfs API calls. -@EXTRA_OPTIONS@ +__EXTRA_OPTIONS__ =back @@ -204,7 +204,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