Bug#553413: proc(5): Add field numbers

2012-12-26 Thread Michael Kerrisk (man-pages)
tags 553413 fixed-upstream
thanks

I've now myself made all of these changes, at the same time as I made
some other changes in proc(5). I omitted this piece of the downstream
patch:

 @@ -1195,16 +1195,16 @@

  .in +4n
  .nf
 -cache  buffer size in KB
 -capacity   number of sectors
 -driver driver version
 -geometry   physical and logical geometry
 -identify   in hexadecimal
 -media  media type
 -model  manufacturer's model number
 -settings   drive settings
 -smart_thresholds   in hexadecimal
 -smart_values   in hexadecimal
 +(1)  cache  buffer size in KB
 +(2)  capacity   number of sectors
 +(3)  driver driver version
 +(4)  geometry   physical and logical geometry
 +(5)  identify   in hexadecimal
 +(6)  media  media type
 +(7)  model  manufacturer's model number
 +(8)  settings   drive settings
 +(9)  smart_thresholds   in hexadecimal
 +(10) smart_values   in hexadecimal
  .fi
  .in

That piece didn't make sense, since those items are files, not fields.

I also omitted the slabinfo piece, since really the place for those
details is in the slabinfo(5) page, which is itself seriously out of
date (see FIXMEs in the page source).

Cheers,

Michael


-- 
To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org
with a subject of unsubscribe. Trouble? Contact listmas...@lists.debian.org



Bug#553413: proc(5): Add field numbers

2012-12-15 Thread Michael Kerrisk (man-pages)
On Mon, Nov 19, 2012 at 9:57 PM, Simon Paillard spaill...@debian.org wrote:
 Control: tag -1 +upstream

 On Sat, Oct 31, 2009 at 03:02:25AM +0100, Samuel Thibault wrote:
 Package: manpages
 Version: 3.22-1
 Severity: minor
 Tags: patch

 To make it easier to use cut to select the desired fields, it is useful
 to have the field numbers in the documentation. The attached patch does
 this.

 Michael, this is a improvement that could be upstreamed, are you interested ?

I'd be interested but it doesn't apply cleanly to current usptream --
many hunks rejected. Could you or Samuel draft a version against
upstream?

hanks,

