diff mbox series

[v1] docs: substitute XEN_CONFIG_DIR in xl.conf.5

Message ID 20190621093005.29329-1-olaf@aepfle.de (mailing list archive)
State New, archived
Headers show
Series [v1] docs: substitute XEN_CONFIG_DIR in xl.conf.5 | expand

Commit Message

Olaf Hering June 21, 2019, 9:30 a.m. UTC
xl(1) opens xl.conf in XEN_CONFIG_DIR.
Substitute this variable also in the man page.

Signed-off-by: Olaf Hering <olaf@aepfle.de>
---
 docs/man/xl.1.pod.in      | 2 +-
 docs/man/xl.conf.5.pod.in | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Anthony PERARD July 2, 2019, 3:09 p.m. UTC | #1
On Fri, Jun 21, 2019 at 11:30:05AM +0200, Olaf Hering wrote:
> xl(1) opens xl.conf in XEN_CONFIG_DIR.
> Substitute this variable also in the man page.
> 
> Signed-off-by: Olaf Hering <olaf@aepfle.de>
> ---
>  docs/man/xl.1.pod.in      | 2 +-
>  docs/man/xl.conf.5.pod.in | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/man/xl.1.pod.in b/docs/man/xl.1.pod.in
> index 3d64eaa5b2..fb17153635 100644
> --- a/docs/man/xl.1.pod.in
> +++ b/docs/man/xl.1.pod.in
> @@ -50,7 +50,7 @@ setup the bridge.
>  
>  If you specify the amount of memory dom0 has, passing B<dom0_mem> to
>  Xen, it is highly recommended to disable B<autoballoon>. Edit
> -B</etc/xen/xl.conf> and set it to 0.
> +B<@XEN_CONFIG_DIR@/xl.conf> and set it to 0.
>  
>  =item run xl as B<root>
>  
> diff --git a/docs/man/xl.conf.5.pod.in b/docs/man/xl.conf.5.pod.in
> index 2beb2119a8..b16036aaeb 100644
> --- a/docs/man/xl.conf.5.pod.in
> +++ b/docs/man/xl.conf.5.pod.in
> @@ -1,6 +1,6 @@
>  =head1 NAME
>  
> -/etc/xen/xl.conf - XL Global/Host Configuration 
> +@XEN_CONFIG_DIR@/xl.conf - XL Global/Host Configuration 

There's a trailing whitespace, it would be worth removing it. git
complain about it.

The patch seems to depends on "Use XEN_SCRIPT_DIR to refer to
/etc/xen/scripts", but the email doesn't mention it. It would have been
useful to add a note bellow the '---' line or send in a series of patch.

Beside that:
Reviewed-by: Anthony PERARD <anthony.perard@citrix.com>

Thanks,
Wei Liu Aug. 18, 2019, 5:20 p.m. UTC | #2
On Fri, Jun 21, 2019 at 11:30:05AM +0200, Olaf Hering wrote:
> xl(1) opens xl.conf in XEN_CONFIG_DIR.
> Substitute this variable also in the man page.
> 
> Signed-off-by: Olaf Hering <olaf@aepfle.de>
> ---
>  docs/man/xl.1.pod.in      | 2 +-
>  docs/man/xl.conf.5.pod.in | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/man/xl.1.pod.in b/docs/man/xl.1.pod.in
> index 3d64eaa5b2..fb17153635 100644
> --- a/docs/man/xl.1.pod.in
> +++ b/docs/man/xl.1.pod.in
> @@ -50,7 +50,7 @@ setup the bridge.
>  
>  If you specify the amount of memory dom0 has, passing B<dom0_mem> to
>  Xen, it is highly recommended to disable B<autoballoon>. Edit
> -B</etc/xen/xl.conf> and set it to 0.
> +B<@XEN_CONFIG_DIR@/xl.conf> and set it to 0.
>  
>  =item run xl as B<root>
>  
> diff --git a/docs/man/xl.conf.5.pod.in b/docs/man/xl.conf.5.pod.in
> index 2beb2119a8..b16036aaeb 100644
> --- a/docs/man/xl.conf.5.pod.in
> +++ b/docs/man/xl.conf.5.pod.in

