public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Aaron Lauterer <a.lauterer@proxmox.com>
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>,
	Maximiliano Sandoval <m.sandoval@proxmox.com>
Subject: Re: [pve-devel] [PATCH docs] docs: fix typos
Date: Mon, 22 Jul 2024 15:58:36 +0200	[thread overview]
Message-ID: <cede35e8-1476-46a1-9d67-cb48c0494602@proxmox.com> (raw)
In-Reply-To: <20240717130307.1507777-1-m.sandoval@proxmox.com>

Thanks for this patch.

A few things need to be changed in the actually commands/API/… 
definitions as we autogenerate the manual pages.

This is true for any file with `*-synopsis` or `*-opts*` in its name.

Please send a v2 without the synopsis and opts files. For the synopsis 
and opts files, find the source and fix it there.

On  2024-07-17  15:03, Maximiliano Sandoval wrote:
> Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
> ---
>   datacenter.cfg.5-opts.adoc |  2 +-
>   ha-manager.1-synopsis.adoc |  6 +++---
>   ha-manager.adoc            |  2 +-
>   ha-resources-opts.adoc     |  2 +-
>   notifications.adoc         | 12 ++++++------
>   pct.1-synopsis.adoc        |  6 +++---
>   pct.conf.5-opts.adoc       |  2 +-
>   pve-faq.adoc               |  2 +-
>   pve-firewall.adoc          |  2 +-
>   pve-network.adoc           |  4 ++--
>   pveceph.1-synopsis.adoc    |  2 +-
>   pvescheduler.adoc          |  2 +-
>   pvesdn.adoc                |  2 +-
>   pveum.adoc                 |  2 +-
>   qm.1-synopsis.adoc         |  2 +-
>   qm.adoc                    |  2 +-
>   vzdump.adoc                |  2 +-
>   17 files changed, 27 insertions(+), 27 deletions(-)
> 
[…]
> diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc
> index 47e8304..a460ab4 100644
> --- a/pct.1-synopsis.adoc
> +++ b/pct.1-synopsis.adoc
> @@ -140,7 +140,7 @@ Allow to overwrite existing container.
>   
>   `--hookscript` `<string>` ::
>   
> -Script that will be exectued during various steps in the containers lifetime.
> +Script that will be executed during various steps in the containers lifetime.

For example, this line and all the other occurrences of the same line 
come from `pve-container/src/PVE/LXC/Config.pm:602`.


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

  reply	other threads:[~2024-07-22 13:58 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-17 13:03 Maximiliano Sandoval
2024-07-22 13:58 ` Aaron Lauterer [this message]
2024-07-25  8:29   ` Maximiliano Sandoval

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cede35e8-1476-46a1-9d67-cb48c0494602@proxmox.com \
    --to=a.lauterer@proxmox.com \
    --cc=m.sandoval@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal