From 409d1bf7d6deef77ccf685e1624589997247a267 Mon Sep 17 00:00:00 2001 From: "George V. Neville-Neil" Date: Wed, 10 Nov 2021 08:18:32 -0500 Subject: [PATCH] Address review comments from 0mp, debdrup and oshogbo --- lib/libcasper/libcasper/libcasper.3 | 19 ++++++++++--------- lib/libcasper/libcasper/libcasper_service.3 | 14 +++++++------- lib/libcasper/services/cap_net/cap_net.3 | 2 +- 3 files changed, 18 insertions(+), 17 deletions(-) diff --git a/lib/libcasper/libcasper/libcasper.3 b/lib/libcasper/libcasper/libcasper.3 index c08ea0f21f8b..02c08270dcf2 100644 --- a/lib/libcasper/libcasper/libcasper.3 +++ b/lib/libcasper/libcasper/libcasper.3 @@ -28,7 +28,7 @@ .\" .\" $FreeBSD$ .\" -.Dd January 3, 2021 +.Dd November 15, 2021 .Dt LIBCASPER 3 .Os .Sh NAME @@ -78,7 +78,8 @@ .Sh DESCRIPTION The .Nm libcasper -library provides for the control of application capabilities through the casper process. +library provides for the control of application capabilities through +the casper process. .Pp An application capability, represented by the .Vt cap_channel_t @@ -86,7 +87,7 @@ type, is a communication channel between the caller and the casper daemon or an instance of one of the daemon's services. A capability to the casper process, obtained with the .Fn cap_init -function, allows a program to create capabilities to acacce +function, allows a program to create capabilities to access the casper daemon's services via the .Fn cap_service_open function. @@ -107,7 +108,7 @@ system call, or sent over a .Xr unix 4 domain socket as a file descriptor, -nd has to be converted into a +and has to be converted into a .Vt cap_channel_t . The .Fa flags @@ -115,16 +116,15 @@ argument defines the channel behavior. The supported flags are: .Bl -ohang -offset indent .It CASPER_NO_UNIQ -The communication between the process and the casper daemon no unique version of nvlist. +The communication between the process and the casper daemon no +unique version of nvlist. .El .Pp The .Fn cap_unwrap function returns the .Xr unix 4 -domain socket that was provided to the -.Fn cap_wrap -function, +domain socket used by the daemon service, and frees the .Vt cap_channel_t structure. @@ -191,7 +191,8 @@ The .Fn cap_xfer_nvlist function sends the given .Xr nvlist 9 , -destroys it, and receives a new +destroys it, +and receives a new .Xr nvlist 9 in response over the given capability. It does not matter if the function succeeds or fails, the diff --git a/lib/libcasper/libcasper/libcasper_service.3 b/lib/libcasper/libcasper/libcasper_service.3 index c210cdde182a..9e0f76cf98d0 100644 --- a/lib/libcasper/libcasper/libcasper_service.3 +++ b/lib/libcasper/libcasper/libcasper_service.3 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 5, 2020 +.Dd November 15, 2021 .Dt LIBCASPER 3 .Os .Sh NAME @@ -47,7 +47,7 @@ typedef int service_command_func_t(const char *, const nvlist_t *, nvlist_t *, .Sh DESCRIPTION The .Nm CREATE_SERVICE -macro is used to create a new Casper service. +macro is used to create a new casper service. The .Fa name is a string containing the service name, which will be used in the @@ -61,7 +61,7 @@ is a function of type where the first argument of the function contains an containing .Xr nvlist 9 , old service limits and the second argument contains the new limits. -If the service wasn't limited then the old limits will be set to +If the service was not limited then the old limits will be set to .Dv NULL . This function must not allow the extension of service limits. The @@ -76,7 +76,7 @@ contains the current limits and the second contains an with the current request. The last argument contains a return value .Xr nvlist 9 -which contains the response from Casper. +which contains the response from casper. .Pp The .Fa flags @@ -84,14 +84,14 @@ argument defines the limits of the service. The supported flags are: .Bl -ohang -offset indent .It CASPER_SERVICE_STDIO -The Casper service has access to the stdio descriptors from the process it was +The casper service has access to the stdio descriptors from the process it was spawned from. .It CASPER_SERVICE_FD -The Casper service has access to all of the descriptors, +The casper service has access to all of the descriptors, besides the stdio descriptors, from the process it was spawned from. .It CASPER_SERVICE_NO_UNIQ_LIMITS -The whole Casper communication is using an +The whole casper communication is using an .Xr nvlist 9 with the .Xr NVLIST_NO_UNIQ 9 diff --git a/lib/libcasper/services/cap_net/cap_net.3 b/lib/libcasper/services/cap_net/cap_net.3 index 765abbdf41aa..e64038a48330 100644 --- a/lib/libcasper/services/cap_net/cap_net.3 +++ b/lib/libcasper/services/cap_net/cap_net.3 @@ -23,7 +23,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 15, 2020 +.Dd November 15, 2021 .Dt CAP_NET 3 .Os .Sh NAME