resource: Update struct rusage comments [BZ #23689]

Message ID 87efcngzg1.fsf@oldenburg.str.redhat.com
State Committed
Headers

Commit Message

Florian Weimer Oct. 18, 2018, 1:24 p.m. UTC
  2018-10-18  Florian Weimer  <fweimer@redhat.com>

	[BZ #23689]
	* resource/bits/types/struct_rusage.h (struct rusage): Update
	comment on struct.  Remove extraneous field comment.
  

Comments

Adhemerval Zanella Oct. 18, 2018, 6:22 p.m. UTC | #1
On 18/10/2018 10:24, Florian Weimer wrote:
> 2018-10-18  Florian Weimer  <fweimer@redhat.com>
> 
> 	[BZ #23689]
> 	* resource/bits/types/struct_rusage.h (struct rusage): Update
> 	comment on struct.  Remove extraneous field comment.

LGTM.

> 
> diff --git a/resource/bits/types/struct_rusage.h b/resource/bits/types/struct_rusage.h
> index 5dc0916aa7..5ff94296ad 100644
> --- a/resource/bits/types/struct_rusage.h
> +++ b/resource/bits/types/struct_rusage.h
> @@ -22,7 +22,9 @@
>  #include <bits/types.h>
>  #include <bits/types/struct_timeval.h>
>  
> -/* Structure which says how much of each resource has been used.  */
> +/* Structure which says how much of each resource has been used.  If
> +   the system does not keep track of a particular value, the struct
> +   field is always zero.  */
>  
>  /* The purpose of all the unions is to have the kernel-compatible layout
>     while keeping the API type as 'long int', and among machines where
> @@ -42,7 +44,6 @@ struct rusage
>        };
>      /* Amount of sharing of text segment memory
>         with other processes (kilobyte-seconds).  */
> -    /* Maximum resident set size (in kilobytes).  */
>      __extension__ union
>        {
>  	long int ru_ixrss;
>
  

Patch

diff --git a/resource/bits/types/struct_rusage.h b/resource/bits/types/struct_rusage.h
index 5dc0916aa7..5ff94296ad 100644
--- a/resource/bits/types/struct_rusage.h
+++ b/resource/bits/types/struct_rusage.h
@@ -22,7 +22,9 @@ 
 #include <bits/types.h>
 #include <bits/types/struct_timeval.h>
 
-/* Structure which says how much of each resource has been used.  */
+/* Structure which says how much of each resource has been used.  If
+   the system does not keep track of a particular value, the struct
+   field is always zero.  */
 
 /* The purpose of all the unions is to have the kernel-compatible layout
    while keeping the API type as 'long int', and among machines where
@@ -42,7 +44,6 @@  struct rusage
       };
     /* Amount of sharing of text segment memory
        with other processes (kilobyte-seconds).  */
-    /* Maximum resident set size (in kilobytes).  */
     __extension__ union
       {
 	long int ru_ixrss;