Commit 207a7ba8dc000e1b13acac97f3736810dd86e8e2

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent c293621bbf

[PATCH] kernel/capability.c: add kerneldoc

Add kerneldoc to kernel/capability.c

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

Showing 1 changed file with 17 additions and 3 deletions Side-by-side Diff

... ... @@ -31,8 +31,14 @@
31 31 * uninteresting and/or not to be changed.
32 32 */
33 33  
34   -/*
  34 +/**
35 35 * sys_capget - get the capabilities of a given process.
  36 + * @header: pointer to struct that contains capability version and
  37 + * target pid data
  38 + * @dataptr: pointer to struct that contains the effective, permitted,
  39 + * and inheritable capabilities that are returned
  40 + *
  41 + * Returns 0 on success and < 0 on error.
36 42 */
37 43 asmlinkage long sys_capget(cap_user_header_t header, cap_user_data_t dataptr)
38 44 {
... ... @@ -141,8 +147,14 @@
141 147 return ret;
142 148 }
143 149  
144   -/*
145   - * sys_capset - set capabilities for a given process, all processes, or all
  150 +/**
  151 + * sys_capset - set capabilities for a process or a group of processes
  152 + * @header: pointer to struct that contains capability version and
  153 + * target pid data
  154 + * @data: pointer to struct that contains the effective, permitted,
  155 + * and inheritable capabilities
  156 + *
  157 + * Set capabilities for a given process, all processes, or all
146 158 * processes in a given process group.
147 159 *
148 160 * The restrictions on setting capabilities are specified as:
... ... @@ -152,6 +164,8 @@
152 164 * I: any raised capabilities must be a subset of the (old current) permitted
153 165 * P: any raised capabilities must be a subset of the (old current) permitted
154 166 * E: must be set to a subset of (new target) permitted
  167 + *
  168 + * Returns 0 on success and < 0 on error.
155 169 */
156 170 asmlinkage long sys_capset(cap_user_header_t header, const cap_user_data_t data)
157 171 {