Files
mixer-tools/docs/mixer.versions.1
Geoffroy Van Cutsem 5e1ccb804d doc: update man pages based on latest ReST documents
Update the man pages to reflect the latest content from the original content in
the .rst (ReST) documents.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-10-16 16:20:42 +02:00

111 lines
2.9 KiB
Groff

.\" Man page generated from reStructuredText.
.
.TH MIXER.VERSIONS 1 "" "" ""
.SH NAME
mixer.versions \- Manage mix and upstream versions
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBmixer versions\fP
.sp
\fBmixer versions [command]\fP
.SH DESCRIPTION
.sp
Manage mix and upstream versions. By itself the command will print the current
version of mix and upstream, and also report on the latest version of upstream
available. This command also allows the user to increment the mix version and
optionally the upstream version.
.SH OPTIONS
.sp
In addition to the globally recognized \fBmixer\fP flags (see \fBmixer\fP(1) for
more details), the following options are recognized.
.INDENT 0.0
.IP \(bu 2
\fB\-h, \-\-help\fP
.sp
Display subcommand help information and exit.
.UNINDENT
.SH SUBCOMMANDS
.sp
\fBupdate\fP
.INDENT 0.0
.INDENT 3.5
Increment the mix version to generate a new release. By default the mix
version is incremented by 10, following Clear Linux conventions to leave
room for intermediate versions if necessary. The increment can be configured
with the \fI\-\-increment\fP flag. The \fBupdate\fP command also allows the user to
update the upstream version.
.sp
In addition to the global options \fBmixer versions update\fP takes the
following options.
.INDENT 0.0
.IP \(bu 2
\fB\-\-clear\-version {version}\fP
.sp
Alias to \fI\-\-upstream\-version\fP
.IP \(bu 2
\fB\-c, \-\-config {path}\fP
.sp
Supply the \fIpath\fP to the configuration file to use.
.IP \(bu 2
\fB\-\-increment {number}\fP
.sp
Amount to increment the current mix version (default is 10).
.IP \(bu 2
\fB\-\-mix\-version {version}\fP
.sp
Set a specific mix \fIversion\fP\&.
.IP \(bu 2
\fB\-\-upstream\-version {version}\fP
.sp
Set a specific next upstream version (either version number or the default
"latest" string).
.IP \(bu 2
\fB\-\-skip\-format\-check\fP
.sp
Skip check for compatible upstream format when changing upstream version.
.sp
This command will not update to an upstream version of a different format
("format bumps"). At the moment this needs to be handled manually.
.UNINDENT
.UNINDENT
.UNINDENT
.SH EXIT STATUS
.sp
On success, 0 is returned. A non\-zero return code indicates a failure.
.SS SEE ALSO
.INDENT 0.0
.IP \(bu 2
\fBmixer\fP(1)
.UNINDENT
.SH COPYRIGHT
(C) 2018 Intel Corporation, CC-BY-SA-3.0
.\" Generated by docutils manpage writer.
.