Sorry for the late reply.

This doesn't apply. There is no such file.

Wei.

> @@ -1,6 +1,6 @@
>  =head1 NAME
>  
> -/etc/xen/xl.conf - XL Global/Host Configuration 
> +@XEN_CONFIG_DIR@/xl.conf - XL Global/Host Configuration 
>  
>  =head1 DESCRIPTION
>
Andrew Cooper Aug. 18, 2019, 5:27 p.m. UTC | #3
On 18/08/2019 18:20, Wei Liu wrote:
> On Fri, Jun 21, 2019 at 11:30:05AM +0200, Olaf Hering wrote:
>> xl(1) opens xl.conf in XEN_CONFIG_DIR.
>> Substitute this variable also in the man page.
>>
>> Signed-off-by: Olaf Hering <olaf@aepfle.de>
>> ---
>>  docs/man/xl.1.pod.in      | 2 +-
>>  docs/man/xl.conf.5.pod.in | 2 +-
>>  2 files changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/docs/man/xl.1.pod.in b/docs/man/xl.1.pod.in
>> index 3d64eaa5b2..fb17153635 100644
>> --- a/docs/man/xl.1.pod.in
>> +++ b/docs/man/xl.1.pod.in
>> @@ -50,7 +50,7 @@ setup the bridge.
>>  
>>  If you specify the amount of memory dom0 has, passing B<dom0_mem> to
>>  Xen, it is highly recommended to disable B<autoballoon>. Edit
>> -B</etc/xen/xl.conf> and set it to 0.
>> +B<@XEN_CONFIG_DIR@/xl.conf> and set it to 0.
>>  
>>  =item run xl as B<root>
>>  
>> diff --git a/docs/man/xl.conf.5.pod.in b/docs/man/xl.conf.5.pod.in
>> index 2beb2119a8..b16036aaeb 100644
>> --- a/docs/man/xl.conf.5.pod.in
>> +++ b/docs/man/xl.conf.5.pod.in
> Sorry for the late reply.
>
> This doesn't apply. There is no such file.

Hmm.  We have a xl.conf.5.pod which has no substitutions in, and I don't
recall this changing.  Perhaps a logical dependency earlier in the SUSE
patch queue?

I think this patch needs a {pod=>pod.in} rename as well, for it to apply
to staging and work as intended.

~Andrew
Olaf Hering Aug. 19, 2019, 7:57 a.m. UTC | #4
Am Sun, 18 Aug 2019 18:20:26 +0100
schrieb Wei Liu <wl@xen.org>:

> This doesn't apply. There is no such file.

My changes need to be applied in this order, some of them may apply in any order:

20190619120633.27466-1-olaf@aepfle.de
20190619121715.28532-1-olaf@aepfle.de
20190619123818.30747-1-olaf@aepfle.de
20190619130335.3458-1-olaf@aepfle.de
20190621092944.29241-1-olaf@aepfle.de
20190621093005.29329-1-olaf@aepfle.de


