Changeset View
Standalone View
lib/libsys/jail.2
| Show All 17 Lines | |||||
| .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||||
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
| .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
| .\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
| .\" | .\" | ||||
| .Dd September 9, 2025 | .Dd September 15, 2025 | ||||
| .Dt JAIL 2 | .Dt JAIL 2 | ||||
| .Os | .Os | ||||
| .Sh NAME | .Sh NAME | ||||
| .Nm jail , | .Nm jail , | ||||
| .Nm jail_get , | .Nm jail_get , | ||||
| .Nm jail_set , | .Nm jail_set , | ||||
| .Nm jail_remove , | .Nm jail_remove , | ||||
| .Nm jail_attach , | .Nm jail_attach , | ||||
| ▲ Show 20 Lines • Show All 515 Lines • ▼ Show 20 Lines | |||||
| .Fn jail , | .Fn jail , | ||||
| .Fn jail_set , | .Fn jail_set , | ||||
| .Fn jail_attach , | .Fn jail_attach , | ||||
| and | and | ||||
| .Fn jail_attach_jd | .Fn jail_attach_jd | ||||
| call | call | ||||
| .Xr chroot 2 | .Xr chroot 2 | ||||
| internally, so they can fail for all the same reasons. | internally, so they can fail for all the same reasons. | ||||
| In particular, they return the | |||||
ziaee: I don't understand, shouldn't this be in its own entry? | |||||
Done Inline ActionsThe current manual page structure is that, in the ERRORS sections, there are multiple "sub-sections" that are exclusive (most concern one function, one concerns both jail_attach() and jail_remove()) except for the last paragraph, which explicitly is an addition concerning three functions that refers the reader to another manual page (chroot(2)). A priori, I don't want to inline the errors from chroot(2) here, as the list is relatively long, and anyway is common to three of the described functions (repeating it for each one would be very verbose), and because that would open the risk of the lists here and there becoming inconsistent. My goal, however, is to save readers from having to open chroot(2) for the in-diff-added particular reason of returning EPERM, as this one is very much unintuitive and as such deserves to be mentioned inline. Are you saying you'd like the added mention be structured like the other "sub-sections", i.e., with .Bl? Or do you want a more profound reorganization? olce: The current manual page structure is that, in the `ERRORS` sections, there are multiple "sub… | |||||
| .Bq Er EPERM | |||||
| error when the process to join a jail has open directories. | |||||
| Please consult the | Please consult the | ||||
| .Xr chroot 2 | .Xr chroot 2 | ||||
| manual page for details. | manual page for details. | ||||
| .Sh SEE ALSO | .Sh SEE ALSO | ||||
| .Xr chdir 2 , | .Xr chdir 2 , | ||||
| .Xr chroot 2 , | .Xr chroot 2 , | ||||
| .Xr jail 8 | .Xr jail 8 | ||||
| .Sh HISTORY | .Sh HISTORY | ||||
| Show All 23 Lines | |||||
I don't understand, shouldn't this be in its own entry?