[Qemu-devel] [PATCH] doc: fix the configuration path

Marc-André Lureau posted 1 patch 5 years, 4 months ago
Test docker-mingw@fedora passed
Test asan passed
Test checkpatch passed
Test docker-clang@ubuntu passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20181126105125.30973-1-marcandre.lureau@redhat.com
Maintainers: Michael Roth <mdroth@linux.vnet.ibm.com>
Makefile     | 9 ++++++---
qemu-ga.texi | 4 ++--
2 files changed, 8 insertions(+), 5 deletions(-)
[Qemu-devel] [PATCH] doc: fix the configuration path
Posted by Marc-André Lureau 5 years, 4 months ago
Use a CONFDIR variable to show the configured sysconf path in the
generated documentations (html, man pages etc).

Related to:
https://bugzilla.redhat.com/show_bug.cgi?id=1644985

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
 Makefile     | 9 ++++++---
 qemu-ga.texi | 4 ++--
 2 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/Makefile b/Makefile
index 9cc4dae1a6..a39c231d1c 100644
--- a/Makefile
+++ b/Makefile
@@ -932,11 +932,14 @@ ui/shader.o: $(SRC_PATH)/ui/shader.c \
 MAKEINFO=makeinfo
 MAKEINFOINCLUDES= -I docs -I $(<D) -I $(@D)
 MAKEINFOFLAGS=--no-split --number-sections $(MAKEINFOINCLUDES)
-TEXI2PODFLAGS=$(MAKEINFOINCLUDES) "-DVERSION=$(VERSION)"
+TEXI2PODFLAGS=$(MAKEINFOINCLUDES) -DVERSION="$(VERSION)" -DCONFDIR="$(qemu_confdir)"
 TEXI2PDFFLAGS=$(if $(V),,--quiet) -I $(SRC_PATH) $(MAKEINFOINCLUDES)
 
-docs/version.texi: $(SRC_PATH)/VERSION
-	$(call quiet-command,echo "@set VERSION $(VERSION)" > $@,"GEN","$@")
+docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
+	$(call quiet-command,(\
+		echo "@set VERSION $(VERSION)" && \
+		echo "@set CONFDIR $(qemu_confdir)" \
+	)> $@,"GEN","$@")
 
 %.html: %.texi docs/version.texi
 	$(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \
diff --git a/qemu-ga.texi b/qemu-ga.texi
index 4c7a8fd163..f00ad830f2 100644
--- a/qemu-ga.texi
+++ b/qemu-ga.texi
@@ -30,7 +30,7 @@ set user's password
 @end itemize
 
 qemu-ga will read a system configuration file on startup (located at
-@file{/etc/qemu/qemu-ga.conf} by default), then parse remaining
+@file{@value{CONFDIR}/qemu-ga.conf} by default), then parse remaining
 configuration options on the command line. For the same key, the last
 option wins, but the lists accumulate (see below for configuration
 file format).
@@ -58,7 +58,7 @@ file format).
   Enable fsfreeze hook. Accepts an optional argument that specifies
   script to run on freeze/thaw. Script will be called with
   'freeze'/'thaw' arguments accordingly (default is
-  @samp{/etc/qemu/fsfreeze-hook}). If using -F with an argument, do
+  @samp{@value{CONFDIR}/fsfreeze-hook}). If using -F with an argument, do
   not follow -F with a space (for example:
   @samp{-F/var/run/fsfreezehook.sh}).
 
-- 
2.20.0.rc1


Re: [Qemu-devel] [PATCH] doc: fix the configuration path
Posted by Philippe Mathieu-Daudé 5 years, 1 month ago
On 11/26/18 11:51 AM, Marc-André Lureau wrote:
> Use a CONFDIR variable to show the configured sysconf path in the
> generated documentations (html, man pages etc).
> 
> Related to:
> https://bugzilla.redhat.com/show_bug.cgi?id=1644985
> 
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>

Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>

