Blob Blame History Raw
From c1668f6ca11562c12b6910ec8f399eb4e7e2cb3f Mon Sep 17 00:00:00 2001
From: Jakub Kadlcik <frostyx@email.cz>
Date: Tue, 9 Feb 2021 22:34:02 +0100
Subject: [PATCH] Dont generate manpages on the fly

---
 man/createrepo_mod.1           | 21 +++++++++++++
 man/dir2module.1               | 55 ++++++++++++++++++++++++++++++++++
 man/modulemd-generate-macros.1 | 31 +++++++++++++++++++
 man/modulemd-merge.1           | 39 ++++++++++++++++++++++++
 man/repo2module.1              | 27 +++++++++++++++++
 5 files changed, 173 insertions(+)
 create mode 100644 man/createrepo_mod.1
 create mode 100644 man/dir2module.1
 create mode 100644 man/modulemd-generate-macros.1
 create mode 100644 man/modulemd-merge.1
 create mode 100644 man/repo2module.1

diff --git a/man/createrepo_mod.1 b/man/createrepo_mod.1
new file mode 100644
index 0000000..9acdd7d
--- /dev/null
+++ b/man/createrepo_mod.1
@@ -0,0 +1,21 @@
+.TH createrepo_mod "1" Manual
+.SH NAME
+createrepo_mod
+.SH SYNOPSIS
+.B createrepo_mod
+[-h] directory_to_index
+.SH DESCRIPTION
+A small wrapper around createrepo_c and modifyrepo_c toprovide an easy tool
+for generating module repositories
+.SH OPTIONS
+.TP
+\fBdirectory_to_index\fR
+Directory to index
+
+.SH AUTHORS
+.B createrepo_mod
+was written by Jakub Kadlčík <jkadlcik@redhat.com>.
+.SH DISTRIBUTION
+The latest version of createrepo_mod may be downloaded from
+.UR HOMEPAGE
+.UE
diff --git a/man/dir2module.1 b/man/dir2module.1
new file mode 100644
index 0000000..728792e
--- /dev/null
+++ b/man/dir2module.1
@@ -0,0 +1,55 @@
+.TH dir2module "1" Manual
+.SH NAME
+dir2module
+.SH SYNOPSIS
+.B dir2module
+[-h] -m SUMMARY [-d DESCRIPTION] [-l LICENSE] [-r REQUIRES] [--force] [--stdout] (--dir DIR | --pkglist PKGLIST) nsvca
+.SH DESCRIPTION
+Recursively read RPMs from DIR or read them from specified pkglist.If any RPM
+is missing on unreadable, error out.Populate artifacts/rpms with RPM
+NEVRAs.Populate license/content with list of RPM licenses.Write
+N:S:V:C:A.modulemd.yaml in the current directory.Make sure the yaml is in
+modulemd v2 format.
+.SH OPTIONS
+.TP
+\fBnsvca\fR
+Module name, stream version, context and architecture in a N:S:V:C:A format
+
+.TP
+\fB\-m\fR \fI\,SUMMARY\/\fR, \fB\-\-summary\fR \fI\,SUMMARY\/\fR
+Module summary
+
+.TP
+\fB\-d\fR \fI\,DESCRIPTION\/\fR, \fB\-\-description\fR \fI\,DESCRIPTION\/\fR
+Module description
+
+.TP
+\fB\-l\fR \fI\,LICENSE\/\fR, \fB\-\-license\fR \fI\,LICENSE\/\fR
+Module license
+
+.TP
+\fB\-r\fR \fI\,REQUIRES\/\fR, \fB\-\-requires\fR \fI\,REQUIRES\/\fR
+Module runtime dependencies in a N:S format. For multiple dependencies, repeat
+this option
+
+.TP
+\fB\-\-force\fR
+Suppress all constraints and hope for the best
+
+.TP
+\fB\-\-stdout\fR
+By defult the output is saved in a file. Use this to suppress it and print to
+the STDOUT
+
+.TP
+\fB\-\-dir\fR \fI\,DIR\/\fR
+.TP
+\fB\-\-pkglist\fR \fI\,PKGLIST\/\fR
+
+.SH AUTHORS
+.B dir2module
+was written by Jakub Kadlčík <jkadlcik@redhat.com>.
+.SH DISTRIBUTION
+The latest version of dir2module may be downloaded from
+.UR HOMEPAGE
+.UE
diff --git a/man/modulemd-generate-macros.1 b/man/modulemd-generate-macros.1
new file mode 100644
index 0000000..36a1e9a
--- /dev/null
+++ b/man/modulemd-generate-macros.1
@@ -0,0 +1,31 @@
+.TH modulemd-generate-macros "1" Manual
+.SH NAME
+modulemd-generate-macros
+.SH SYNOPSIS
+.B modulemd-generate-macros
+[-h] [--disttag DISTTAG] [--conflicts-from-file CONFLICTS_FROM_FILE] yaml
+.SH DESCRIPTION
+Generate `module\-build\-macros` SRPM package, which is a central piece for
+building modules. It should be present in the buildroot before any other
+module packages are submitted to be built.
+.SH OPTIONS
+.TP
+\fByaml\fR
+Path to modulemd YAML file
+
+.TP
+\fB\-\-disttag\fR \fI\,DISTTAG\/\fR
+Disttag
+
+.TP
+\fB\-\-conflicts\-from\-file\fR \fI\,CONFLICTS_FROM_FILE\/\fR
+Path to a file containing conflicts definitions and their reasoning. Content
+of this file gets simply pasted into the specfile
+
+.SH AUTHORS
+.B modulemd\-generate\-macros
+was written by Jakub Kadlčík <jkadlcik@redhat.com>.
+.SH DISTRIBUTION
+The latest version of modulemd\-generate\-macros may be downloaded from
+.UR HOMEPAGE
+.UE
diff --git a/man/modulemd-merge.1 b/man/modulemd-merge.1
new file mode 100644
index 0000000..3f280ff
--- /dev/null
+++ b/man/modulemd-merge.1
@@ -0,0 +1,39 @@
+.TH modulemd-merge "1" Manual
+.SH NAME
+modulemd-merge
+.SH SYNOPSIS
+.B modulemd-merge
+[-h] [-v] [-d] [-i] input [input ...] output
+.SH DESCRIPTION
+Merge several modules.yaml files (rpm modularity metadata) into one.
+.SH OPTIONS
+.TP
+\fBinput\fR
+input filename(s) or directories.
+repomd.xml files are parsed and modules hrefs contained are merged.
+If a directory is given, it is searched for repodata/repomd.xml
+and repomd.xml
+
+.TP
+\fBoutput\fR
+YAML output filename
+
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+increase output verbosity
+
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+debug output verbosity
+
+.TP
+\fB\-i\fR, \fB\-\-ignore\-no\-input\fR
+ignore non\-existing input files
+
+.SH AUTHORS
+.B modulemd\-merge
+was written by Gerd v. Egidy <gerd.von.egidy@intra2net.com>.
+.SH DISTRIBUTION
+The latest version of modulemd\-merge may be downloaded from
+.UR HOMEPAGE
+.UE
diff --git a/man/repo2module.1 b/man/repo2module.1
new file mode 100644
index 0000000..bdc2aa8
--- /dev/null
+++ b/man/repo2module.1
@@ -0,0 +1,27 @@
+.TH "REPO2MODULE" "1" "2021-02-09" "" "repo2module Manual"
+.SH NAME
+repo2module \- Generates modules.yaml file with a module,...
+.SH SYNOPSIS
+.B repo2module
+[OPTIONS] REPO_PATH [MODULES_YAML]
+.SH DESCRIPTION
+Generates modules.yaml file with a module, that provides all RPM packages that are available within a repository.
+.SH OPTIONS
+.TP
+\fB\-d,\fP \-\-debug / \-\-nodebug
+.PP
+.TP
+\fB\-n,\fP \-\-module\-name TEXT
+[default: (Current directory name)]
+.TP
+\fB\-s,\fP \-\-module\-stream TEXT
+[default: rolling]
+.TP
+\fB\-v,\fP \-\-module\-version INTEGER
+[default: 1]
+.TP
+\fB\-c,\fP \-\-module\-context TEXT
+[default: abcdef12]
+.TP
+\fB\-O,\fP \-\-to\-stdout
+.PP
-- 
2.29.2