Olaf
Wei Liu Aug. 19, 2019, 8 a.m. UTC | #5
On Sun, Aug 18, 2019 at 06:27:26PM +0100, Andrew Cooper wrote:
> On 18/08/2019 18:20, Wei Liu wrote:
> > On Fri, Jun 21, 2019 at 11:30:05AM +0200, Olaf Hering wrote:
> >> xl(1) opens xl.conf in XEN_CONFIG_DIR.
> >> Substitute this variable also in the man page.
> >>
> >> Signed-off-by: Olaf Hering <olaf@aepfle.de>
> >> ---
> >>  docs/man/xl.1.pod.in      | 2 +-
> >>  docs/man/xl.conf.5.pod.in | 2 +-
> >>  2 files changed, 2 insertions(+), 2 deletions(-)
> >>
> >> diff --git a/docs/man/xl.1.pod.in b/docs/man/xl.1.pod.in
> >> index 3d64eaa5b2..fb17153635 100644
> >> --- a/docs/man/xl.1.pod.in
> >> +++ b/docs/man/xl.1.pod.in
> >> @@ -50,7 +50,7 @@ setup the bridge.
> >>  
> >>  If you specify the amount of memory dom0 has, passing B<dom0_mem> to
> >>  Xen, it is highly recommended to disable B<autoballoon>. Edit
> >> -B</etc/xen/xl.conf> and set it to 0.
> >> +B<@XEN_CONFIG_DIR@/xl.conf> and set it to 0.
> >>  
> >>  =item run xl as B<root>
> >>  
> >> diff --git a/docs/man/xl.conf.5.pod.in b/docs/man/xl.conf.5.pod.in
> >> index 2beb2119a8..b16036aaeb 100644
> >> --- a/docs/man/xl.conf.5.pod.in
> >> +++ b/docs/man/xl.conf.5.pod.in
> > Sorry for the late reply.
> >
> > This doesn't apply. There is no such file.
> 
> Hmm.  We have a xl.conf.5.pod which has no substitutions in, and I don't
> recall this changing.  Perhaps a logical dependency earlier in the SUSE
> patch queue?
> 
> I think this patch needs a {pod=>pod.in} rename as well, for it to apply
> to staging and work as intended.

I figured that as well.

Perhaps I missed the patch that did the renaming from Olaf.
Unfortunately I don't have the full xen-devel archive in my mailbox now.

Wei.

> 
> ~Andrew
Wei Liu Aug. 19, 2019, 8:02 a.m. UTC | #6
On Mon, Aug 19, 2019 at 09:57:17AM +0200, Olaf Hering wrote:
> Am Sun, 18 Aug 2019 18:20:26 +0100
> schrieb Wei Liu <wl@xen.org>:
> 
> > This doesn't apply. There is no such file.
> 
> My changes need to be applied in this order, some of them may apply in any order:
> 
> 20190619120633.27466-1-olaf@aepfle.de
> 20190619121715.28532-1-olaf@aepfle.de
> 20190619123818.30747-1-olaf@aepfle.de
> 20190619130335.3458-1-olaf@aepfle.de
> 20190621092944.29241-1-olaf@aepfle.de
> 20190621093005.29329-1-olaf@aepfle.de

Thanks. I will take a look.

Wei.

> 
> 
> Olaf
diff mbox series

Patch

diff --git a/docs/man/xl.1.pod.in b/docs/man/xl.1.pod.in
index 3d64eaa5b2..fb17153635 100644
--- a/docs/man/xl.1.pod.in
+++ b/docs/man/xl.1.pod.in
@@ -50,7 +50,7 @@  setup the bridge.
 
 If you specify the amount of memory dom0 has, passing B<dom0_mem> to
 Xen, it is highly recommended to disable B<autoballoon>. Edit
-B</etc/xen/xl.conf> and set it to 0.
+B<@XEN_CONFIG_DIR@/xl.conf> and set it to 0.
 
 =item run xl as B<root>
 
diff --git a/docs/man/xl.conf.5.pod.in b/docs/man/xl.conf.5.pod.in
index 2beb2119a8..b16036aaeb 100644
--- a/docs/man/xl.conf.5.pod.in
+++ b/docs/man/xl.conf.5.pod.in
@@ -1,6 +1,6 @@ 
 =head1 NAME
 
-/etc/xen/xl.conf - XL Global/Host Configuration 
+@XEN_CONFIG_DIR@/xl.conf - XL Global/Host Configuration 
 
 =head1 DESCRIPTION