[v1] Use XEN_SCRIPT_DIR to refer to /etc/xen/scripts

Commit Message

Olaf Hering June 21, 2019, 9:29 a.m. UTC

Now that scripts are stored in libexec, replace all hardcoded paths to
use XEN_SCRIPT_DIR to expand the actual location.

Update .gitignore.

Signed-off-by: Olaf Hering <[e-mail]>
---
 .gitignore                                                          | 3 +++
 docs/configure.ac                                                   | 3 +++
 .../{xl-disk-configuration.5.pod => xl-disk-configuration.5.pod.in} | 2 +-
 ...etwork-configuration.5.pod => xl-network-configuration.5.pod.in} | 4 ++--
 docs/man/xl.1.pod.in                                                | 2 +-
 docs/man/{xl.conf.5.pod => xl.conf.5.pod.in}                        | 6 +++---
 docs/misc/block-scripts.txt                                         | 2 +-
 tools/xl/xl_cmdtable.c                                              | 2 +-
 8 files changed, 15 insertions(+), 9 deletions(-)
 rename docs/man/{xl-disk-configuration.5.pod => xl-disk-configuration.5.pod.in} (99%)
 rename docs/man/{xl-network-configuration.5.pod => xl-network-configuration.5.pod.in} (98%)
 rename docs/man/{xl.conf.5.pod => xl.conf.5.pod.in} (97%)

Comments

Anthony PERARD July 2, 2019, 2:52 p.m. UTC | #1

Hi,

On Fri, Jun 21, 2019 at 11:29:44AM +0200, Olaf Hering wrote:
> Now that scripts are stored in libexec, replace all hardcoded paths to
> use XEN_SCRIPT_DIR to expand the actual location.

As far as I can tell, this isn't true, scripts are located in /etc.

If you want to move the scripts from /etc to libexec, it might be worth
doing so in a separated patch. And keep this patch to only move hard
codded strings "/etc/xen/scripts" to use XEN_SCRIPT_DIR instead.

Since this patch doesn't actually move anything, there might be a
different patch. The patch comment doesn't needs to discuss about it at
all. So removing the comment about location of scripts and the extra
hunk and this patch would be fine by me.