> ---
>  Makefile     | 9 ++++++---
>  qemu-ga.texi | 4 ++--
>  2 files changed, 8 insertions(+), 5 deletions(-)
> 
> diff --git a/Makefile b/Makefile
> index 9cc4dae1a6..a39c231d1c 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -932,11 +932,14 @@ ui/shader.o: $(SRC_PATH)/ui/shader.c \
>  MAKEINFO=makeinfo
>  MAKEINFOINCLUDES= -I docs -I $(<D) -I $(@D)
>  MAKEINFOFLAGS=--no-split --number-sections $(MAKEINFOINCLUDES)
> -TEXI2PODFLAGS=$(MAKEINFOINCLUDES) "-DVERSION=$(VERSION)"
> +TEXI2PODFLAGS=$(MAKEINFOINCLUDES) -DVERSION="$(VERSION)" -DCONFDIR="$(qemu_confdir)"
>  TEXI2PDFFLAGS=$(if $(V),,--quiet) -I $(SRC_PATH) $(MAKEINFOINCLUDES)
>  
> -docs/version.texi: $(SRC_PATH)/VERSION
> -	$(call quiet-command,echo "@set VERSION $(VERSION)" > $@,"GEN","$@")
> +docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
> +	$(call quiet-command,(\
> +		echo "@set VERSION $(VERSION)" && \
> +		echo "@set CONFDIR $(qemu_confdir)" \
> +	)> $@,"GEN","$@")
>  
>  %.html: %.texi docs/version.texi
>  	$(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \
> diff --git a/qemu-ga.texi b/qemu-ga.texi
> index 4c7a8fd163..f00ad830f2 100644
> --- a/qemu-ga.texi
> +++ b/qemu-ga.texi
> @@ -30,7 +30,7 @@ set user's password
>  @end itemize
>  
>  qemu-ga will read a system configuration file on startup (located at
> -@file{/etc/qemu/qemu-ga.conf} by default), then parse remaining
> +@file{@value{CONFDIR}/qemu-ga.conf} by default), then parse remaining
>  configuration options on the command line. For the same key, the last
>  option wins, but the lists accumulate (see below for configuration
>  file format).
> @@ -58,7 +58,7 @@ file format).
>    Enable fsfreeze hook. Accepts an optional argument that specifies
>    script to run on freeze/thaw. Script will be called with
>    'freeze'/'thaw' arguments accordingly (default is
> -  @samp{/etc/qemu/fsfreeze-hook}). If using -F with an argument, do
> +  @samp{@value{CONFDIR}/fsfreeze-hook}). If using -F with an argument, do
>    not follow -F with a space (for example:
>    @samp{-F/var/run/fsfreezehook.sh}).
>  
> 

Re: [Qemu-devel] [PATCH] doc: fix the configuration path
Posted by Thomas Huth 4 years, 12 months ago
On 07/02/2019 17.31, Philippe Mathieu-Daudé wrote:
> On 11/26/18 11:51 AM, Marc-André Lureau wrote:
>> Use a CONFDIR variable to show the configured sysconf path in the
>> generated documentations (html, man pages etc).
>>
>> Related to:
>> https://bugzilla.redhat.com/show_bug.cgi?id=1644985
>>
>> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> 
> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> 
>> ---
>>  Makefile     | 9 ++++++---
>>  qemu-ga.texi | 4 ++--
>>  2 files changed, 8 insertions(+), 5 deletions(-)
>>
>> diff --git a/Makefile b/Makefile
>> index 9cc4dae1a6..a39c231d1c 100644
>> --- a/Makefile
>> +++ b/Makefile
>> @@ -932,11 +932,14 @@ ui/shader.o: $(SRC_PATH)/ui/shader.c \
>>  MAKEINFO=makeinfo
>>  MAKEINFOINCLUDES= -I docs -I $(<D) -I $(@D)
>>  MAKEINFOFLAGS=--no-split --number-sections $(MAKEINFOINCLUDES)
>> -TEXI2PODFLAGS=$(MAKEINFOINCLUDES) "-DVERSION=$(VERSION)"
>> +TEXI2PODFLAGS=$(MAKEINFOINCLUDES) -DVERSION="$(VERSION)" -DCONFDIR="$(qemu_confdir)"
>>  TEXI2PDFFLAGS=$(if $(V),,--quiet) -I $(SRC_PATH) $(MAKEINFOINCLUDES)
>>  
>> -docs/version.texi: $(SRC_PATH)/VERSION
>> -	$(call quiet-command,echo "@set VERSION $(VERSION)" > $@,"GEN","$@")
>> +docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
>> +	$(call quiet-command,(\
>> +		echo "@set VERSION $(VERSION)" && \
>> +		echo "@set CONFDIR $(qemu_confdir)" \
>> +	)> $@,"GEN","$@")
>>  
>>  %.html: %.texi docs/version.texi
>>  	$(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \
>> diff --git a/qemu-ga.texi b/qemu-ga.texi
>> index 4c7a8fd163..f00ad830f2 100644
>> --- a/qemu-ga.texi
>> +++ b/qemu-ga.texi
>> @@ -30,7 +30,7 @@ set user's password
>>  @end itemize
>>  
>>  qemu-ga will read a system configuration file on startup (located at
>> -@file{/etc/qemu/qemu-ga.conf} by default), then parse remaining
>> +@file{@value{CONFDIR}/qemu-ga.conf} by default), then parse remaining
>>  configuration options on the command line. For the same key, the last
>>  option wins, but the lists accumulate (see below for configuration
>>  file format).
>> @@ -58,7 +58,7 @@ file format).
>>    Enable fsfreeze hook. Accepts an optional argument that specifies
>>    script to run on freeze/thaw. Script will be called with
>>    'freeze'/'thaw' arguments accordingly (default is
>> -  @samp{/etc/qemu/fsfreeze-hook}). If using -F with an argument, do
>> +  @samp{@value{CONFDIR}/fsfreeze-hook}). If using -F with an argument, do
>>    not follow -F with a space (for example:
>>    @samp{-F/var/run/fsfreezehook.sh}).

Ping^2

I think this could also go via qemu-trivial...?

 Thomas

Re: [Qemu-devel] [Qemu-trivial] [PATCH] doc: fix the configuration path
Posted by Laurent Vivier 4 years, 11 months ago
On 30/03/2019 17:30, Thomas Huth wrote:
> On 07/02/2019 17.31, Philippe Mathieu-Daudé wrote:
>> On 11/26/18 11:51 AM, Marc-André Lureau wrote:
>>> Use a CONFDIR variable to show the configured sysconf path in the
>>> generated documentations (html, man pages etc).
>>>
>>> Related to:
>>> https://bugzilla.redhat.com/show_bug.cgi?id=1644985
>>>
>>> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
>>
>> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
>>
>>> ---
>>>  Makefile     | 9 ++++++---
>>>  qemu-ga.texi | 4 ++--
>>>  2 files changed, 8 insertions(+), 5 deletions(-)
>>>
>>> diff --git a/Makefile b/Makefile
>>> index 9cc4dae1a6..a39c231d1c 100644
>>> --- a/Makefile
>>> +++ b/Makefile
>>> @@ -932,11 +932,14 @@ ui/shader.o: $(SRC_PATH)/ui/shader.c \
>>>  MAKEINFO=makeinfo
>>>  MAKEINFOINCLUDES= -I docs -I $(<D) -I $(@D)
>>>  MAKEINFOFLAGS=--no-split --number-sections $(MAKEINFOINCLUDES)
>>> -TEXI2PODFLAGS=$(MAKEINFOINCLUDES) "-DVERSION=$(VERSION)"
>>> +TEXI2PODFLAGS=$(MAKEINFOINCLUDES) -DVERSION="$(VERSION)" -DCONFDIR="$(qemu_confdir)"
>>>  TEXI2PDFFLAGS=$(if $(V),,--quiet) -I $(SRC_PATH) $(MAKEINFOINCLUDES)
>>>  
>>> -docs/version.texi: $(SRC_PATH)/VERSION
>>> -	$(call quiet-command,echo "@set VERSION $(VERSION)" > $@,"GEN","$@")
>>> +docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
>>> +	$(call quiet-command,(\
>>> +		echo "@set VERSION $(VERSION)" && \
>>> +		echo "@set CONFDIR $(qemu_confdir)" \
>>> +	)> $@,"GEN","$@")
>>>  
>>>  %.html: %.texi docs/version.texi
>>>  	$(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \
>>> diff --git a/qemu-ga.texi b/qemu-ga.texi
>>> index 4c7a8fd163..f00ad830f2 100644
>>> --- a/qemu-ga.texi
>>> +++ b/qemu-ga.texi
>>> @@ -30,7 +30,7 @@ set user's password
>>>  @end itemize
>>>  
>>>  qemu-ga will read a system configuration file on startup (located at
>>> -@file{/etc/qemu/qemu-ga.conf} by default), then parse remaining
>>> +@file{@value{CONFDIR}/qemu-ga.conf} by default), then parse remaining
>>>  configuration options on the command line. For the same key, the last
>>>  option wins, but the lists accumulate (see below for configuration
>>>  file format).
>>> @@ -58,7 +58,7 @@ file format).
>>>    Enable fsfreeze hook. Accepts an optional argument that specifies
>>>    script to run on freeze/thaw. Script will be called with
>>>    'freeze'/'thaw' arguments accordingly (default is
>>> -  @samp{/etc/qemu/fsfreeze-hook}). If using -F with an argument, do
>>> +  @samp{@value{CONFDIR}/fsfreeze-hook}). If using -F with an argument, do
>>>    not follow -F with a space (for example:
>>>    @samp{-F/var/run/fsfreezehook.sh}).
> 
> Ping^2
> 
> I think this could also go via qemu-trivial...?
> 
>  Thomas
> 

