[pve-devel] [PATCH manager] pveperf: remove outated POD replaced by pve-docs

Thomas Lamprecht t.lamprecht at proxmox.com
Mon Feb 13 10:00:16 CET 2017



Am 13.02.2017 um 08:12 schrieb Fabian Grünbichler:
> On Fri, Feb 10, 2017 at 08:53:55PM +0100, Thomas Lamprecht wrote:
>> Remove the POD content and the overwriting makefile rule
>> 'pveperf.1.pod' so that the rule from pve-doc-generator.mk matches
>>
>> Signed-off-by: Thomas Lamprecht <t.lamprecht at proxmox.com>
>> ---
>>
>> The following binaries have POD contents which isn't already in pve-docs:
>> * pveupgrade
>> * pvereport
>> * pveversion
>> * pvesh
>>
>> Should those get converted to .adoc and moved to pve-docs (maybe even extended
>> a bit during this process), or was there a reason to keep them here?
>
> IIRC, the plan was to make pveperf, pvereport and pveversion (simple)
> instances of CLIHandler and convert the old pod content to actual (API)
> docs where appropriate.
>
> the other two and pveudpate are kind of special: the update/upgrade
> scripts should work without a fully working API to allow fixing botched
> partial upgrades, and making pvesh part of the API does not really make
> sense. so we could move the content to pve-docs, but leave the scripts
> as they are? I think it will be only rarely updated anyhow for
> pveupdate, pveupgrade and pvesh..
>

That was my plan, I didn't want to touch code in this case,
just talked about the documentation :)

But I can do the CLI handle conversion for pveperf,
pvereport and pveversion if I touch then anyway.






More information about the pve-devel mailing list