> Update .gitignore.
> 
> Signed-off-by: Olaf Hering <[e-mail]>
> ---
> diff --git a/docs/misc/block-scripts.txt b/docs/misc/block-scripts.txt
> index eabab100a8..8020787a52 100644
> --- a/docs/misc/block-scripts.txt
> +++ b/docs/misc/block-scripts.txt
> @@ -18,7 +18,7 @@ Setup
>  
>  It is highly recommended that custom hotplug scripts as much as
>  possible include and use the common Xen functionality.  If the script
> -is run from the normal block script location (/etc/xen/scripts by
> +is run from the normal block script location (/usr/lib/xen/scripts by

I don't think this hunk belong to this patch, it would be better to have
that in a different patch, I think.

>  default), then this can be done by adding the following to the top of
>  the script:
>  

Thanks,

Olaf Hering July 2, 2019, 4:06 p.m. UTC | #2

Am Tue, 2 Jul 2019 15:52:37 +0100
schrieb Anthony PERARD <[e-mail]>:

> As far as I can tell, this isn't true, scripts are located in /etc.

There was zero response to the other patches.
This one just depends on them.

Olaf

Patch

diff --git a/.gitignore b/.gitignore
index a77cbff02c..78577857ea 100644
--- a/.gitignore
+++ b/.gitignore
@@ -47,7 +47,10 @@  dist/*
 docs/tmp.*
 docs/html/
 docs/man/xl.cfg.5.pod
+docs/man/xl-disk-configuration.5.pod
+docs/man/xl-network-configuration.5.pod
 docs/man/xl.1.pod
+docs/man/xl.conf.5.pod
 docs/man1/
 docs/man5/
 docs/man7/
diff --git a/docs/configure.ac b/docs/configure.ac
index e795bec04c..169480da6c 100644
--- a/docs/configure.ac
+++ b/docs/configure.ac
@@ -9,6 +9,9 @@  AC_CONFIG_FILES([
 ../config/Docs.mk
 man/xl.cfg.5.pod
 man/xl.1.pod
+man/xl-disk-configuration.5.pod
+man/xl-network-configuration.5.pod
+man/xl.conf.5.pod
 ])
 AC_CONFIG_AUX_DIR([../])
 
diff --git a/docs/man/xl-disk-configuration.5.pod b/docs/man/xl-disk-configuration.5.pod.in
similarity index 99%
rename from docs/man/xl-disk-configuration.5.pod
rename to docs/man/xl-disk-configuration.5.pod.in
index 7965d5dd73..95c23b4a92 100644
--- a/docs/man/xl-disk-configuration.5.pod
+++ b/docs/man/xl-disk-configuration.5.pod.in
@@ -257,7 +257,7 @@  automatically determine the most suitable backend.
 
 Specifies that B<target> is not a normal host path, but rather
 information to be interpreted by the executable program I<SCRIPT>,
-(looked for in F</etc/xen/scripts>, if it doesn't contain a slash).
+(looked for in F<@XEN_SCRIPT_DIR@>, if it doesn't contain a slash).
 
 These scripts are normally called "block-I<SCRIPT>".
 
diff --git a/docs/man/xl-network-configuration.5.pod b/docs/man/xl-network-configuration.5.pod.in
similarity index 98%
rename from docs/man/xl-network-configuration.5.pod
rename to docs/man/xl-network-configuration.5.pod.in
index e9ac3c5b9e..c3467c6e76 100644
--- a/docs/man/xl-network-configuration.5.pod
+++ b/docs/man/xl-network-configuration.5.pod.in
@@ -169,8 +169,8 @@  number. Likewise the default tap name is C<vifDOMID.DEVID-emu>.
 
 Specifies the hotplug script to run to configure this device (e.g. to
 add it to the relevant bridge). Defaults to
-C<XEN_SCRIPT_DIR/vif-bridge> but can be set to any script. Some example
-scripts are installed in C<XEN_SCRIPT_DIR>.
+C<@XEN_SCRIPT_DIR@/vif-bridge> but can be set to any script. Some example
+scripts are installed in C<@XEN_SCRIPT_DIR@>.
 
 
 =head2 ip
diff --git a/docs/man/xl.1.pod.in b/docs/man/xl.1.pod.in
index 2f7375ed0a..3d64eaa5b2 100644
--- a/docs/man/xl.1.pod.in
+++ b/docs/man/xl.1.pod.in
@@ -571,7 +571,7 @@  See the corresponding option of the I<create> subcommand.
 =item B<-N> I<netbufscript>
 
 Use <netbufscript> to setup network buffering instead of the
-default script (/etc/xen/scripts/remus-netbuf-setup).
+default script (@XEN_SCRIPT_DIR@/remus-netbuf-setup).
 
 =item B<-F>
 
diff --git a/docs/man/xl.conf.5.pod b/docs/man/xl.conf.5.pod.in
similarity index 97%
rename from docs/man/xl.conf.5.pod
rename to docs/man/xl.conf.5.pod.in
index b1bde7d657..2beb2119a8 100644
--- a/docs/man/xl.conf.5.pod
+++ b/docs/man/xl.conf.5.pod.in
@@ -95,7 +95,7 @@  Configures the default hotplug script used by virtual network devices.
 
 The old B<vifscript> option is deprecated and should not be used.
 
-Default: C</etc/xen/scripts/vif-bridge>
+Default: C<@XEN_SCRIPT_DIR@/vif-bridge>
 
 =item B<vif.default.bridge="NAME">
 
@@ -121,13 +121,13 @@  Default: C<None>
 
 Configures the default script used by Remus to setup network buffering.
 
-Default: C</etc/xen/scripts/remus-netbuf-setup>
+Default: C<@XEN_SCRIPT_DIR@/remus-netbuf-setup>
 
 =item B<colo.default.proxyscript="PATH">
 
 Configures the default script used by COLO to setup colo-proxy.
 
-Default: C</etc/xen/scripts/colo-proxy-setup>
+Default: C<@XEN_SCRIPT_DIR@/colo-proxy-setup>
 
 =item B<output_format="json|sxp">
 
diff --git a/docs/misc/block-scripts.txt b/docs/misc/block-scripts.txt
index eabab100a8..8020787a52 100644
--- a/docs/misc/block-scripts.txt
+++ b/docs/misc/block-scripts.txt
@@ -18,7 +18,7 @@  Setup
 
 It is highly recommended that custom hotplug scripts as much as
 possible include and use the common Xen functionality.  If the script
-is run from the normal block script location (/etc/xen/scripts by
+is run from the normal block script location (/usr/lib/xen/scripts by
 default), then this can be done by adding the following to the top of
 the script:
 
diff --git a/tools/xl/xl_cmdtable.c b/tools/xl/xl_cmdtable.c
index 5baa6023aa..21620222cd 100644
--- a/tools/xl/xl_cmdtable.c
+++ b/tools/xl/xl_cmdtable.c
@@ -518,7 +518,7 @@  struct cmd_spec cmd_table[] = {
       "-e                      Do not wait in the background (on <host>) for the death\n"
       "                        of the domain.\n"
       "-N <netbufscript>       Use netbufscript to setup network buffering instead of the\n"
-      "                        default script (/etc/xen/scripts/remus-netbuf-setup).\n"
+      "                        default script (" XEN_SCRIPT_DIR "/remus-netbuf-setup).\n"
       "-F                      Enable unsafe configurations [-b|-n|-d flags]. Use this option\n"
       "                        with caution as failover may not work as intended.\n"
       "-b                      Replicate memory checkpoints to /dev/null (blackhole).\n"