Applied to my trivial-patches branch.

Thanks,
Laurent

Re: [Qemu-devel] [PATCH] doc: fix the configuration path
Posted by Marc-André Lureau 5 years, 1 month ago
On Mon, Nov 26, 2018 at 11:51 AM Marc-André Lureau
<marcandre.lureau@redhat.com> wrote:
>
> Use a CONFDIR variable to show the configured sysconf path in the
> generated documentations (html, man pages etc).
>
> Related to:
> https://bugzilla.redhat.com/show_bug.cgi?id=1644985
>
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>

ping

> ---
>  Makefile     | 9 ++++++---
>  qemu-ga.texi | 4 ++--
>  2 files changed, 8 insertions(+), 5 deletions(-)
>
> diff --git a/Makefile b/Makefile
> index 9cc4dae1a6..a39c231d1c 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -932,11 +932,14 @@ ui/shader.o: $(SRC_PATH)/ui/shader.c \
>  MAKEINFO=makeinfo
>  MAKEINFOINCLUDES= -I docs -I $(<D) -I $(@D)
>  MAKEINFOFLAGS=--no-split --number-sections $(MAKEINFOINCLUDES)
> -TEXI2PODFLAGS=$(MAKEINFOINCLUDES) "-DVERSION=$(VERSION)"
> +TEXI2PODFLAGS=$(MAKEINFOINCLUDES) -DVERSION="$(VERSION)" -DCONFDIR="$(qemu_confdir)"
>  TEXI2PDFFLAGS=$(if $(V),,--quiet) -I $(SRC_PATH) $(MAKEINFOINCLUDES)
>
> -docs/version.texi: $(SRC_PATH)/VERSION
> -       $(call quiet-command,echo "@set VERSION $(VERSION)" > $@,"GEN","$@")
> +docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
> +       $(call quiet-command,(\
> +               echo "@set VERSION $(VERSION)" && \
> +               echo "@set CONFDIR $(qemu_confdir)" \
> +       )> $@,"GEN","$@")
>
>  %.html: %.texi docs/version.texi
>         $(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \
> diff --git a/qemu-ga.texi b/qemu-ga.texi
> index 4c7a8fd163..f00ad830f2 100644
> --- a/qemu-ga.texi
> +++ b/qemu-ga.texi
> @@ -30,7 +30,7 @@ set user's password
>  @end itemize
>
>  qemu-ga will read a system configuration file on startup (located at
> -@file{/etc/qemu/qemu-ga.conf} by default), then parse remaining
> +@file{@value{CONFDIR}/qemu-ga.conf} by default), then parse remaining
>  configuration options on the command line. For the same key, the last
>  option wins, but the lists accumulate (see below for configuration
>  file format).
> @@ -58,7 +58,7 @@ file format).
>    Enable fsfreeze hook. Accepts an optional argument that specifies
>    script to run on freeze/thaw. Script will be called with
>    'freeze'/'thaw' arguments accordingly (default is
> -  @samp{/etc/qemu/fsfreeze-hook}). If using -F with an argument, do
> +  @samp{@value{CONFDIR}/fsfreeze-hook}). If using -F with an argument, do
>    not follow -F with a space (for example:
>    @samp{-F/var/run/fsfreezehook.sh}).
>
> --
> 2.20.0.rc1
>