Skip to content

Commit b66383f

Browse files
FrostyXFrostyX
committed
Temporarily add manpages to the repository
There is a missing python3-click-man package for EPEL8 and therefore we cannot generate the manpages on the fly. They are temporarily commited into git repo. Once RHBZ 1900423 gets resolved, just uncomment the following line. Please see https://bugzilla.redhat.com/show_bug.cgi?id=1900423
1 parent 2c8e8d5 commit b66383f

File tree

6 files changed

+177
-1
lines changed

6 files changed

+177
-1
lines changed

‎man/createrepo_mod.1‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.TH createrepo_mod "1" Manual
2+
.SH NAME
3+
createrepo_mod
4+
.SH SYNOPSIS
5+
.B createrepo_mod
6+
[-h] directory_to_index
7+
.SH DESCRIPTION
8+
A small wrapper around createrepo_c and modifyrepo_c toprovide an easy tool
9+
for generating module repositories
10+
.SH OPTIONS
11+
.TP
12+
\fBdirectory_to_index\fR
13+
Directory to index
14+
15+
.SH AUTHORS
16+
.B createrepo_mod
17+
was written by Jakub Kadlčík <[email protected]>.
18+
.SH DISTRIBUTION
19+
The latest version of createrepo_mod may be downloaded from
20+
.UR HOMEPAGE
21+
.UE

‎man/dir2module.1‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
.TH dir2module "1" Manual
2+
.SH NAME
3+
dir2module
4+
.SH SYNOPSIS
5+
.B dir2module
6+
[-h] -m SUMMARY [-d DESCRIPTION] [-l LICENSE] [-r REQUIRES] [--force] [--stdout] (--dir DIR | --pkglist PKGLIST) nsvca
7+
.SH DESCRIPTION
8+
Recursively read RPMs from DIR or read them from specified pkglist.If any RPM
9+
is missing on unreadable, error out.Populate artifacts/rpms with RPM
10+
NEVRAs.Populate license/content with list of RPM licenses.Write
11+
N:S:V:C:A.modulemd.yaml in the current directory.Make sure the yaml is in
12+
modulemd v2 format.
13+
.SH OPTIONS
14+
.TP
15+
\fBnsvca\fR
16+
Module name, stream version, context and architecture in a N:S:V:C:A format
17+
18+
.TP
19+
\fB\-m\fR \fI\,SUMMARY\/\fR, \fB\-\-summary\fR \fI\,SUMMARY\/\fR
20+
Module summary
21+
22+
.TP
23+
\fB\-d\fR \fI\,DESCRIPTION\/\fR, \fB\-\-description\fR \fI\,DESCRIPTION\/\fR
24+
Module description
25+
26+
.TP
27+
\fB\-l\fR \fI\,LICENSE\/\fR, \fB\-\-license\fR \fI\,LICENSE\/\fR
28+
Module license
29+
30+
.TP
31+
\fB\-r\fR \fI\,REQUIRES\/\fR, \fB\-\-requires\fR \fI\,REQUIRES\/\fR
32+
Module runtime dependencies in a N:S format. For multiple dependencies, repeat
33+
this option
34+
35+
.TP
36+
\fB\-\-force\fR
37+
Suppress all constraints and hope for the best
38+
39+
.TP
40+
\fB\-\-stdout\fR
41+
By defult the output is saved in a file. Use this to suppress it and print to
42+
the STDOUT
43+
44+
.TP
45+
\fB\-\-dir\fR \fI\,DIR\/\fR
46+
.TP
47+
\fB\-\-pkglist\fR \fI\,PKGLIST\/\fR
48+
49+
.SH AUTHORS
50+
.B dir2module
51+
was written by Jakub Kadlčík <[email protected]>.
52+
.SH DISTRIBUTION
53+
The latest version of dir2module may be downloaded from
54+
.UR HOMEPAGE
55+
.UE

