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

Juergen Gross posted 8 patches 1 week, 4 days ago
[PATCH v2 4/8] 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>
---
V2:
- add -h parameter description (Andrew Cooper)
---
 docs/man/xenstore-rm.1.pod | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 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..40e3e581eb
--- /dev/null
+++ b/docs/man/xenstore-rm.1.pod
@@ -0,0 +1,28 @@
+=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<-h>
+
+Show the usage information for xenstore-rm and exit the program.
+
+=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 v2 4/8] docs: add man page for xenstore-rm
Posted by Andrew Cooper 1 week, 4 days ago
On 12/03/2026 3:50 pm, Juergen Gross wrote:
> diff --git a/docs/man/xenstore-rm.1.pod b/docs/man/xenstore-rm.1.pod
> new file mode 100644
> index 0000000000..40e3e581eb
> --- /dev/null
> +++ b/docs/man/xenstore-rm.1.pod
> @@ -0,0 +1,28 @@
> +=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<-h>
> +
> +Show the usage information for xenstore-rm and exit the program.
> +
> +=item B<-t>
> +
> +Tidy up Xenstore keys which got all children removed.

Sorry for not spotting this before.  "which had all".

Also it occurs to me that "Tidy up" is not sufficiently close to
delete/remove for the behaviour to be apparent to everyone.  Perhaps
"Tidy up (i.e. remove) Xenstore ..."  ?

The phrase "Tidy up" does need to stay at the start of the sentence
because otherwise there's no hope of knowing what -t stands for.

~Andrew

Re: [PATCH v2 4/8] docs: add man page for xenstore-rm
Posted by Juergen Gross 1 week, 4 days ago
On 12.03.26 16:58, Andrew Cooper wrote:
> On 12/03/2026 3:50 pm, Juergen Gross wrote:
>> diff --git a/docs/man/xenstore-rm.1.pod b/docs/man/xenstore-rm.1.pod
>> new file mode 100644
>> index 0000000000..40e3e581eb
>> --- /dev/null
>> +++ b/docs/man/xenstore-rm.1.pod
>> @@ -0,0 +1,28 @@
>> +=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<-h>
>> +
>> +Show the usage information for xenstore-rm and exit the program.
>> +
>> +=item B<-t>
>> +
>> +Tidy up Xenstore keys which got all children removed.
> 
> Sorry for not spotting this before.  "which had all".
> 
> Also it occurs to me that "Tidy up" is not sufficiently close to
> delete/remove for the behaviour to be apparent to everyone.  Perhaps
> "Tidy up (i.e. remove) Xenstore ..."  ?
> 
> The phrase "Tidy up" does need to stay at the start of the sentence
> because otherwise there's no hope of knowing what -t stands for.

I'm fine with all of your enhancements.


Juergen