Michael


 --- proc.5.orig   2009-10-31 02:49:17.0 +0100
 +++ proc.52009-10-31 03:00:48.0 +0100
 @@ -607,64 +607,64 @@
  format specifiers, are:
  .RS
  .TP 12
 -\fIpid\fP %d
 +(1) \fIpid\fP %d
  The process ID.
  .TP
 -\fIcomm\fP %s
 +(2) \fIcomm\fP %s
  The filename of the executable, in parentheses.
  This is visible whether or not the executable is swapped out.
  .TP
 -\fIstate\fP %c
 +(3) \fIstate\fP %c
  One character from the string RSDZTW where R is running, S is
  sleeping in an interruptible wait, D is waiting in uninterruptible
  disk sleep, Z is zombie, T is traced or stopped (on a signal),
  and W is paging.
  .TP
 -\fIppid\fP %d
 +(4) \fIppid\fP %d
  The PID of the parent.
  .TP
 -\fIpgrp\fP %d
 +(5) \fIpgrp\fP %d
  The process group ID of the process.
  .TP
 -\fIsession\fP %d
 +(6) \fIsession\fP %d
  The session ID of the process.
  .TP
 -\fItty_nr\fP %d
 +(7) \fItty_nr\fP %d
  The controlling terminal of the process.
  (The minor device number is contained in the combination of bits
  31 to 20 and 7 to 0;
  the major device number is in bits 15 t0 8.)
  .TP
 -\fItpgid\fP %d
 +(8) \fItpgid\fP %d
  .\ This field and following, up to and including wchan added 0.99.1
  The ID of the foreground process group of the controlling
  terminal of the process.
  .TP
 -\fIflags\fP %u (%lu before Linux 2.6.22)
 +(9) \fIflags\fP %u (%lu before Linux 2.6.22)
  The kernel flags word of the process.
  For bit meanings,
  see the PF_* defines in
  .IR linux/sched.h .
  Details depend on the kernel version.
  .TP
 -\fIminflt\fP %lu
 +(10) \fIminflt\fP %lu
  The number of minor faults the process has made which have not
  required loading a memory page from disk.
  .TP
  .\ field 11
 -\fIcminflt\fP %lu
 +(11) \fIcminflt\fP %lu
  The number of minor faults that the process's
  waited-for children have made.
  .TP
 -\fImajflt\fP %lu
 +(12) \fImajflt\fP %lu
  The number of major faults the process has made which have
  required loading a memory page from disk.
  .TP
 -\fIcmajflt\fP %lu
 +(13) \fIcmajflt\fP %lu
  The number of major faults that the process's
  waited-for children have made.
  .TP
 -\fIutime\fP %lu
 +(14) \fIutime\fP %lu
  Amount of time that this process has been scheduled in user mode,
  measured in clock ticks (divide by
  .IR sysconf(_SC_CLK_TCK) .
 @@ -673,12 +673,12 @@
  so that applications that are not aware of the guest time field
  do not lose that time from their calculations.
  .TP
 -\fIstime\fP %lu
 +(15) \fIstime\fP %lu
  Amount of time that this process has been scheduled in kernel mode,
  measured in clock ticks (divide by
  .IR sysconf(_SC_CLK_TCK) .
  .TP
 -\fIcutime\fP %ld
 +(16) \fIcutime\fP %ld
  Amount of time that this process's
  waited-for children have been scheduled in user mode,
  measured in clock ticks (divide by
 @@ -688,13 +688,13 @@
  This includes guest time, \fIcguest_time\fP
  (time spent running a virtual CPU, see below).
  .TP
 -\fIcstime\fP %ld
 +(17) \fIcstime\fP %ld
  Amount of time that this process's
  waited-for children have been scheduled in kernel mode,
  measured in clock ticks (divide by
  .IR sysconf(_SC_CLK_TCK) .
  .TP
 -\fIpriority\fP %ld
 +(18) \fIpriority\fP %ld
  (Explanation for Linux 2.6)
  For processes running a real-time scheduling policy
  .RI ( policy
 @@ -715,7 +715,7 @@
  the scheduler weighting given to this process.
  .\ And back in kernel 1.2 days things were different again.
  .TP
 -\fInice\fP %ld
 +(19) \fInice\fP %ld
  The nice value (see
  .BR setpriority (2)),
  a value in the range 19 (low priority) to \-20 (high priority).
 @@ -730,81 +730,81 @@
  .\ \fItimeout\fP %u
  .\ The time in jiffies of the process's next timeout.
  .\ timeout was removed sometime around 2.1/2.2
 -\fInum_threads\fP %ld
 +(20) \fInum_threads\fP %ld
  Number of threads in this process (since Linux 2.6).
  Before kernel 2.6, this field was hard coded to 0 as a placeholder
  for an earlier removed field.
  .TP
  .\ field 21
 -\fIitrealvalue\fP %ld
 +(21) \fIitrealvalue\fP %ld
  The time in jiffies before the next
  .B SIGALRM
  is sent to the process due to an interval timer.
  Since kernel 2.6.17, this field is no longer maintained,
  and is hard coded as 0.
  .TP
 -\fIstarttime\fP %llu (was %lu before Linux 2.6)
 +(22) \fIstarttime\fP %llu (was %lu before Linux 2.6)
  The time in jiffies the process started after 

Bug#553413: proc(5): Add field numbers

2012-11-19 Thread Simon Paillard
Control: tag -1 +upstream

On Sat, Oct 31, 2009 at 03:02:25AM +0100, Samuel Thibault wrote:
 Package: manpages
 Version: 3.22-1
 Severity: minor
 Tags: patch
 
 To make it easier to use cut to select the desired fields, it is useful
 to have the field numbers in the documentation. The attached patch does
 this.

Michael, this is a improvement that could be upstreamed, are you interested ?

 --- proc.5.orig   2009-10-31 02:49:17.0 +0100
 +++ proc.52009-10-31 03:00:48.0 +0100
 @@ -607,64 +607,64 @@
  format specifiers, are:
  .RS
  .TP 12
 -\fIpid\fP %d
 +(1) \fIpid\fP %d
  The process ID.
  .TP
 -\fIcomm\fP %s
 +(2) \fIcomm\fP %s
  The filename of the executable, in parentheses.
  This is visible whether or not the executable is swapped out.
  .TP
 -\fIstate\fP %c
 +(3) \fIstate\fP %c
  One character from the string RSDZTW where R is running, S is
  sleeping in an interruptible wait, D is waiting in uninterruptible
  disk sleep, Z is zombie, T is traced or stopped (on a signal),
  and W is paging.
  .TP
 -\fIppid\fP %d
 +(4) \fIppid\fP %d
  The PID of the parent.
  .TP
 -\fIpgrp\fP %d
 +(5) \fIpgrp\fP %d
  The process group ID of the process.
  .TP
 -\fIsession\fP %d
 +(6) \fIsession\fP %d
  The session ID of the process.
  .TP
 -\fItty_nr\fP %d
 +(7) \fItty_nr\fP %d
  The controlling terminal of the process.
  (The minor device number is contained in the combination of bits
  31 to 20 and 7 to 0;
  the major device number is in bits 15 t0 8.)
  .TP
 -\fItpgid\fP %d
 +(8) \fItpgid\fP %d
  .\ This field and following, up to and including wchan added 0.99.1
  The ID of the foreground process group of the controlling
  terminal of the process.
  .TP
 -\fIflags\fP %u (%lu before Linux 2.6.22)
 +(9) \fIflags\fP %u (%lu before Linux 2.6.22)
  The kernel flags word of the process.
  For bit meanings,
  see the PF_* defines in
  .IR linux/sched.h .
  Details depend on the kernel version.
  .TP
 -\fIminflt\fP %lu
 +(10) \fIminflt\fP %lu
  The number of minor faults the process has made which have not
  required loading a memory page from disk.
  .TP
  .\ field 11
 -\fIcminflt\fP %lu
 +(11) \fIcminflt\fP %lu
  The number of minor faults that the process's
  waited-for children have made.
  .TP
 -\fImajflt\fP %lu
 +(12) \fImajflt\fP %lu
  The number of major faults the process has made which have
  required loading a memory page from disk.
  .TP
 -\fIcmajflt\fP %lu
 +(13) \fIcmajflt\fP %lu
  The number of major faults that the process's
  waited-for children have made.
  .TP
 -\fIutime\fP %lu
 +(14) \fIutime\fP %lu
  Amount of time that this process has been scheduled in user mode,
  measured in clock ticks (divide by
  .IR sysconf(_SC_CLK_TCK) .
 @@ -673,12 +673,12 @@
  so that applications that are not aware of the guest time field
  do not lose that time from their calculations.
  .TP
 -\fIstime\fP %lu
 +(15) \fIstime\fP %lu
  Amount of time that this process has been scheduled in kernel mode,
  measured in clock ticks (divide by
  .IR sysconf(_SC_CLK_TCK) .
  .TP
 -\fIcutime\fP %ld
 +(16) \fIcutime\fP %ld
  Amount of time that this process's
  waited-for children have been scheduled in user mode,
  measured in clock ticks (divide by
 @@ -688,13 +688,13 @@
  This includes guest time, \fIcguest_time\fP
  (time spent running a virtual CPU, see below).
  .TP
 -\fIcstime\fP %ld
 +(17) \fIcstime\fP %ld
  Amount of time that this process's
  waited-for children have been scheduled in kernel mode,
  measured in clock ticks (divide by
  .IR sysconf(_SC_CLK_TCK) .
  .TP
 -\fIpriority\fP %ld
 +(18) \fIpriority\fP %ld
  (Explanation for Linux 2.6)
  For processes running a real-time scheduling policy
  .RI ( policy
 @@ -715,7 +715,7 @@
  the scheduler weighting given to this process.
  .\ And back in kernel 1.2 days things were different again.
  .TP
 -\fInice\fP %ld
 +(19) \fInice\fP %ld
  The nice value (see
  .BR setpriority (2)),
  a value in the range 19 (low priority) to \-20 (high priority).
 @@ -730,81 +730,81 @@
  .\ \fItimeout\fP %u
  .\ The time in jiffies of the process's next timeout.
  .\ timeout was removed sometime around 2.1/2.2
 -\fInum_threads\fP %ld
 +(20) \fInum_threads\fP %ld
  Number of threads in this process (since Linux 2.6).
  Before kernel 2.6, this field was hard coded to 0 as a placeholder
  for an earlier removed field.
  .TP
  .\ field 21
 -\fIitrealvalue\fP %ld
 +(21) \fIitrealvalue\fP %ld
  The time in jiffies before the next
  .B SIGALRM
  is sent to the process due to an interval timer.
  Since kernel 2.6.17, this field is no longer maintained,
  and is hard coded as 0.
  .TP
 -\fIstarttime\fP %llu (was %lu before Linux 2.6)
 +(22) \fIstarttime\fP %llu (was %lu before Linux 2.6)
  The time in jiffies the process started after system boot.
  .TP
 -\fIvsize\fP %lu
 +(23) \fIvsize\fP %lu
  Virtual memory size in bytes.
  .TP
 -\fIrss\fP %ld
 +(24) \fIrss\fP %ld
  Resident Set Size: number of pages the process has in real memory.
  This is just the pages which
  count 

Bug#553413: proc(5): Add field numbers

2009-10-30 Thread Samuel Thibault
Package: manpages
Version: 3.22-1
Severity: minor
Tags: patch

Hello,

To make it easier to use cut to select the desired fields, it is useful
to have the field numbers in the documentation. The attached patch does
this.

Samuel

-- System Information:
Debian Release: squeeze/sid
  APT prefers testing
  APT policy: (990, 'testing'), (500, 'unstable'), (500, 'stable'), (1, 
'experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 2.6.31 (SMP w/2 CPU cores)
Locale: LANG=fr_FR.UTF-8, LC_CTYPE=fr_FR.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/bash

manpages depends on no packages.

manpages recommends no packages.

Versions of packages manpages suggests:
ii  konqueror [man-browser]   4:4.3.1-1  KDE 4's advanced file manager, web
ii  man-db [man-browser]  2.5.6-3on-line manual pager

-- no debconf information
--- proc.5.orig 2009-10-31 02:49:17.0 +0100
+++ proc.5  2009-10-31 03:00:48.0 +0100
@@ -607,64 +607,64 @@
 format specifiers, are:
 .RS
 .TP 12
-\fIpid\fP %d
+(1) \fIpid\fP %d
 The process ID.
 .TP
-\fIcomm\fP %s
+(2) \fIcomm\fP %s
 The filename of the executable, in parentheses.
 This is visible whether or not the executable is swapped out.
 .TP
-\fIstate\fP %c
+(3) \fIstate\fP %c
 One character from the string RSDZTW where R is running, S is
 sleeping in an interruptible wait, D is waiting in uninterruptible
 disk sleep, Z is zombie, T is traced or stopped (on a signal),
 and W is paging.
 .TP
-\fIppid\fP %d
+(4) \fIppid\fP %d
 The PID of the parent.
 .TP
-\fIpgrp\fP %d
+(5) \fIpgrp\fP %d
 The process group ID of the process.
 .TP
-\fIsession\fP %d
+(6) \fIsession\fP %d
 The session ID of the process.
 .TP
-\fItty_nr\fP %d
+(7) \fItty_nr\fP %d
 The controlling terminal of the process.
 (The minor device number is contained in the combination of bits
 31 to 20 and 7 to 0;
 the major device number is in bits 15 t0 8.)
 .TP
-\fItpgid\fP %d
+(8) \fItpgid\fP %d
 .\ This field and following, up to and including wchan added 0.99.1
 The ID of the foreground process group of the controlling
 terminal of the process.
 .TP
-\fIflags\fP %u (%lu before Linux 2.6.22)
+(9) \fIflags\fP %u (%lu before Linux 2.6.22)
 The kernel flags word of the process.
 For bit meanings,
 see the PF_* defines in
 .IR linux/sched.h .
 Details depend on the kernel version.
 .TP
-\fIminflt\fP %lu
+(10) \fIminflt\fP %lu
 The number of minor faults the process has made which have not
 required loading a memory page from disk.
 .TP
 .\ field 11
-\fIcminflt\fP %lu
+(11) \fIcminflt\fP %lu
 The number of minor faults that the process's
 waited-for children have made.
 .TP
-\fImajflt\fP %lu
+(12) \fImajflt\fP %lu
 The number of major faults the process has made which have
 required loading a memory page from disk.
 .TP
-\fIcmajflt\fP %lu
+(13) \fIcmajflt\fP %lu
 The number of major faults that the process's
 waited-for children have made.
 .TP
-\fIutime\fP %lu
+(14) \fIutime\fP %lu
 Amount of time that this process has been scheduled in user mode,
 measured in clock ticks (divide by
 .IR sysconf(_SC_CLK_TCK) .
@@ -673,12 +673,12 @@
 so that applications that are not aware of the guest time field
 do not lose that time from their calculations.
 .TP
-\fIstime\fP %lu
+(15) \fIstime\fP %lu
 Amount of time that this process has been scheduled in kernel mode,
 measured in clock ticks (divide by
 .IR sysconf(_SC_CLK_TCK) .
 .TP
-\fIcutime\fP %ld
+(16) \fIcutime\fP %ld
 Amount of time that this process's
 waited-for children have been scheduled in user mode,
 measured in clock ticks (divide by
@@ -688,13 +688,13 @@
 This includes guest time, \fIcguest_time\fP
 (time spent running a virtual CPU, see below).
 .TP
-\fIcstime\fP %ld
+(17) \fIcstime\fP %ld
 Amount of time that this process's
 waited-for children have been scheduled in kernel mode,
 measured in clock ticks (divide by
 .IR sysconf(_SC_CLK_TCK) .
 .TP
-\fIpriority\fP %ld
+(18) \fIpriority\fP %ld
 (Explanation for Linux 2.6)
 For processes running a real-time scheduling policy
 .RI ( policy
@@ -715,7 +715,7 @@
 the scheduler weighting given to this process.
 .\ And back in kernel 1.2 days things were different again.
 .TP
-\fInice\fP %ld
+(19) \fInice\fP %ld
 The nice value (see
 .BR setpriority (2)),
 a value in the range 19 (low priority) to \-20 (high priority).
@@ -730,81 +730,81 @@
 .\ \fItimeout\fP %u
 .\ The time in jiffies of the process's next timeout.
 .\ timeout was removed sometime around 2.1/2.2
-\fInum_threads\fP %ld
+(20) \fInum_threads\fP %ld
 Number of threads in this process (since Linux 2.6).
 Before kernel 2.6, this field was hard coded to 0 as a placeholder
 for an earlier removed field.
 .TP
 .\ field 21
-\fIitrealvalue\fP %ld
+(21) \fIitrealvalue\fP %ld
 The time in jiffies before the next
 .B SIGALRM
 is sent to the process due to an interval timer.
 Since kernel 2.6.17, this field is no longer maintained,
 and is hard coded as 0.
 .TP
-\fIstarttime\fP %llu (was %lu before Linux 2.6)
+(22) \fIstarttime\fP %llu (was %lu before