From b4de1a75a7be36844b4842d4b47cc6d22aceb417 Mon Sep 17 00:00:00 2001 From: Libor Pechacek Date: Wed, 6 Dec 2017 11:15:52 +0100 Subject: [PATCH] Refresh generated docs Signed-off-by: Libor Pechacek --- doc/cset-proc.1 | 30 ++- doc/cset-proc.html | 601 ++++++++++++++++++++++++++++++++++--------- doc/cset-set.1 | 10 +- doc/cset-set.html | 13 +- doc/cset-shield.1 | 10 +- doc/cset-shield.html | 13 +- doc/cset.1 | 33 ++- doc/cset.html | 589 +++++++++++++++++++++++++++++++++--------- doc/tutorial.html | 13 +- 9 files changed, 1029 insertions(+), 283 deletions(-) diff --git a/doc/cset-proc.1 b/doc/cset-proc.1 index 10a6bbf..67f0106 100644 --- a/doc/cset-proc.1 +++ b/doc/cset-proc.1 @@ -1,13 +1,22 @@ '\" t .\" Title: cset-proc -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 06/09/2011 -.\" Manual: [FIXME: manual] -.\" Source: [FIXME: source] +.\" Author: Alex Tsariounov +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: March 2016 +.\" Manual: \ \& +.\" Source: \ \& 1.5.8 .\" Language: English .\" -.TH "CSET\-PROC" "1" "06/09/2011" "[FIXME: source]" "[FIXME: manual]" +.TH "CSET\-PROC" "1" "March 2016" "\ \& 1\&.5\&.8" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -260,7 +269,7 @@ Cpuset is licensed under the GNU GPL V2 only\&. .SH "COPYRIGHT" Copyright (c) 2008\-2011 Novell Inc\&. .SH "AUTHOR" -Written by Alex Tsariounov \&. +Written by Alex Tsariounov \&. .SH "SEE ALSO" cset(1), cset\-set(1), cset\-shield(1) @@ -269,4 +278,9 @@ cset(1), cset\-set(1), cset\-shield(1) taskset(1), chrt(1) /usr/src/linux/Documentation/cpusets\&.txt - +.SH "AUTHOR" +.PP +\fBAlex Tsariounov\fR <\&tsariounov@gmail\&.com\&> +.RS 4 +Author. +.RE diff --git a/doc/cset-proc.html b/doc/cset-proc.html index e87cf0d..d3b743a 100644 --- a/doc/cset-proc.html +++ b/doc/cset-proc.html @@ -2,15 +2,25 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - - + + cset-proc(1) + - + +
+

SYNOPSIS

-
cset [cset options] proc [proc options] [args] +
cset [cset options] proc [proc options] [args]
 cset proc --help
 cset proc
 cset proc my_set my_other_set
@@ -425,10 +758,12 @@ cset-proc(1) Manual Page
 cset proc --move 2442,3000-3200 my_set
 cset proc --move --pid=2442,3000-3200 --toset=my_set
 cset proc --move --fromset=my_set_1 --toset=my_set_2
-cset proc --move --pid=42 --fromset=/group1/myset --toset=/group2/yourset
-
+cset proc --move --pid=42 --fromset=/group1/myset --toset=/group2/yourset +
+
+

OPTIONS

@@ -550,6 +885,8 @@ cset-proc(1) Manual Page
+
+

DESCRIPTION

This command is used to run and manage arbitrary processes on @@ -559,19 +896,19 @@ threads to specified cpusets. You may note there is no "kill" or

To list which tasks are running in a particular cpuset, use the --list command.

For example:

-

# cset proc --list --set myset

+

# cset proc --list --set myset

This command will list all the tasks running in the cpuset called "myset".

Processes are created by specifying the path to the executable and specifying the cpuset that the process is to be created in.

For example:

-

# cset proc --set=blazing_cpuset --exec /usr/bin/fast_code

+

# cset proc --set=blazing_cpuset --exec /usr/bin/fast_code

This command will execute the /usr/bin/fast_code program on the "blazing_cpuset" cpuset.

Note that if your command takes options, then use the traditional "--" marker to separate cset’s options from your command’s options.

For example:

-

# cset proc --set myset --exec — ls -l

+

# cset proc --set myset --exec — ls -l

This command will execute "ls -l" on the cpuset called "myset".

The PIDSPEC argument taken for the move command is a comma separated list of PIDs or TIDs. The list can also include @@ -580,8 +917,8 @@ endpoints.

For example:

-
1,2,5         Means processes 1, 2 and 5
-1,2,600-700   Means processes 1, 2 and from 600 to 700
+
1,2,5         Means processes 1, 2 and 5
+1,2,600-700   Means processes 1, 2 and from 600 to 700
@@ -600,8 +937,8 @@ or use the short hand and list the cpuset name after the PIDSPEC for the --move arguments.

The move command accepts multiple common calling methods. For example, the following commands are equivalent:

-

# cset proc --move 2442,3000-3200 reserved_set

-

# cset proc --move --pid=2442,3000-3200 --toset=reserved_set

+

# cset proc --move 2442,3000-3200 reserved_set

+

# cset proc --move --pid=2442,3000-3200 --toset=reserved_set

These commands move the tasks defined as 2442 and any running task between 3000 and 3200 inclusive of the ends to the cpuset called "reserved_set".

@@ -628,7 +965,7 @@ and use the --threads option.

To move all userspace tasks from one cpuset to another, you need to specify the source and destination cpuset by name.

For example:

-

# cset proc --move --fromset=comp1 --toset=comp42

+

# cset proc --move --fromset=comp1 --toset=comp42

This command specifies that all processes and threads running on cpuset "comp1" be moved to cpuset "comp42".

@@ -663,34 +1000,42 @@ rooted at the base cpuset tree.

For example, suppose you have the following cpuset tree:

-
/cpusets
+
/cpusets
   /group1
     /myset
     /yourset
   /group2
     /myset
-    /yourset

+    /yourset

Then, to move a process from myset in group1 to yourset in group2, you would have to issue the following command:

-

# cset proc --move --pid=50 --fromset=/group1/myset --toset=/group2/yourset

+

# cset proc --move --pid=50 --fromset=/group1/myset --toset=/group2/yourset

You do not have to worry about where in the Linux filesystem the cpuset filesystem is mounted. The cset command takes care of that. Any cpusets that are specified by path (such as above), are done with respect to the root of the cpuset filesystem.

+ +

LICENSE

Cpuset is licensed under the GNU GPL V2 only.

+
+

COPYRIGHT

Copyright (c) 2008-2011 Novell Inc.

+
+

AUTHOR

Written by Alex Tsariounov <tsariounov@gmail.com>.

+
+

SEE ALSO

cset(1), cset-set(1), cset-shield(1)

@@ -698,10 +1043,14 @@ respect to the root of the cpuset filesystem.

taskset(1), chrt(1)

/usr/src/linux/Documentation/cpusets.txt

+ + +
diff --git a/doc/cset-set.1 b/doc/cset-set.1 index 3620399..91b9ac2 100644 --- a/doc/cset-set.1 +++ b/doc/cset-set.1 @@ -2,12 +2,12 @@ .\" Title: cset-set .\" Author: Alex Tsariounov .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: June 2011 +.\" Date: March 2016 .\" Manual: \ \& -.\" Source: \ \& 1.5.6 +.\" Source: \ \& 1.5.8 .\" Language: English .\" -.TH "CSET\-SET" "1" "June 2011" "\ \& 1\&.5\&.6" "\ \&" +.TH "CSET\-SET" "1" "March 2016" "\ \& 1\&.5\&.8" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -137,7 +137,7 @@ Cpuset is licensed under the GNU GPL V2 only\&. .SH "COPYRIGHT" Copyright (c) 2008\-2011 Novell Inc\&. .SH "AUTHOR" -Written by Alex Tsariounov \&. +Written by Alex Tsariounov \&. .SH "SEE ALSO" cset(1), cset\-proc(1), cset\-shield(1) @@ -148,7 +148,7 @@ taskset(1), chrt(1) /usr/src/linux/Documentation/cpusets\&.txt .SH "AUTHOR" .PP -\fBAlex Tsariounov\fR <\&alext@novell\&.com\&> +\fBAlex Tsariounov\fR <\&tsariounov@gmail\&.com\&> .RS 4 Author. .RE diff --git a/doc/cset-set.html b/doc/cset-set.html index fbabb2d..e25ac98 100644 --- a/doc/cset-set.html +++ b/doc/cset-set.html @@ -3,7 +3,7 @@ - + cset-set(1) + - + +
+

SYNOPSIS

-
cset [--version | --help | --tohex] +
cset [--version | --help | --tohex]
 cset [help <command> | <command> --help]
-cset [cset options] <command> [command options] [args]
-
+cset [cset options] <command> [command options] [args] +
+
+

DESCRIPTION

@@ -438,7 +773,8 @@ the Linux kernel easier. The actual included command is called cset and it allows manipulation of cpusets on the system and provides higher level functions such as implementation and control of a basic cpu shielding setup.

-

Typical uses of cset include

+
+

Typical uses of cset include

Setting up and managing a simple shielded CPU environment @@ -492,6 +828,9 @@ Managing processes that run on various system cpusets
+
+
+

OPTIONS

The following generic option flags are available. Additional options @@ -545,6 +884,8 @@ documentation.

+
+

CSET COMMANDS

The cset commands are divided into groups, according to the primary @@ -599,6 +940,8 @@ summary of what a particular command does.

+
+

PERSISTENT CPUSETS

To create a persistent cpuset setup, i.e. one that survives a reboot, @@ -609,6 +952,8 @@ will need to alter the file to your specifications and copy it to be the file /etc/init.d/cset. See the comments in that file for more details.

+
+

FILES

If used, the init.d script /etc/init.d/cset starts and stops a @@ -628,14 +973,20 @@ mountpoint = <directory_name>

+
+

LICENSE

Cpuset is licensed under the GNU GPL V2 only.

+
+

COPYRIGHT

Copyright (c) 2008-2011 Novell Inc.

+
+

AUTHOR

Written by Alex Tsariounov <tsariounov@gmail.com>

@@ -643,6 +994,8 @@ mountpoint = <directory_name> GIT (stgit) v0.13 (see http://gna.org/projects/stgit and http://www.procode.org/stgit). Stacked GIT is under GPL V2 or later.

+ +

SEE ALSO

cset-set(1), cset-proc(1), cset-shield(1)

@@ -651,10 +1004,14 @@ http://www.procode.org/stgit). Stacked GIT is under GPL V2 or later.

taskset(1), chrt(1)

/usr/src/linux/Documentation/cpusets.txt

+ + +
diff --git a/doc/tutorial.html b/doc/tutorial.html index e5cf16d..230aded 100644 --- a/doc/tutorial.html +++ b/doc/tutorial.html @@ -3,7 +3,7 @@ - + Cpuset (cset) Tutorial