[Bug default/28663] New: generate man page for kmidiff

[Bug default/28663] New: generate man page for kmidiff

[grawlinson at archlinux dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=28663

            Bug ID: 28663
           Summary: generate man page for kmidiff
           Product: libabigail
           Version: unspecified
            Status: UNCONFIRMED
          Severity: enhancement
          Priority: P2
         Component: default
          Assignee: dodji at redhat dot com
          Reporter: grawlinson at archlinux dot org
                CC: libabigail at sourceware dot org
  Target Milestone: ---

Created attachment 13828
  --> https://sourceware.org/bugzilla/attachment.cgi?id=13828&action=edit
generate man page for kmidiff

I've started packaging this for Arch Linux's AUR, and I noticed that a man page
is not generated for kmidiff. I've attached a patch that successfully generates
one, but it will need adjusting. I do not know the author(s) of the particular
documentation, therefore have put 'unknown' in that field.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

Re: [Bug default/28663] New: generate man page for kmidiff

[Dodji Seketeli]

Hello George,

grawlinson at archlinux dot org via Libabigail <libabigail@sourceware.org> a écrit:

[...]

> Created attachment 13828
>   --> https://sourceware.org/bugzilla/attachment.cgi?id=13828&action=edit
> generate man page for kmidiff
>
> I've started packaging this for Arch Linux's AUR, and I noticed that a man page
> is not generated for kmidiff. I've attached a patch that successfully generates
> one, but it will need adjusting. I do not know the author(s) of the particular
> documentation, therefore have put 'unknown' in that field.

Thank you very much!

I took your patch, adapted it a little bit and committed this patch to
the master branch as a result.

Thanks!

From eb3e549794d059294cf1f4a63865e6eb7af8b2e3 Mon Sep 17 00:00:00 2001
From: George Rawlinson <grawlinson@archlinux.org>
Date: Wed, 19 Jan 2022 11:49:47 +0100
Subject: [PATCH] Bug 28663 - generate man page for kmidiff

This patch is based on a patch submitted to this bug report by George
Rawlinson <grawlinson@archlinux.org>.

It generates a man page for the kmidiff tool.

	* doc/manuals/conf.py: Update copyright year.  Generate man page
	for the kmidiff tool.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
---
 doc/manuals/conf.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/manuals/conf.py b/doc/manuals/conf.py
index a0967a26..1e372865 100644
--- a/doc/manuals/conf.py
+++ b/doc/manuals/conf.py
@@ -41,7 +41,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'Libabigail'
-copyright = u'2014-2016, Red Hat, Inc.'
+copyright = u'2014-2022, Red Hat, Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -220,6 +220,7 @@ man_pages = [
     ('abilint', 'abilint', u'validate an abigail ABI representation', [u'Dodji Seketeli'], 1),
     ('abicompat', 'abicompat', u'check ABI compatibility', [u'Dodji Seketeli'], 1),
     ('fedabipkgdiff', 'fedabipkgdiff', u'compare ABIs of Fedora packages', [u'Chenxiong Qi'], 1),
+    ('kmidiff', 'kmidiff', u'compare KMIs of Linux Kernel trees', [u'Dodji Seketeli'], 1),
 ]
 
 # If true, show URL addresses after external links.
-- 
2.33.1


-- 
		Dodji

[Bug default/28663] generate man page for kmidiff

[dodji at seketeli dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=28663

--- Comment #1 from dodji at seketeli dot org ---
Hello George,

grawlinson at archlinux dot org via Libabigail <libabigail@sourceware.org> a
écrit:

[...]

> Created attachment 13828
>   --> https://sourceware.org/bugzilla/attachment.cgi?id=13828&action=edit
> generate man page for kmidiff
>
> I've started packaging this for Arch Linux's AUR, and I noticed that a man page
> is not generated for kmidiff. I've attached a patch that successfully generates
> one, but it will need adjusting. I do not know the author(s) of the particular
> documentation, therefore have put 'unknown' in that field.

Thank you very much!

I took your patch, adapted it a little bit and committed this patch to
the master branch as a result.

Thanks!

From eb3e549794d059294cf1f4a63865e6eb7af8b2e3 Mon Sep 17 00:00:00 2001
From: George Rawlinson <grawlinson@archlinux.org>
Date: Wed, 19 Jan 2022 11:49:47 +0100
Subject: [PATCH] Bug 28663 - generate man page for kmidiff

This patch is based on a patch submitted to this bug report by George
Rawlinson <grawlinson@archlinux.org>.

It generates a man page for the kmidiff tool.

        * doc/manuals/conf.py: Update copyright year.  Generate man page
        for the kmidiff tool.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
---
 doc/manuals/conf.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/manuals/conf.py b/doc/manuals/conf.py
index a0967a26..1e372865 100644
--- a/doc/manuals/conf.py
+++ b/doc/manuals/conf.py
@@ -41,7 +41,7 @@ master_doc = 'index'

 # General information about the project.
 project = u'Libabigail'
-copyright = u'2014-2016, Red Hat, Inc.'
+copyright = u'2014-2022, Red Hat, Inc.'

 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -220,6 +220,7 @@ man_pages = [
     ('abilint', 'abilint', u'validate an abigail ABI representation', [u'Dodji
Seketeli'], 1),
     ('abicompat', 'abicompat', u'check ABI compatibility', [u'Dodji
Seketeli'], 1),
     ('fedabipkgdiff', 'fedabipkgdiff', u'compare ABIs of Fedora packages',
[u'Chenxiong Qi'], 1),
+    ('kmidiff', 'kmidiff', u'compare KMIs of Linux Kernel trees', [u'Dodji
Seketeli'], 1),
 ]

 # If true, show URL addresses after external links.

-- 
You are receiving this mail because:
You are on the CC list for the bug.