Skip to content

Commit 629a60b

Browse files
committed
man: Rebuild documentation
Signed-off-by: Ikey Doherty <ikey@solus-project.com>
1 parent fb84a9c commit 629a60b

File tree

8 files changed

+51
-8
lines changed

8 files changed

+51
-8
lines changed

man/package.yml.5

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" generated with Ronn/v0.7.3
22
.\" http://github.com/rtomayko/ronn/tree/0.7.3
33
.
4-
.TH "PACKAGE\.YML" "5" "December 2016" "" ""
4+
.TH "PACKAGE\.YML" "5" "May 2017" "" ""
55
.
66
.SH "NAME"
77
\fBpackage\.yml\fR \- Solus package build format
@@ -246,6 +246,18 @@ All files captured by this expression will then end up in that subpackage\. Each
246246
\fBypkg\-build(1)\fR ensures that a file cannot belong to multiple packages, and that the last specified pattern, if matching, ALWAYS wins\. It is even possible to supress generation of the main package, by pattern globbing \fB/*\fR to a subpackage\. This will not cause any breakage\.
247247
.
248248
.IP "\(bu" 4
249+
\fBpermanent\fR [list]
250+
.
251+
.IP
252+
A list of patterns used to mark files as permanent\. Any file within the resulting binary packages that matches the path pattern, is marked as a permanent file\.
253+
.
254+
.IP
255+
These files will not be removed from the filesystem when upgrading or reinstalling the package\. They will persist during standard upgrade operations\.
256+
.
257+
.IP
258+
This should only be used in critical chain packages such as the kernel or drivers, where the domain of control is outside of the package manager, and the package is simply used as an update delivery mechanism\.
259+
.
260+
.IP "\(bu" 4
249261
\fBstrip\fR [boolean]
250262
.
251263
.IP
@@ -258,6 +270,15 @@ In most cases, stripping should remain enabled\. However, there are known cases
258270
The Go programming language generates \fB*\.a\fR archive files that under no circumstance should be stripped, and there are likely other cases\. This key, when set to \fBno\fR, will disable any and all stripping\.
259271
.
260272
.IP "\(bu" 4
273+
\fBdebug\fR [boolean]
274+
.
275+
.IP
276+
By default, this key is enabled, and as a result \fBypkg\-build(1)\fR will automatically create resulting \fB\-dbginfo\fR packages where it can\.
277+
.
278+
.IP
279+
In the majority of cases, this is the desired behaviour in full build environments, such as a build server\. However in very rare cases, this may cause problems for the package, especially if it contains binaries that have not been bootstrapped with the native toolchain\.
280+
.
281+
.IP "\(bu" 4
261282
\fBavx2\fR [boolean]
262283
.
263284
.IP

man/package.yml.5.html

Lines changed: 23 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/ypkg-build.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" generated with Ronn/v0.7.3
22
.\" http://github.com/rtomayko/ronn/tree/0.7.3
33
.
4-
.TH "YPKG\-BUILD" "1" "December 2016" "" ""
4+
.TH "YPKG\-BUILD" "1" "May 2017" "" ""
55
.
66
.SH "NAME"
77
\fBypkg\-build\fR \- Build Solus ypkg files

man/ypkg-build.1.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/ypkg-install-deps.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" generated with Ronn/v0.7.3
22
.\" http://github.com/rtomayko/ronn/tree/0.7.3
33
.
4-
.TH "YPKG\-INSTALL\-DEPS" "1" "December 2016" "" ""
4+
.TH "YPKG\-INSTALL\-DEPS" "1" "May 2017" "" ""
55
.
66
.SH "NAME"
77
\fBypkg\-install\-deps\fR \- Install build dependencies

man/ypkg-install-deps.1.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/ypkg.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" generated with Ronn/v0.7.3
22
.\" http://github.com/rtomayko/ronn/tree/0.7.3
33
.
4-
.TH "YPKG" "1" "December 2016" "" ""
4+
.TH "YPKG" "1" "May 2017" "" ""
55
.
66
.SH "NAME"
77
\fBypkg\fR \- Build Solus ypkg files

man/ypkg.1.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)