docs: add some Xenstore related man pages

[PATCH 3/4] docs: add man page for xenstore-rm

Posted by Juergen Gross 1 week, 4 days ago

There is no man page for xenstore-rm, add it.

Signed-off-by: Juergen Gross <jgross@suse.com>
---
 docs/man/xenstore-rm.1.pod | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 docs/man/xenstore-rm.1.pod

diff --git a/docs/man/xenstore-rm.1.pod b/docs/man/xenstore-rm.1.pod
new file mode 100644
index 0000000000..a85b971113
--- /dev/null
+++ b/docs/man/xenstore-rm.1.pod
@@ -0,0 +1,24 @@
+=head1 NAME
+
+xenstore-rm - remove Xenstore keys
+
+=head1 SYNOPSIS
+
+B<xenstore-rm> [I<OPTION>]... [I<PATH>]...
+
+=head1 DESCRIPTION
+
+Remove one or more Xenstore B<PATH>s.
+
+=over
+
+=item B<-t>
+
+Tidy up Xenstore keys which got all children removed.
+
+=back
+
+=head1 BUGS
+
+Send bugs to xen-devel@lists.xenproject.org, see
+https://wiki.xenproject.org/wiki/Reporting_Bugs_against_Xen_Project on how to send bug reports.
-- 
2.53.0

Re: [PATCH 3/4] docs: add man page for xenstore-rm

Posted by Andrew Cooper 1 week, 4 days ago

On 12/03/2026 12:22 pm, Juergen Gross wrote:
> There is no man page for xenstore-rm, add it.
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
> ---
>  docs/man/xenstore-rm.1.pod | 24 ++++++++++++++++++++++++
>  1 file changed, 24 insertions(+)
>  create mode 100644 docs/man/xenstore-rm.1.pod
>
> diff --git a/docs/man/xenstore-rm.1.pod b/docs/man/xenstore-rm.1.pod
> new file mode 100644
> index 0000000000..a85b971113
> --- /dev/null
> +++ b/docs/man/xenstore-rm.1.pod
> @@ -0,0 +1,24 @@
> +=head1 NAME
> +
> +xenstore-rm - remove Xenstore keys
> +
> +=head1 SYNOPSIS
> +
> +B<xenstore-rm> [I<OPTION>]... [I<PATH>]...
> +
> +=head1 DESCRIPTION
> +
> +Remove one or more Xenstore B<PATH>s.
> +
> +=over
> +
> +=item B<-t>
> +
> +Tidy up Xenstore keys which got all children removed.
> +
> +=back
> +
> +=head1 BUGS
> +
> +Send bugs to xen-devel@lists.xenproject.org, see
> +https://wiki.xenproject.org/wiki/Reporting_Bugs_against_Xen_Project on how to send bug reports.

# xenstore-rm
xenstore-rm: Usage: xenstore-rm [-h] [-t] key [...]

Looking at xenstore_client.c, this is common to all.  Shouldn't it be
included in the manpages ?

~Andrew

Re: [PATCH 3/4] docs: add man page for xenstore-rm

Posted by Jürgen Groß 1 week, 4 days ago

On 12.03.26 14:22, Andrew Cooper wrote:
> On 12/03/2026 12:22 pm, Juergen Gross wrote:
>> There is no man page for xenstore-rm, add it.
>>
>> Signed-off-by: Juergen Gross <jgross@suse.com>
>> ---
>>   docs/man/xenstore-rm.1.pod | 24 ++++++++++++++++++++++++
>>   1 file changed, 24 insertions(+)
>>   create mode 100644 docs/man/xenstore-rm.1.pod
>>
>> diff --git a/docs/man/xenstore-rm.1.pod b/docs/man/xenstore-rm.1.pod
>> new file mode 100644
>> index 0000000000..a85b971113
>> --- /dev/null
>> +++ b/docs/man/xenstore-rm.1.pod
>> @@ -0,0 +1,24 @@
>> +=head1 NAME
>> +
>> +xenstore-rm - remove Xenstore keys
>> +
>> +=head1 SYNOPSIS
>> +
>> +B<xenstore-rm> [I<OPTION>]... [I<PATH>]...
>> +
>> +=head1 DESCRIPTION
>> +
>> +Remove one or more Xenstore B<PATH>s.
>> +
>> +=over
>> +
>> +=item B<-t>
>> +
>> +Tidy up Xenstore keys which got all children removed.
>> +
>> +=back
>> +
>> +=head1 BUGS
>> +
>> +Send bugs to xen-devel@lists.xenproject.org, see
>> +https://wiki.xenproject.org/wiki/Reporting_Bugs_against_Xen_Project on how to send bug reports.
> 
> # xenstore-rm
> xenstore-rm: Usage: xenstore-rm [-h] [-t] key [...]
> 
> Looking at xenstore_client.c, this is common to all.  Shouldn't it be
> included in the manpages ?

Hmm, maybe a good idea.

I'll add a patch adding it to the already existing man pages and add it
in each of the 4 new man pages.


Juergen

Re: [PATCH 3/4] docs: add man page for xenstore-rm

Posted by Juergen Gross 1 week, 4 days ago

On 12.03.26 14:49, Jürgen Groß wrote:
> On 12.03.26 14:22, Andrew Cooper wrote:
>> On 12/03/2026 12:22 pm, Juergen Gross wrote:
>>> There is no man page for xenstore-rm, add it.
>>>
>>> Signed-off-by: Juergen Gross <jgross@suse.com>
>>> ---
>>>   docs/man/xenstore-rm.1.pod | 24 ++++++++++++++++++++++++
>>>   1 file changed, 24 insertions(+)
>>>   create mode 100644 docs/man/xenstore-rm.1.pod
>>>
>>> diff --git a/docs/man/xenstore-rm.1.pod b/docs/man/xenstore-rm.1.pod
>>> new file mode 100644
>>> index 0000000000..a85b971113
>>> --- /dev/null
>>> +++ b/docs/man/xenstore-rm.1.pod
>>> @@ -0,0 +1,24 @@
>>> +=head1 NAME
>>> +
>>> +xenstore-rm - remove Xenstore keys
>>> +
>>> +=head1 SYNOPSIS
>>> +
>>> +B<xenstore-rm> [I<OPTION>]... [I<PATH>]...
>>> +
>>> +=head1 DESCRIPTION
>>> +
>>> +Remove one or more Xenstore B<PATH>s.
>>> +
>>> +=over
>>> +
>>> +=item B<-t>
>>> +
>>> +Tidy up Xenstore keys which got all children removed.
>>> +
>>> +=back
>>> +
>>> +=head1 BUGS
>>> +
>>> +Send bugs to xen-devel@lists.xenproject.org, see
>>> +https://wiki.xenproject.org/wiki/Reporting_Bugs_against_Xen_Project on how 
>>> to send bug reports.
>>
>> # xenstore-rm
>> xenstore-rm: Usage: xenstore-rm [-h] [-t] key [...]
>>
>> Looking at xenstore_client.c, this is common to all.  Shouldn't it be
>> included in the manpages ?
> 
> Hmm, maybe a good idea.
> 
> I'll add a patch adding it to the already existing man pages and add it
> in each of the 4 new man pages.

Hmm, and I think it is not appropriate to exit with "1" when using the
"-h" parameter. I'll add another patch to fix that.


Juergen