xapi-project / xen-api / 37908117216
79%

DEFAULT BRANCH: master
Ran
Jobs 1
Files 36
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 78.996%. Remained the same
37908117216

push

github

web-flow 
CP-47028: Generate Get-Help content for the PowerShell SDK cmdlets (#7316)

None of the PowerShell SDK's cmdlets has any help. Get-Help Invoke-XenVM
shows a syntax line and nothing else: no synopsis, no description, no
parameter text and no examples. Yet the datamodel already holds all of
that text, and the C# SDK already includes it as doc comments.

This PR generates Get-Help content for all 399 cmdlets from the
datamodel, in the same generator run that builds the cmdlets. It builds
on #7313, which moved the cmdlet files to mustache templates.

What a user gets

- A synopsis and description for every cmdlet. They come from the
datamodel's operation, field and class docs. Get, New and Remove cmdlets
say what the cmdlet does, then add the operation's own doc, which is
where conditions such as "the VM must be halted" live.
- Text for every parameter, including the dynamic parameters that
Invoke-Xen<Class> and Get-Xen<Class>Property add at runtime. Each of
those says which -XenAction values accept it.
- At least three titled examples per cmdlet, 1,206 in total. Each
example in a set differs in something worth knowing, such as a
constructor's parameter sets, the alternative ways of naming an object,
or -WhatIf on a destructor. Real arguments are chosen from each
parameter's type, never a placeholder. Hand-written examples are added
for common tasks: the VM lifecycle, clone and provision, snapshot and
revert, migration, disk resize, host maintenance and similar.
- Help for the hand-written cmdlets too (Connect-XenServer, Wait-XenTask
and others). For example, Connect-XenServer now shows how a script
retries against the pool coordinator when it gets HOST_IS_SLAVE, and how
to log in as a domain user rather than root.
- Deprecated and removed cmdlets are labelled. 52 cmdlets now open their
synopsis with [Deprecated] or [Removed], and their description with a
one-line notice. Until now they documented themselves exactly like
current ones.

Commits

1. Move th... (continued)

3667 of 4642 relevant lines covered (79.0%)

0.79 hits per line

Jobs
ID Job ID Ran Files Coverage
1 python3.11 - 37908117216.1 36
79.0
GitHub Action Run
Source Files on build 37908117216