xe manpages #957

Merged
merged 6 commits into from Apr 22, 2013

5 participants

@grantmcwilliams

Manpages for the following xe subcommands.

xe-pif-param-clear
xe-pif-param-get
xe-pif-param-list
xe-pif-param-remove

Let us know about syntax, formatting etc. on these 4. We 50 more in the pipe passing internal peer review.

@xen-git
Xapi Project member

Can one of the admins verify this patch?

@jonludlam
Xapi Project member

Thanks, the man pages look great!

I have a minor question - I'm simply not sure of the protocol here, but what does the 'AUTHORS' section mean? Is it authorship of the manpage or of the tool it's describing?

@robhoes robhoes and 1 other commented on an outdated diff Jan 14, 2013
docs/en/man/man1/xe-pif-param-clear.ad
+*param-name*::
+ Parameter to be cleared for a PIF interface (e.g. other-config).
+
+EXAMPLES
+--------
+
+To clear all values found in the other-config parameter: ::
+ *xe pif-param-clear* uuid=<PIF UUID> param-name="other-config"
+
+SEE ALSO
+--------
+*xe-pif-list*(1), *xe-pif-param-list*(1), *xe-pif-param-remove*(1), *xe-pif-param-set*(1), *xe-network-list*(1), *xe-vlan-list*(1)
+
+BUGS
+----
+Send bugs to xen-devel@lists.xen.org, see http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP on how to send bug reports. General questions can be sent to xen-api@lists.xen.org.
@robhoes
Xapi Project member
robhoes added a line comment Jan 14, 2013

Bugs in xe/xapi are better sent to xen-api@lists.xen.org, not xen-devel. Xen-devel is more for hypervisor-level matter.

@grantmcwilliams
grantmcwilliams added a line comment Jan 14, 2013

Noted, we'll make the changes.

Also for Jon - This is from the manpage Howto.

"The AUTHOR section

...is nice to have in case there are gross errors in the documentation or program behaviour (Bzzt!) and you want to mail a bug report."

So it appears to be either/or. Perhaps we should specify. I want the manpage team to get credit but not undue credit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@Mattsface

What do you guys think of changes?

Looks good.

@jonludlam
Xapi Project member

Look good thanks! What do you want to do about installing these? At the moment this is just adding the man pages to the repository - are you intending to add them to the RPMs so they're present in dom0?

@grantmcwilliams

Preferably they'd be distributed. On our side we have a script that creates manpages from the asciidoc source and we've created a SPEC file for the RPM itself. None of this is done though. When it's done we can share that too if there's interest.

@xen-git
Xapi Project member

Can one of the admins verify this patch?

@xen-git
Xapi Project member

Can one of the admins verify this patch?

@xen-git
Xapi Project member

Can one of the admins verify this patch?

@djs55
@jonludlam
Xapi Project member

Apologies for the delay in merging - I think we had aspirations of doing some more autogeneration in this area, but it's not going to happen soon. Thanks very much for doing this work - we'd certainly be interested in the spec file changes to get these installed.

@jonludlam jonludlam merged commit 2b057d9 into xapi-project:master Apr 22, 2013
@grantmcwilliams

Thanks Jon. We're upping our schedule to get more pages. Out we have a ton in the works but need to sign off on them internally before handing them over. Also we're working on moving our project more public so people can see what we're working on.

I'll put the RPM generation back on front burner.

@dichen001 dichen001 referenced this pull request in dichen001/Paper-Reading Jun 28, 2016
Open

Summary of the 20 issues in Herbsleb's 2014 FSE paper. #6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment