[PATCH v3 15/30] docstring: function: lxc: Add 'Since version' metadata

Victor Toso posted 30 patches 3 years, 9 months ago
There is a newer version of this series
[PATCH v3 15/30] docstring: function: lxc: Add 'Since version' metadata
Posted by Victor Toso 3 years, 9 months ago
Either create or append to existing docstring, the version (git tag)
that a given function was introduced in the format:

    Since: v1.2.3

Signed-off-by: Victor Toso <victortoso@redhat.com>
---
 src/libvirt-lxc.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/libvirt-lxc.c b/src/libvirt-lxc.c
index 2a271b74f0..14a2f2a6ec 100644
--- a/src/libvirt-lxc.c
+++ b/src/libvirt-lxc.c
@@ -59,6 +59,9 @@ VIR_LOG_INIT("libvirt-lxc");
  * the setns() system call.
  *
  * Returns the number of opened file descriptors, or -1 on error
+ *
+ * Since: v1.0.2
+ *
  */
 int
 virDomainLxcOpenNamespace(virDomainPtr domain,
@@ -115,6 +118,9 @@ virDomainLxcOpenNamespace(virDomainPtr domain,
  * the caller to switch back to its current namespace later
  *
  * Returns 0 on success, -1 on error
+ *
+ * Since: v1.0.2
+ *
  */
 int
 virDomainLxcEnterNamespace(virDomainPtr domain,
@@ -182,6 +188,9 @@ virDomainLxcEnterNamespace(virDomainPtr domain,
  * exec() has yet been performed.
  *
  * Returns 0 on success, -1 on error
+ *
+ * Since: v1.0.4
+ *
  */
 int
 virDomainLxcEnterSecurityLabel(virSecurityModelPtr model,
@@ -283,6 +292,9 @@ virDomainLxcEnterSecurityLabel(virSecurityModelPtr model,
  * with the container @domain.
  *
  * Returns 0 on success, -1 on error
+ *
+ * Since: v2.0.0
+ *
  */
 int virDomainLxcEnterCGroup(virDomainPtr domain,
                             unsigned int flags)
-- 
2.35.1
Re: [PATCH v3 15/30] docstring: function: lxc: Add 'Since version' metadata
Posted by Peter Krempa 3 years, 9 months ago
On Wed, Apr 20, 2022 at 21:08:04 +0200, Victor Toso wrote:
> Either create or append to existing docstring, the version (git tag)
> that a given function was introduced in the format:
> 
>     Since: v1.2.3
> 
> Signed-off-by: Victor Toso <victortoso@redhat.com>
> ---
>  src/libvirt-lxc.c | 12 ++++++++++++
>  1 file changed, 12 insertions(+)

Reviewed-by: Peter Krempa <pkrempa@redhat.com>