Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

xe manpages #957

Merged
merged 6 commits into from Apr 22, 2013
Merged

xe manpages #957

merged 6 commits into from Apr 22, 2013

Conversation

grantmcwilliams
Copy link
Contributor

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
Copy link
Contributor

xen-git commented Dec 31, 2012

Can one of the admins verify this patch?

@jonludlam
Copy link
Collaborator

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?


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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@jonludlam
Copy link
Collaborator

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
Copy link
Contributor Author

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
Copy link
Contributor

xen-git commented Feb 2, 2013

Can one of the admins verify this patch?

1 similar comment
@xen-git
Copy link
Contributor

xen-git commented Feb 25, 2013

Can one of the admins verify this patch?

@xen-git
Copy link
Contributor

xen-git commented Mar 27, 2013

Can one of the admins verify this patch?

@djs55
Copy link
Collaborator

djs55 commented Mar 27, 2013

ok to test

On Wed, Mar 27, 2013 at 5:30 PM, xen-git notifications@github.com wrote:

Can one of the admins verify this patch?

Reply to this email directly or view it on GitHubhttps://github.com//pull/957#issuecomment-15538644
.

Dave Scott

@jonludlam
Copy link
Collaborator

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 pushed a commit that referenced this pull request Apr 22, 2013
@jonludlam jonludlam merged commit 2b057d9 into xapi-project:master Apr 22, 2013
@grantmcwilliams
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants