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.000000000 +0100
> +++ proc.5    2009-10-31 03:00:48.000000000 +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 towards text, data, or stack space.
>  This does not include pages
>  which have not been demand-loaded in, or which are swapped out.
>  .TP
> -\fIrsslim\fP %lu
> +(25) \fIrsslim\fP %lu
>  Current soft limit in bytes on the rss of the process;
>  see the description of
>  .B RLIMIT_RSS
>  in
>  .BR getpriority (2).
>  .TP
> -\fIstartcode\fP %lu
> +(26) \fIstartcode\fP %lu
>  The address above which program text can run.
>  .TP
> -\fIendcode\fP %lu
> +(27) \fIendcode\fP %lu
>  The address below which program text can run.
>  .TP
> -\fIstartstack\fP %lu
> +(28) \fIstartstack\fP %lu
>  The address of the start (i.e., bottom) of the stack.
>  .TP
> -\fIkstkesp\fP %lu
> +(29) \fIkstkesp\fP %lu
>  The current value of ESP (stack pointer), as found in the
>  kernel stack page for the process.
>  .TP
> -\fIkstkeip\fP %lu
> +(30) \fIkstkeip\fP %lu
>  The current EIP (instruction pointer).
>  .TP
>  .\" field 31
> -\fIsignal\fP %lu
> +(31) \fIsignal\fP %lu
>  The bitmap of pending signals, displayed as a decimal number.
>  Obsolete, because it does not provide information on real-time signals; use
>  .I /proc/[pid]/status
>  instead.
>  .TP
> -\fIblocked\fP %lu
> +(32) \fIblocked\fP %lu
>  The bitmap of blocked signals, displayed as a decimal number.
>  Obsolete, because it does not provide information on real-time signals; use
>  .I /proc/[pid]/status
>  instead.
>  .TP
> -\fIsigignore\fP %lu
> +(33) \fIsigignore\fP %lu
>  The bitmap of ignored signals, displayed as a decimal number.
>  Obsolete, because it does not provide information on real-time signals; use
>  .I /proc/[pid]/status
>  instead.
>  .TP
> -\fIsigcatch\fP %lu
> +(34) \fIsigcatch\fP %lu
>  The bitmap of caught signals, displayed as a decimal number.
>  Obsolete, because it does not provide information on real-time signals; use
>  .I /proc/[pid]/status
>  instead.
>  .TP
> -\fIwchan\fP %lu
> +(35) \fIwchan\fP %lu
>  This is the "channel" in which the process is waiting.
>  It is the
>  address of a system call, and can be looked up in a namelist if you
> @@ -814,42 +814,42 @@
>  then
>  try \fIps \-l\fP to see the WCHAN field in action.)
>  .TP
> -\fInswap\fP %lu
> +(36) \fInswap\fP %lu
>  .\" nswap was added in 2.0
>  Number of pages swapped (not maintained).
>  .TP
> -\fIcnswap\fP %lu
> +(37) \fIcnswap\fP %lu
>  .\" cnswap was added in 2.0
>  Cumulative \fInswap\fP for child processes (not maintained).
>  .TP
> -\fIexit_signal\fP %d (since Linux 2.1.22)
> +(38) \fIexit_signal\fP %d (since Linux 2.1.22)
>  Signal to be sent to parent when we die.
>  .TP
> -\fIprocessor\fP %d (since Linux 2.2.8)
> +(39) \fIprocessor\fP %d (since Linux 2.2.8)
>  CPU number last executed on.
>  .TP
> -\fIrt_priority\fP %u (since Linux 2.5.19; was %lu before Linux 2.6.22)
> +(40) \fIrt_priority\fP %u (since Linux 2.5.19; was %lu before Linux 2.6.22)
>  Real-time scheduling priority, a number in the range 1 to 99 for
>  processes scheduled under a real-time policy,
>  or 0, for non-real-time processes (see
>  .BR sched_setscheduler (2)).
>  .TP
>  .\" field 41
> -\fIpolicy\fP %u (since Linux 2.5.19; was %lu before Linux 2.6.22)
> +(41) \fIpolicy\fP %u (since Linux 2.5.19; was %lu before Linux 2.6.22)
>  Scheduling policy (see
>  .BR sched_setscheduler (2)).
>  Decode using the SCHED_* constants in
>  .IR linux/sched.h .
>  .TP
> -\fIdelayacct_blkio_ticks\fP %llu (since Linux 2.6.18)
> +(42) \fIdelayacct_blkio_ticks\fP %llu (since Linux 2.6.18)
>  Aggregated block I/O delays, measured in clock ticks (centiseconds).
>  .TP
> -\fIguest_time\fP %lu (since Linux 2.6.24)
> +(43) \fIguest_time\fP %lu (since Linux 2.6.24)
>  Guest time of the process (time spent running a virtual CPU
>  for a guest operating system), measured in clock ticks (divide by
>  .IR sysconf(_SC_CLK_TCK) .
>  .TP
> -\fIcguest_time\fP %ld (since Linux 2.6.24)
> +(44) \fIcguest_time\fP %ld (since Linux 2.6.24)
>  Guest time of the process's children, measured in clock ticks (divide by
>  .IR sysconf(_SC_CLK_TCK) .
>  .RE
> @@ -860,17 +860,17 @@
>  .in +4n
>  .nf
>  
> -size       total program size
> -           (same as VmSize in \fI/proc/[pid]/status\fP)
> -resident   resident set size
> -           (same as VmRSS in \fI/proc/[pid]/status\fP)
> -share      shared pages (from shared mappings)
> -text       text (code)
> +(1) size       total program size
> +               (same as VmSize in \fI/proc/[pid]/status\fP)
> +(2) resident   resident set size
> +               (same as VmRSS in \fI/proc/[pid]/status\fP)
> +(3) share      shared pages (from shared mappings)
> +(4) text       text (code)
>  .\" (not including libs; broken, includes data segment)
> -lib        library (unused in Linux 2.6)
> -data       data + stack
> +(5) lib        library (unused in Linux 2.6)
> +(6) data       data + stack
>  .\" (including libs; broken, includes library text)
> -dt         dirty pages (unused in Linux 2.6)
> +(7) dt         dirty pages (unused in Linux 2.6)
>  .fi
>  .in
>  .TP
> @@ -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
>  
> @@ -1606,13 +1606,13 @@
>  .in +4n
>  .nf
>  
> -cache-name
> -num-active-objs
> -total-objs
> -object-size
> -num-active-slabs
> -total-slabs
> -num-pages-per-slab
> +(1) cache-name
> +(2) num-active-objs
> +(3) total-objs
> +(4) object-size
> +(5) num-active-slabs
> +(6) total-slabs
> +(7) num-pages-per-slab
>  .fi
>  .in
>  
> @@ -1633,8 +1633,8 @@
>  .IR sysconf(_SC_CLK_TCK)
>  to obtain the right value),
>  .\" 1024 on Alpha and ia64
> -that the system spent in user mode,
> -user mode with low priority (nice), system mode, and the
> +that the system spent in (1) user mode,
> +(2) user mode with low priority (nice), (3) system mode, and (4) the
>  idle task, respectively.
>  .\" FIXME Actually, the following info about the /proc/stat 'cpu' field
>  .\"       does not seem to be quite right (at least in 2.6.12)
> @@ -1642,19 +1642,24 @@
>  second entry in the uptime pseudo-file.
>  
>  In Linux 2.6 this line includes three additional columns:
> +(5)
>  .I iowait
>  \- time waiting for I/O to complete (since 2.5.41);
> +(6)
>  .I irq
>  \- time servicing interrupts (since 2.6.0-test4);
> +(7)
>  .I softirq
>  \- time servicing softirqs (since 2.6.0-test4).
>  
>  Since Linux 2.6.11, there is an eighth column,
> +(8)
>  .I steal
>  \- stolen time, which is the time spent in other operating systems when
>  running in a virtualized environment
>  
>  Since Linux 2.6.24, there is a ninth column,
> +(9)
>  .IR guest ,
>  which is the time spent running a virtual CPU for guest
>  operating systems under the control of the Linux kernel.
> @@ -1756,18 +1761,22 @@
>  (pages requested by system) and two dummy values.
>  .RS
>  .IP * 2
> +(1)
>  .I nr_dentry
>  is the number of allocated dentries (dcache entries).
>  This field is unused in Linux 2.2.
>  .IP *
> +(2)
>  .I nr_unused
>  is the number of unused dentries.
>  .IP *
> +(3)
>  .I age_limit
>  .\" looks like this is unused in kernels 2.2 to 2.6
>  is the age in seconds after which dcache entries
>  can be reclaimed when memory is short.
>  .IP *
> +(4)
>  .I want_pages
>  .\" looks like this is unused in kernels 2.2 to 2.6
>  is non-zero when the kernel has called shrink_dcache_pages() and the


-- 
Simon Paillard


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

Reply via email to