‎man/modulemd-generate-macros.1‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.TH modulemd-generate-macros "1" Manual
2+
.SH NAME
3+
modulemd-generate-macros
4+
.SH SYNOPSIS
5+
.B modulemd-generate-macros
6+
[-h] [--disttag DISTTAG] [--conflicts-from-file CONFLICTS_FROM_FILE] yaml
7+
.SH DESCRIPTION
8+
Generate `module\-build\-macros` SRPM package, which is a central piece for
9+
building modules. It should be present in the buildroot before any other
10+
module packages are submitted to be built.
11+
.SH OPTIONS
12+
.TP
13+
\fByaml\fR
14+
Path to modulemd YAML file
15+
16+
.TP
17+
\fB\-\-disttag\fR \fI\,DISTTAG\/\fR
18+
Disttag
19+
20+
.TP
21+
\fB\-\-conflicts\-from\-file\fR \fI\,CONFLICTS_FROM_FILE\/\fR
22+
Path to a file containing conflicts definitions and their reasoning. Content
23+
of this file gets simply pasted into the specfile
24+
25+
.SH AUTHORS
26+
.B modulemd\-generate\-macros
27+
was written by Jakub Kadlčík <[email protected]>.
28+
.SH DISTRIBUTION
29+
The latest version of modulemd\-generate\-macros may be downloaded from
30+
.UR HOMEPAGE
31+
.UE

‎man/modulemd-merge.1‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.TH modulemd-merge "1" Manual
2+
.SH NAME
3+
modulemd-merge
4+
.SH SYNOPSIS
5+
.B modulemd-merge
6+
[-h] [-v] [-d] [-i] input [input ...] output
7+
.SH DESCRIPTION
8+
Merge several modules.yaml files (rpm modularity metadata) into one.
9+
.SH OPTIONS
10+
.TP
11+
\fBinput\fR
12+
input filename(s) or directories.
13+
repomd.xml files are parsed and modules hrefs contained are merged.
14+
If a directory is given, it is searched for repodata/repomd.xml and repomd.xml
15+
16+
.TP
17+
\fBoutput\fR
18+
YAML output filename
19+
20+
.TP
21+
\fB\-v\fR, \fB\-\-verbose\fR
22+
increase output verbosity
23+
24+
.TP
25+
\fB\-d\fR, \fB\-\-debug\fR
26+
debug output verbosity
27+
28+
.TP
29+
\fB\-i\fR, \fB\-\-ignore\-no\-input\fR
30+
ignore non\-existing input files
31+
32+
.SH AUTHORS
33+
.B modulemd\-merge
34+
was written by Gerd v. Egidy <[email protected]>.
35+
.SH DISTRIBUTION
36+
The latest version of modulemd\-merge may be downloaded from
37+
.UR HOMEPAGE
38+
.UE

‎man/repo2module.1‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.TH "REPO2MODULE" "1" "2020-11-22" "" "repo2module Manual"
2+
.SH NAME
3+
repo2module \- Generates modules.yaml file with a module,...
4+
.SH SYNOPSIS
5+
.B repo2module
6+
[OPTIONS] REPO_PATH [MODULES_YAML]
7+
.SH DESCRIPTION
8+
Generates modules.yaml file with a module, that provides all RPM packages that are available within a repository.
9+
.SH OPTIONS
10+
.TP
11+
\fB\-d,\fP \-\-debug / \-\-nodebug
12+
.PP
13+
.TP
14+
\fB\-n,\fP \-\-module\-name TEXT
15+
[default: (Current directory name)]
16+
.TP
17+
\fB\-s,\fP \-\-module\-stream TEXT
18+
[default: rolling]
19+
.TP
20+
\fB\-v,\fP \-\-module\-version INTEGER
21+
[default: 1]
22+
.TP
23+
\fB\-c,\fP \-\-module\-context TEXT
24+
[default: abcdef12]

‎modulemd-tools.spec‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ BuildRequires: python3-devel
1515
BuildRequires: python3-setuptools
1616
BuildRequires: python3-gobject
1717
BuildRequires: python3-click
18+
%if ! 0%{?rhel}
1819
BuildRequires: python3-click-man
20+
%endif
1921
BuildRequires: python3-dnf
2022
BuildRequires: python3-hawkey
2123
BuildRequires: python3-createrepo_c
@@ -61,7 +63,12 @@ modulemd-generate-macros - Generate module-build-macros SRPM package, which is
6163
cd repo2module
6264
%py3_build
6365
cd ..
64-
PYTHONPATH=./modulemd_tools ./man/generate-manpages.sh
66+
67+
# There is a missing python3-click-man package for EPEL8 and therefore we cannot
68+
# generate the manpages on the fly. They are temporarily commited into git repo.
69+
# Once RHBZ 1900423 gets resolved, just uncomment the following line. Please see
70+
# https://bugzilla.redhat.com/show_bug.cgi?id=1900423
71+
# PYTHONPATH=./modulemd_tools ./man/generate-manpages.sh
6572

6673

6774
%install

0 commit comments

Comments
 (0)