diff mbox

[OSSTEST,v2] README: Be less confusing about Tftp settings

Message ID 1476713515-1129-1-git-send-email-ian.jackson@eu.citrix.com (mailing list archive)
State New, archived
Headers show

Commit Message

Ian Jackson Oct. 17, 2016, 2:11 p.m. UTC
Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
---
v2: Give the scope-free version as the basic explanation
---
 README | 40 +++++++++++++++++++++++-----------------
 1 file changed, 23 insertions(+), 17 deletions(-)

Comments

Konrad Rzeszutek Wilk Oct. 17, 2016, 2:19 p.m. UTC | #1
On Mon, Oct 17, 2016 at 03:11:55PM +0100, Ian Jackson wrote:
> Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
> CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>

CCing Marcos.
> ---
> v2: Give the scope-free version as the basic explanation
> ---
>  README | 40 +++++++++++++++++++++++-----------------
>  1 file changed, 23 insertions(+), 17 deletions(-)
> 
> diff --git a/README b/README
> index 01c4c96..078888d 100644
> --- a/README
> +++ b/README
> @@ -390,7 +390,7 @@ HostProp_<testbox>_RebootTimeExtra
>  
>  HostProp_<testbox>_TftpScope
>     Defines the Tftp scope (i.e. subnet) where this host resides. See
> -   "TftpFoo_<scope> and TftpFoo" below.
> +   "TftpFoo_<scope> and TftpFoo" below.  The default is "default".
>  
>  HostProp_<testbox>_NtpServer
>     NTP server to use.  You should probably have your own local
> @@ -490,30 +490,36 @@ DebianNonfreeFirmware
>    grep-dctrl (for example because it's not Debian) then you must set
>    this to the empty string, by writing  DebianNonfreeFirmware=''
>  
> -TftpFoo_<scope> and TftpFoo
> +Tftp*
> +   Settings related to the tftp server:
>  
> -    Describes various properties relating to Tftp in a given <scope>,
> -    where a <scope> is a given subnet, DHCP server etc. Valid
> -    properties are:
> -
> -        Path          The path to the root of the directory which is exposed by
> +    TftpPath          The path to the root of the directory which is exposed by
>                        the tftpserver (e.g. /tftpboot).
> -        TmpDir        A directory under `Path' to use for temporary files.
> +    TftpTmpDir        A directory under `Path' to use for temporary files.
>  
> -        PxeDir        The path under `Path' to the PXE configuration directory
> +    TftpPxeDir        The path under `Path' to the PXE configuration directory
>                        (e.g. pxelinux.cfg)
> -        PxeGroup      The Unix group which should own files under `PxeDir'.
> -        PxeTemplates  See TftpPxeTemplates
> -        PxeTemplatesReal
> +    TftpPxeGroup      The Unix group which should own files under `PxeDir'.
> +    TftpPxeTemplates  See TftpPxeTemplates
> +    TftpPxeTemplatesReal
>  
> -        DiBase        The path under `Path' to the root of the debian
> +    TftpDiBase        The path under `Path' to the root of the debian
>                        installer images.
> -        GrubBase      The path under `Path' to the root of the grub
> +    TftpGrubBase      The path under `Path' to the root of the grub
>                        EFI PXE images.
>  
> -    For hosts in scope "default", TftpFoo_default (if set) takes
> -    precedence over TftpFoo.  TftpFoo is used when the setting Foo is
> -    not defined for the host's scope.
> +Tftp<setting>_<scope>
> +
> +    It is possible to have multiple subnets, DHCP servers, tftp
> +    servers, etc.  Each one is a <scope>, referenced by
> +    HostProp_<testbox>_TftpScope.
> +
> +    For hosts in scope <scope>, Tftp<setting>_<scope> (if set) takes
> +    precedence over each Tftp<setting> listed above.
> +
> +    So for hosts in scope "default" (including ones without an

s/So for/For/

s/scope/the scope/ ?

> +    explicit TftpScope) Tftp<setting> is used whenever
> +    Tftp<setting>_default is not defined.
>  
>  TftpPxeTemplates
>      List (space-separated) of template filenames for writing
> -- 
> 2.1.4
>
diff mbox

Patch

diff --git a/README b/README
index 01c4c96..078888d 100644
--- a/README
+++ b/README
@@ -390,7 +390,7 @@  HostProp_<testbox>_RebootTimeExtra
 
 HostProp_<testbox>_TftpScope
    Defines the Tftp scope (i.e. subnet) where this host resides. See
-   "TftpFoo_<scope> and TftpFoo" below.
+   "TftpFoo_<scope> and TftpFoo" below.  The default is "default".
 
 HostProp_<testbox>_NtpServer
    NTP server to use.  You should probably have your own local
@@ -490,30 +490,36 @@  DebianNonfreeFirmware
   grep-dctrl (for example because it's not Debian) then you must set
   this to the empty string, by writing  DebianNonfreeFirmware=''
 
-TftpFoo_<scope> and TftpFoo
+Tftp*
+   Settings related to the tftp server:
 
-    Describes various properties relating to Tftp in a given <scope>,
-    where a <scope> is a given subnet, DHCP server etc. Valid
-    properties are:
-
-        Path          The path to the root of the directory which is exposed by
+    TftpPath          The path to the root of the directory which is exposed by
                       the tftpserver (e.g. /tftpboot).
-        TmpDir        A directory under `Path' to use for temporary files.
+    TftpTmpDir        A directory under `Path' to use for temporary files.
 
-        PxeDir        The path under `Path' to the PXE configuration directory
+    TftpPxeDir        The path under `Path' to the PXE configuration directory
                       (e.g. pxelinux.cfg)
-        PxeGroup      The Unix group which should own files under `PxeDir'.
-        PxeTemplates  See TftpPxeTemplates
-        PxeTemplatesReal
+    TftpPxeGroup      The Unix group which should own files under `PxeDir'.
+    TftpPxeTemplates  See TftpPxeTemplates
+    TftpPxeTemplatesReal
 
-        DiBase        The path under `Path' to the root of the debian
+    TftpDiBase        The path under `Path' to the root of the debian
                       installer images.
-        GrubBase      The path under `Path' to the root of the grub
+    TftpGrubBase      The path under `Path' to the root of the grub
                       EFI PXE images.
 
-    For hosts in scope "default", TftpFoo_default (if set) takes
-    precedence over TftpFoo.  TftpFoo is used when the setting Foo is
-    not defined for the host's scope.
+Tftp<setting>_<scope>
+
+    It is possible to have multiple subnets, DHCP servers, tftp
+    servers, etc.  Each one is a <scope>, referenced by
+    HostProp_<testbox>_TftpScope.
+
+    For hosts in scope <scope>, Tftp<setting>_<scope> (if set) takes
+    precedence over each Tftp<setting> listed above.
+
+    So for hosts in scope "default" (including ones without an
+    explicit TftpScope) Tftp<setting> is used whenever
+    Tftp<setting>_default is not defined.
 
 TftpPxeTemplates
     List (space-separated) of template filenames for writing